SubSpace< TotalSpace_, ScalarType_ > Class Template Reference

#include <HilbertSpace.hpp>

Inheritance diagram for SubSpace< TotalSpace_, ScalarType_ >:

Collaboration diagram for SubSpace< TotalSpace_, ScalarType_ >:

Public Types
using	TotalSpace = TotalSpace_
using	Scalar = ScalarType_
using	Real = typename Eigen::NumTraits< ScalarType_ >::Real

Public Member Functions
__host__ __device__	SubSpace (TotalSpace const &totalSpace)
	Construct a SubSpace object by copying totalSpace to its member variable (m_totalSpace)
__host__ __device__	SubSpace (TotalSpace &&totalSpace)
	Construct a SubSpace object by moving totalSpace to its member variable (m_totalSpace)
__host__ __device__	SubSpace ()=default
	Default constructor.
__host__ __device__	SubSpace (SubSpace const &other)=default
	Copy constructor.
template<typename Scalar_ >
__host__ __device__	SubSpace (SubSpace< TotalSpace_, Scalar_ > const &other)
__host__ __device__	SubSpace (SubSpace &&other)=default
	Move constructor.
__host__ __device__	~SubSpace ()=default
	Destructor.
Public Member Functions inherited from HilbertSpace< Derived >
__host__ __device__ int	dim () const
__host__ __device__ bool	operator== (HilbertSpace const &other) const

Protected Types
using	Matrix_t = SparseCompressed< Scalar >
using	Matrix_t = Eigen::SparseMatrix< Scalar >

Protected Attributes
TotalSpace	m_totalSpace
Matrix_t	m_basisStates

Operator overloads
friend	HilbertSpace< SubSpace< TotalSpace, Scalar > >
__host__ __device__ SubSpace &	operator= (SubSpace const &other)
	Copy assignment operator.
__host__ __device__ SubSpace &	operator= (SubSpace &&other)
	Move assignment operator.
__host__ __device__ bool	operator== (SubSpace const &other) const
	Equality operator.
__host__ __device__ Matrix_t &	basis ()
__host__ __device__ Matrix_t const &	basis () const
__host__ __device__ TotalSpace const &	totalSpace () const
__host__ __device__ int	dimTot () const
__host__ __device__ int	dim_impl () const

Member Typedef Documentation

Matrix_t [1/2]

template<class TotalSpace_ , typename ScalarType_ = Complex_t<Real_t>>

using SubSpace< TotalSpace_, ScalarType_ >::Matrix_t = SparseCompressed<Scalar>

protected

Matrix_t [2/2]

template<class TotalSpace_ , typename ScalarType_ = Complex_t<Real_t>>

using SubSpace< TotalSpace_, ScalarType_ >::Matrix_t = Eigen::SparseMatrix<Scalar>

protected

Real

template<class TotalSpace_ , typename ScalarType_ = Complex_t<Real_t>>

using SubSpace< TotalSpace_, ScalarType_ >::Real = typename Eigen::NumTraits<ScalarType_>::Real

Scalar

template<class TotalSpace_ , typename ScalarType_ = Complex_t<Real_t>>

using SubSpace< TotalSpace_, ScalarType_ >::Scalar = ScalarType_

TotalSpace

template<class TotalSpace_ , typename ScalarType_ = Complex_t<Real_t>>

using SubSpace< TotalSpace_, ScalarType_ >::TotalSpace = TotalSpace_

Constructor & Destructor Documentation

SubSpace() [1/6]

template<class TotalSpace_ , typename ScalarType_ = Complex_t<Real_t>>

__host__ __device__ SubSpace< TotalSpace_, ScalarType_ >::SubSpace ( TotalSpace const &  totalSpace )

inline

Construct a SubSpace object by copying totalSpace to its member variable (m_totalSpace)

Parameters

totalSpace

Returns

host

            : m_totalSpace{totalSpace}, m_basisStates(totalSpace.dim(), 0) {
            debug_constructor_printf(1);
        }

SubSpace() [2/6]

template<class TotalSpace_ , typename ScalarType_ = Complex_t<Real_t>>

__host__ __device__ SubSpace< TotalSpace_, ScalarType_ >::SubSpace ( TotalSpace &&  totalSpace )

inline

Construct a SubSpace object by moving totalSpace to its member variable (m_totalSpace)

Parameters

totalSpace

Returns

host

            : m_totalSpace{std::move(totalSpace)}, m_basisStates(totalSpace.dim(), 0) {
            debug_constructor_printf(2);
        }

SubSpace() [3/6]

template<class TotalSpace_ , typename ScalarType_ = Complex_t<Real_t>>

__host__ __device__ SubSpace< TotalSpace_, ScalarType_ >::SubSpace ( )

default

Default constructor.

SubSpace() [4/6]

template<class TotalSpace_ , typename ScalarType_ = Complex_t<Real_t>>

__host__ __device__ SubSpace< TotalSpace_, ScalarType_ >::SubSpace ( SubSpace< TotalSpace_, ScalarType_ > const &  other )

