GQCP::SpinResolved< _Of > Class Template Reference

#include <SpinResolved.hpp>

Inheritance diagram for GQCP::SpinResolved< _Of >:

Collaboration diagram for GQCP::SpinResolved< _Of >:

Public Types
using	Of = _Of
using	ComponentType = Of
Public Types inherited from GQCP::SpinResolvedBase< _Of, SpinResolved< _Of > >
using	Of = _Of
using	Derived = SpinResolved< _Of >
using	Self = SpinResolvedBase< Of, Derived >

Public Member Functions
bool	operator== (const SpinResolved< Of > &other)
bool	operator!= (const SpinResolved< Of > &other)
Public Member Functions inherited from GQCP::SpinResolvedBase< _Of, SpinResolved< _Of > >
	SpinResolvedBase (const Of &alpha, const Of &beta)
	SpinResolvedBase (const std::vector< Of > &both)
	SpinResolvedBase (const std::array< Of, 2 > &both)
	SpinResolvedBase (const std::initializer_list< Of > &both)
const Of &	alpha () const
Of &	alpha ()
const Of &	beta () const
Of &	beta ()
const Of &	component (const Spin sigma) const
Of &	component (const Spin sigma)

Additional Inherited Members
Static Public Member Functions inherited from GQCP::SpinResolvedBase< _Of, SpinResolved< _Of > >
static Derived	FromEqual (const Of &equal)

Detailed Description

template<typename _Of>
class GQCP::SpinResolved< _Of >

A utility type encapsulating an alpha- and beta-type. In contrast to SpinResolvedBase, this class is used as an instantiatable type, much like you would use a std::vector<_Of>.

Parameters

_Of	The type of the alpha- and beta-objects. The name 'Of' is chosen for a natural reading SpinResolved<_Of>.

Member Typedef Documentation

ComponentType

template<typename _Of >

using GQCP::SpinResolved< _Of >::ComponentType = Of

Of

template<typename _Of >

using GQCP::SpinResolved< _Of >::Of = _Of

Member Function Documentation

operator!=()

template<typename _Of >

bool GQCP::SpinResolved< _Of >::operator!= ( const SpinResolved< Of > &  other )

inline

Parameters

other

the other encapsulation

Returns

whether this SpinResolved object is not equal to the other SpinResolved object.

operator==()

template<typename _Of >

bool GQCP::SpinResolved< _Of >::operator== ( const SpinResolved< Of > &  other )

inline

Parameters

other

the other encapsulation

Returns

whether this SpinResolved object is equal to the other SpinResolved object.

---

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

• /__w/GQCP/GQCP/gqcp/include/QuantumChemical/SpinResolved.hpp