GQCP::SpinResolvedBase< _Of, _Derived > Class Template Reference

#include <SpinResolvedBase.hpp>

Inheritance diagram for GQCP::SpinResolvedBase< _Of, _Derived >:

Collaboration diagram for GQCP::SpinResolvedBase< _Of, _Derived >:

Public Types
using	Of = _Of
using	Derived = _Derived
using	Self = SpinResolvedBase< Of, Derived >

Public Member Functions
	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)

Static Public Member Functions
static Derived	FromEqual (const Of &equal)

Detailed Description

template<typename _Of, typename _Derived>
class GQCP::SpinResolvedBase< _Of, _Derived >

A utility type encapsulating an alpha- and beta-type. In contrast to SpinResolved, this type is to be used as a base class/interface for types that are spin-resolved.

Parameters

_Of	The type of the alpha- and beta-objects. The name 'Of' is chosen for a natural reading SpinResolvedBase<_Of, _Derived>.
_Derived	The type that derives from this type, given as a template argument, enabling CRTP and compile-time polymorphism.

Member Typedef Documentation

Derived

template<typename _Of , typename _Derived >

using GQCP::SpinResolvedBase< _Of, _Derived >::Derived = _Derived

Of

template<typename _Of , typename _Derived >

using GQCP::SpinResolvedBase< _Of, _Derived >::Of = _Of

Self

template<typename _Of , typename _Derived >

using GQCP::SpinResolvedBase< _Of, _Derived >::Self = SpinResolvedBase<Of, Derived>

Constructor & Destructor Documentation

SpinResolvedBase() [1/4]

template<typename _Of , typename _Derived >

GQCP::SpinResolvedBase< _Of, _Derived >::SpinResolvedBase ( const Of &  alpha, const Of &  beta  )

inline

Construct a spin-resolved instance from its alpha and beta objects.

Parameters

alpha	The alpha-object.
beta	The beta-object.

SpinResolvedBase() [2/4]

template<typename _Of , typename _Derived >

GQCP::SpinResolvedBase< _Of, _Derived >::SpinResolvedBase ( const std::vector< Of > &  both )

inline

Construct a spin-resolved instance from a vector containing its alpha and beta objects.

Parameters

both	A vector containing both alpha and beta objects (in that order).

SpinResolvedBase() [3/4]

template<typename _Of , typename _Derived >

GQCP::SpinResolvedBase< _Of, _Derived >::SpinResolvedBase ( const std::array< Of, 2 > &  both )

inline

Construct a spin-resolved instance from an array containing its alpha and beta objects.

Parameters

both	An array containing both alpha and beta objects (in that order).

SpinResolvedBase() [4/4]

template<typename _Of , typename _Derived >

GQCP::SpinResolvedBase< _Of, _Derived >::SpinResolvedBase ( const std::initializer_list< Of > &  both )

inline

Construct a spin-resolved instance from an initializer list containing its alpha and beta objects.

Parameters

both	An initializer list containing both alpha and beta objects (in that order).

Member Function Documentation

alpha() [1/2]

template<typename _Of , typename _Derived >

Of & GQCP::SpinResolvedBase< _Of, _Derived >::alpha ( )

inline

Returns

A writable reference to the alpha object.

alpha() [2/2]

template<typename _Of , typename _Derived >

const Of & GQCP::SpinResolvedBase< _Of, _Derived >::alpha ( ) const

inline

Returns

A read-only reference to the alpha object.

beta() [1/2]

template<typename _Of , typename _Derived >

Of & GQCP::SpinResolvedBase< _Of, _Derived >::beta ( )

inline

Returns

A writable reference to the beta object.

beta() [2/2]

template<typename _Of , typename _Derived >

const Of & GQCP::SpinResolvedBase< _Of, _Derived >::beta ( ) const

inline

Returns

A read-only reference to the beta object.

component() [1/2]

template<typename _Of , typename _Derived >

Of & GQCP::SpinResolvedBase< _Of, _Derived >::component ( const Spin  sigma )

inline

Access the alpha or beta component of this spin-resolved type.

Parameters

sigma

Alpha or beta.

Returns

A writable reference to the alpha or beta object.

component() [2/2]

template<typename _Of , typename _Derived >

const Of & GQCP::SpinResolvedBase< _Of, _Derived >::component ( const Spin  sigma ) const

inline

Access the alpha or beta component of this spin-resolved instance.

Parameters

sigma

Alpha or beta.

Returns

A read-only reference to the alpha or beta object.

FromEqual()

template<typename _Of , typename _Derived >

static Derived GQCP::SpinResolvedBase< _Of, _Derived >::FromEqual ( const Of &  equal )

inlinestatic

Create a derived (spin-resolved) instance, from equal alpha and beta representations.

Parameters

equal

The equal representation for both the alpha and beta objects.

Returns

The derived (spin-resolved) type.

---

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

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