default

Copy constructor.

SubSpace() [5/6]

template<class TotalSpace_ , typename ScalarType_ = Complex_t<Real_t>>

template<typename Scalar_ >

__host__ __device__ SubSpace< TotalSpace_, ScalarType_ >::SubSpace ( SubSpace< TotalSpace_, Scalar_ > const &  other )

inline

            : m_totalSpace{other.totalSpace()},
              m_basisStates{other.basis().template cast<Scalar>()} {};

SubSpace() [6/6]

template<class TotalSpace_ , typename ScalarType_ = Complex_t<Real_t>>

__host__ __device__ SubSpace< TotalSpace_, ScalarType_ >::SubSpace ( SubSpace< TotalSpace_, ScalarType_ > &&  other )

default

Move constructor.

Parameters

other

Returns

host

~SubSpace()

template<class TotalSpace_ , typename ScalarType_ = Complex_t<Real_t>>

__host__ __device__ SubSpace< TotalSpace_, ScalarType_ >::~SubSpace ( )

default

Destructor.

Member Function Documentation

basis() [1/2]

template<class TotalSpace_ , typename ScalarType_ = Complex_t<Real_t>>

__host__ __device__ Matrix_t & SubSpace< TotalSpace_, ScalarType_ >::basis ( )

inline

{ return m_basisStates; }

basis() [2/2]

template<class TotalSpace_ , typename ScalarType_ = Complex_t<Real_t>>

__host__ __device__ Matrix_t const & SubSpace< TotalSpace_, ScalarType_ >::basis ( ) const

inline

{ return m_basisStates; }

dim_impl()

template<class TotalSpace_ , typename ScalarType_ = Complex_t<Real_t>>

__host__ __device__ int SubSpace< TotalSpace_, ScalarType_ >::dim_impl ( ) const

inlineprivate

{ return m_basisStates.cols(); }

dimTot()

template<class TotalSpace_ , typename ScalarType_ = Complex_t<Real_t>>

__host__ __device__ int SubSpace< TotalSpace_, ScalarType_ >::dimTot ( ) const

inline

{ return m_totalSpace.dim(); }

operator=() [1/2]

template<class TotalSpace_ , typename ScalarType_ = Complex_t<Real_t>>

__host__ __device__ SubSpace & SubSpace< TotalSpace_, ScalarType_ >::operator= ( SubSpace< TotalSpace_, ScalarType_ > &&  other )

inline

Move assignment operator.

Parameters

other

Returns

*this

                                                                  {
            debug_printf("%s:\n\tMove assignment operator.\n\n", __PRETTY_FUNCTION__);
            m_totalSpace  = std::move(other.m_totalSpace);
            m_basisStates = std::move(other.m_basisStates);
            return *this;
        }

operator=() [2/2]

template<class TotalSpace_ , typename ScalarType_ = Complex_t<Real_t>>

__host__ __device__ SubSpace & SubSpace< TotalSpace_, ScalarType_ >::operator= ( SubSpace< TotalSpace_, ScalarType_ > const &  other )

inline

Copy assignment operator.

Parameters

other

Returns

*this

                                                                       {
            debug_printf("%s:\n\tCopy assignment operator.\n\n", __PRETTY_FUNCTION__);
            m_totalSpace  = other.m_totalSpace;
            m_basisStates = other.m_basisStates;
            return *this;
        }

operator==()

template<class TotalSpace_ , typename ScalarType_ = Complex_t<Real_t>>

__host__ __device__ bool SubSpace< TotalSpace_, ScalarType_ >::operator== ( SubSpace< TotalSpace_, ScalarType_ > const &  other ) const

inline

Equality operator.

Parameters

other

Returns

bool

                                                                         {
            return m_totalSpace == other.totalSpace() && m_basisStates == other.basis();
        }

totalSpace()

template<class TotalSpace_ , typename ScalarType_ = Complex_t<Real_t>>

__host__ __device__ TotalSpace const & SubSpace< TotalSpace_, ScalarType_ >::totalSpace ( ) const

inline

{ return m_totalSpace; }

Member Data Documentation

HilbertSpace< SubSpace< TotalSpace, Scalar > >

template<class TotalSpace_ , typename ScalarType_ = Complex_t<Real_t>>

friend SubSpace< TotalSpace_, ScalarType_ >::HilbertSpace< SubSpace< TotalSpace, Scalar > >

private

m_basisStates

template<class TotalSpace_ , typename ScalarType_ = Complex_t<Real_t>>

Matrix_t SubSpace< TotalSpace_, ScalarType_ >::m_basisStates

protected

m_totalSpace

template<class TotalSpace_ , typename ScalarType_ = Complex_t<Real_t>>

TotalSpace SubSpace< TotalSpace_, ScalarType_ >::m_totalSpace

protected

---

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

• /Users/shoki/GitHub/Locality/Headers/HilbertSpace/HilbertSpace.hpp