TBTK
TBTK::Property::WaveFunctions Class Reference

Property container for wave function. More...

#include <WaveFunctions.h>

Inheritance diagram for TBTK::Property::WaveFunctions:
TBTK::Property::AbstractProperty< std::complex< double > > TBTK::Serializable

Public Member Functions

 WaveFunctions (const IndexTree &indexTree, const std::initializer_list< unsigned int > &states)
 
 WaveFunctions (const IndexTree &indexTree, const std::vector< unsigned int > &states)
 
 WaveFunctions (const IndexTree &indexTree, const std::initializer_list< unsigned int > &states, const std::complex< double > *data)
 
 WaveFunctions (const IndexTree &indexTree, const std::vector< unsigned int > &states, const std::complex< double > *data)
 
 WaveFunctions (const WaveFunctions &waveFunctions)
 
 WaveFunctions (WaveFunctions &&waveFunctions)
 
 WaveFunctions (const std::string &serialization, Mode mode)
 
 ~WaveFunctions ()
 
WaveFunctionsoperator= (const WaveFunctions &rhs)
 
WaveFunctionsoperator= (WaveFunctions &&rhs)
 
const std::vector< unsigned int > & getStates () const
 
const std::complex< double > & operator() (const Index &index, unsigned int state) const
 
std::complex< double > & operator() (const Index &index, unsigned int state)
 
double getMinAbs () const
 
double getMaxAbs () const
 
double getMinArg () const
 
double getMaxArg () const
 
virtual std::string serialize (Mode mode) const
 
- Public Member Functions inherited from TBTK::Property::AbstractProperty< std::complex< double > >
unsigned int getBlockSize () const
 
void setSize (unsigned int size)
 
unsigned int getSize () const
 
const std::complex< double > * getData () const
 
std::complex< double > * getDataRW ()
 
unsigned int getSizeInBytes () const
 
char * getRawData ()
 
unsigned int getDimensions () const
 
std::vector< int > getRanges () const
 
int getOffset (const Index &index) const
 
const IndexDescriptorgetIndexDescriptor () const
 
bool contains (const Index &index) const
 
virtual const std::complex< double > & operator() (unsigned int offset) const
 
virtual std::complex< double > & operator() (unsigned int offset)
 
void setAllowIndexOutOfBoundsAccess (bool allowIndexOutOfBoundsAccess)
 
void setDefaultValue (const std::complex< double > &defaultValue)
 

Additional Inherited Members

- Public Types inherited from TBTK::Serializable
enum  Mode { Debug, Binary, XML, JSON }
 
- Static Public Member Functions inherited from TBTK::Serializable
static bool hasID (const std::string &serialization, Mode mode)
 
static std::string getID (const std::string &serialization, Mode mode)
 
- Protected Member Functions inherited from TBTK::Property::AbstractProperty< std::complex< double > >
 AbstractProperty ()
 
 AbstractProperty (unsigned int blockSize)
 
 AbstractProperty (unsigned int blockSize, const std::complex< double > *data)
 
 AbstractProperty (unsigned int dimensions, const int *ranges, unsigned int blockSize)
 
 AbstractProperty (unsigned int dimensions, const int *ranges, unsigned int blockSize, const std::complex< double > *data)
 
 AbstractProperty (const IndexTree &indexTree, unsigned int blockSize)
 
 AbstractProperty (const IndexTree &indexTree, unsigned int blockSize, const std::complex< double > *data)
 
 AbstractProperty (const AbstractProperty &abstractProperty)
 
 AbstractProperty (AbstractProperty &&abstractProperty)
 
 AbstractProperty (const std::string &serialization, Mode mode)
 
virtual ~AbstractProperty ()
 
AbstractPropertyoperator= (const AbstractProperty &abstractProperty)
 
AbstractPropertyoperator= (AbstractProperty &&abstractProperty)
 
