TBTK
TBTK::Property::DOS Class Reference

Property container for density of states (DOS). More...

#include <DOS.h>

Inheritance diagram for TBTK::Property::DOS:
TBTK::Property::AbstractProperty< double > TBTK::Serializable

Public Member Functions

 DOS (double lowerBound, double upperBound, int resolution)
 
 DOS (double lowerBound, double upperBound, int resolution, const double *data)
 
 DOS (const std::string &serialization, Mode mode)
 
double getLowerBound () const
 
double getUpperBound () const
 
int getResolution () const
 
virtual std::string serialize (Mode mode) const
 
- Public Member Functions inherited from TBTK::Property::AbstractProperty< double >
unsigned int getBlockSize () const
 
unsigned int getSize () const
 
const std::vector< double > & getData () const
 
std::vector< double > & 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 double & operator() (const Index &index, unsigned int offset=0) const
 
virtual double & operator() (const Index &index, unsigned int offset=0)
 
double & operator() (const std::initializer_list< int > &index)
 
const double & operator() (const std::initializer_list< int > &index) const
 
double & operator() (const std::initializer_list< unsigned int > &index)
 
const double & operator() (const std::initializer_list< unsigned int > &index) const
 
virtual const double & operator() (unsigned int offset) const
 
virtual double & operator() (unsigned int offset)
 
void setAllowIndexOutOfBoundsAccess (bool allowIndexOutOfBoundsAccess)
 
void setDefaultValue (const 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)
 
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< double >
 AbstractProperty ()
 
 AbstractProperty (unsigned int blockSize)
 
 AbstractProperty (unsigned int blockSize, const double *data)
 
 AbstractProperty (unsigned int dimensions, const int *ranges, unsigned int blockSize)
 
 AbstractProperty (unsigned int dimensions, const int *ranges, unsigned int blockSize, const double *data)
 
 AbstractProperty (const IndexTree &indexTree, unsigned int blockSize)
 
 AbstractProperty (const IndexTree &indexTree, unsigned int blockSize, const 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 density of states (DOS).

Constructor & Destructor Documentation

TBTK::Property::DOS::DOS ( double  lowerBound,
double  upperBound,
int  resolution 
)

Constructs a Density.

Parameters
lowerBoundLower bound for the energy.
upperBoundUpper bound for the energy.
resolutionNumber of points to us for the energy.
TBTK::Property::DOS::DOS ( double  lowerBound,
double  upperBound,
int  resolution,
const double *  data 
)

Constructs a Density and initializes it with data.

Parameters
lowerBoundLower bound for the energy.
upperBoundUpper bound for the energy.
resolutionNumber of points to us for the energy.
dataRaw data to initialize the DOS with.
TBTK::Property::DOS::DOS ( const std::string &  serialization,
Mode  mode 
)

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

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

Member Function Documentation

double TBTK::Property::DOS::getLowerBound ( ) const
inline

Destructor. Get lower bound for the energy.

Returns
Lower bound for the energy.
int TBTK::Property::DOS::getResolution ( ) const
inline

Get the energy resolution (number of points used for the energy axis).

Returns
The energy resolution.
double TBTK::Property::DOS::getUpperBound ( ) const
inline

Get upper bound for the energy.

Returns
Upper bound for the energy.
virtual std::string TBTK::Property::DOS::serialize ( Mode  mode) const
virtual

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

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


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