TBTK
TBTK::Property::Magnetization Class Reference

Property container for magnetization. More...

#include <Magnetization.h>

Inheritance diagram for TBTK::Property::Magnetization:
TBTK::Property::AbstractProperty< SpinMatrix > TBTK::Serializable

Public Member Functions

 Magnetization (int dimensions, const int *ranges)
 
 Magnetization (int dimensions, const int *ranges, const SpinMatrix *data)
 
 Magnetization (const IndexTree &indexTree)
 
 Magnetization (const IndexTree &indexTree, const SpinMatrix *data)
 
 Magnetization (const std::string &serialization, Mode mode)
 
std::string serialize (Mode mode) const
 
- Public Member Functions inherited from TBTK::Property::AbstractProperty< SpinMatrix >
unsigned int getBlockSize () const
 
unsigned int getSize () const
 
const std::vector< SpinMatrix > & getData () const
 
std::vector< SpinMatrix > & getDataRW ()
 
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 SpinMatrixoperator() (const Index &index, unsigned int offset=0) const
 
virtual SpinMatrixoperator() (const Index &index, unsigned int offset=0)
 
SpinMatrixoperator() (const std::initializer_list< int > &index)
 
const SpinMatrixoperator() (const std::initializer_list< int > &index) const
 
SpinMatrixoperator() (const std::initializer_list< unsigned int > &index)
 
const SpinMatrixoperator() (const std::initializer_list< unsigned int > &index) const
 
virtual const SpinMatrixoperator() (unsigned int offset) const
 
virtual SpinMatrixoperator() (unsigned int offset)
 
void setAllowIndexOutOfBoundsAccess (bool allowIndexOutOfBoundsAccess)
 
void setDefaultValue (const SpinMatrix &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)
 
static std::string extractComponent (const std::string &serialization, const std::string &containerID, const std::string &componentID, const std::string &componentName, Mode mode)
 
- Protected Member Functions inherited from TBTK::Property::AbstractProperty< SpinMatrix >
 AbstractProperty ()
 
 AbstractProperty (unsigned int blockSize)
 
 AbstractProperty (unsigned int blockSize, const SpinMatrix *data)
 
 AbstractProperty (unsigned int dimensions, const int *ranges, unsigned int blockSize)
 
 AbstractProperty (unsigned int dimensions, const int *ranges, unsigned int blockSize, const SpinMatrix *data)
 
 AbstractProperty (const IndexTree &indexTree, unsigned int blockSize)
 
 AbstractProperty (const IndexTree &indexTree, unsigned int blockSize, const SpinMatrix *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 magnetization.

Constructor & Destructor Documentation

TBTK::Property::Magnetization::Magnetization ( int  dimensions,
const int *  ranges 
)

Constructs Magnetization on the Ranges format. [See AbstractProperty for detailed information about the Ranges format.]

Parameters
dimensionsNumber of dimensions for the grid.
rangesThe upper limit (exclusive) for the corresponding dimensions.
TBTK::Property::Magnetization::Magnetization ( int  dimensions,
const int *  ranges,
const SpinMatrix data 
)

Constructs Magnetization on the Ranges format and initializes it with data. [See AbstractProperty for detailed information about the Ranges format and the raw data format.]

Parameters
dimensionsNumber of dimensions for the grid.
rangesThe upper limit (exclusive) for the corresponding dimensions.
dataRaw data to initialize the Magnetization with.
TBTK::Property::Magnetization::Magnetization ( const IndexTree indexTree)

Constructs Magnetization on the Custom format. [See AbstractProperty for detailed information about the Custom format.]

Parameters
indexTreeIndexTree containing the Indeices for which the Magnetization should be contained.
TBTK::Property::Magnetization::Magnetization ( const IndexTree indexTree,
const SpinMatrix data 
)

Constructs Magnetization on the Custom format and initializes it with data. [See AbstractProperty for detailed information about the Custom format and the raw data format.]

Parameters
indexTreeIndexTree containing the Indeices for which the Magnetization should be contained.
dataRaw data to initialize the Magnetization with.
TBTK::Property::Magnetization::Magnetization ( const std::string &  serialization,
Mode  mode 
)

Copy constructor. Move constructor. Constructor. Constructs the Magnetization from a serialization string.

Parameters
serializationSerialization string from which to construct the Magnetization.
modeMode with which the string has been serialized.

Member Function Documentation

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

Destructor. Assignment operator. Move assignment operator. Overrides AbstractProperty::serialize().

Reimplemented from TBTK::Property::AbstractProperty< SpinMatrix >.


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