- Static Protected Member Functions inherited from TBTK::Serializable
static bool validate (const std::string &serialization, const std::string &id, Mode mode)
 
static std::string getContent (const std::string &serialization, Mode mode)
 
static std::vector< std::string > split (const std::string &content, Mode mode)
 
static std::string serialize (bool b, Mode mode)
 
static void deserialize (const std::string &serialization, bool *b, Mode mode)
 
static std::string serialize (int i, Mode mode)
 
static void deserialize (const std::string &serialization, int *i, Mode mode)
 
static std::string serialize (unsigned int u, Mode mode)
 
static void deserialize (const std::string &serialization, unsigned int *u, Mode mode)
 
static std::string serialize (double d, Mode mode)
 
static void deserialize (const std::string &serialization, double *d, Mode mode)
 
static std::string serialize (std::complex< double > c, Mode mode)
 
static void deserialize (const std::string &serialization, std::complex< double > *c, Mode mode)
 
static std::string serialize (Statistics s, Mode mode)
 
static void deserialize (const std::string &serialization, Statistics *s, Mode mode)
 
static std::string extract (const std::string &serialization, Mode mode, std::string component)
 

Detailed Description

Property container for wave function.

Constructor & Destructor Documentation

TBTK::Property::WaveFunctions::WaveFunctions ( const IndexTree indexTree,
const std::initializer_list< unsigned int > &  states 
)

Constructor. Constructor. Constructor.

TBTK::Property::WaveFunctions::WaveFunctions ( const IndexTree indexTree,
const std::vector< unsigned int > &  states 
)

Constructor.

TBTK::Property::WaveFunctions::WaveFunctions ( const IndexTree indexTree,
const std::initializer_list< unsigned int > &  states,
const std::complex< double > *  data 
)

Constructor.

TBTK::Property::WaveFunctions::WaveFunctions ( const IndexTree indexTree,
const std::vector< unsigned int > &  states,
const std::complex< double > *  data 
)

Constructor.

TBTK::Property::WaveFunctions::WaveFunctions ( const WaveFunctions waveFunctions)

Copy constructor.

TBTK::Property::WaveFunctions::WaveFunctions ( WaveFunctions &&  waveFunctions)

Move constructor.

TBTK::Property::WaveFunctions::WaveFunctions ( const std::string &  serialization,
Mode  mode 
)

Constructor. Constructs the WaveFunctions from a serialization string.

TBTK::Property::WaveFunctions::~WaveFunctions ( )

Destructor.

Member Function Documentation

double TBTK::Property::WaveFunctions::getMaxAbs ( ) const

Get max absolute value.

double TBTK::Property::WaveFunctions::getMaxArg ( ) const

Get max argument value.

double TBTK::Property::WaveFunctions::getMinAbs ( ) const

Get min absolute value.

double TBTK::Property::WaveFunctions::getMinArg ( ) const

Get min argument value.

const std::vector< unsigned int > & TBTK::Property::WaveFunctions::getStates ( ) const
inline

Returns a vector with the state indices for which the wave function is defined.

const std::complex<double>& TBTK::Property::WaveFunctions::operator() ( const Index index,
unsigned int  state 
) const
virtual

Overrides AbstractProperty::operator().

Reimplemented from TBTK::Property::AbstractProperty< std::complex< double > >.

std::complex<double>& TBTK::Property::WaveFunctions::operator() ( const Index index,
unsigned int  state 
)
virtual

Overrides AbstractProperty::operator().

Reimplemented from TBTK::Property::AbstractProperty< std::complex< double > >.

WaveFunctions& TBTK::Property::WaveFunctions::operator= ( const WaveFunctions rhs)

Assignment operator.

WaveFunctions& TBTK::Property::WaveFunctions::operator= ( WaveFunctions &&  rhs)

Move assignment operator.

virtual std::string TBTK::Property::WaveFunctions::serialize ( Mode  mode) const
virtual

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