sirius::wf::spin_range Class Reference

Describe a range of spins. More...

#include <wave_functions.hpp>

Public Member Functions
	spin_range (int begin__, int end__)
	spin_range (int ispn__)
auto	begin () const
auto	end () const
int	size () const
int	spinor_index () const

Private Attributes
int	begin_
int	end_
int	spinor_index_

Detailed Description

Describe a range of spins.

Only 3 combinations of spin range are allowed:

• [0, 1)
• [1, 2)
• [0, 2)

Definition at line 169 of file wave_functions.hpp.

Constructor & Destructor Documentation

spin_range() [1/2]

sirius::wf::spin_range::spin_range ( int  begin__, int  end__  )

inline

Definition at line 176 of file wave_functions.hpp.

spin_range() [2/2]

sirius::wf::spin_range::spin_range ( int  ispn__ )

inline

Definition at line 191 of file wave_functions.hpp.

Member Function Documentation

begin()

auto sirius::wf::spin_range::begin ( ) const

inline

Definition at line 201 of file wave_functions.hpp.

end()

auto sirius::wf::spin_range::end ( ) const

inline

Definition at line 205 of file wave_functions.hpp.

size()

int sirius::wf::spin_range::size ( ) const

inline

Definition at line 209 of file wave_functions.hpp.

spinor_index()

int sirius::wf::spin_range::spinor_index ( ) const

inline

Definition at line 213 of file wave_functions.hpp.

Member Data Documentation

begin_

int sirius::wf::spin_range::begin_

private

Definition at line 172 of file wave_functions.hpp.

end_

int sirius::wf::spin_range::end_

private

Definition at line 173 of file wave_functions.hpp.

spinor_index_

int sirius::wf::spin_range::spinor_index_

private

Definition at line 174 of file wave_functions.hpp.

---

The documentation for this class was generated from the following file:

• wave_functions.hpp