TBTK::HoppingAmplitudeList Class Reference

List of HoppingAmplitudes . More...

#include <HoppingAmplitudeList.h>

Inheritance diagram for TBTK::HoppingAmplitudeList:

Public Member Functions
	HoppingAmplitudeList ()
	HoppingAmplitudeList (const std::string &serializeation, Serializable::Mode mode)
void	add (const HoppingAmplitude &hoppingAmplitude)
unsigned int	getSize () const
const HoppingAmplitude &	operator[] (unsigned int n) const
std::string	serialize (Serializable::Mode mode) const
unsigned int	getSizeInBytes () const
Public Member Functions inherited from TBTK::Serializable
template<>
std::string	serialize (const bool &data, Mode mode)
template<>
std::string	serialize (const double &data, Mode mode)
template<>
std::string	serialize (const std::complex< double > &data, Mode mode)
template<>
std::string	serialize (const int &data, Mode mode)
template<>
std::string	serialize (const unsigned int &data, Mode mode)
template<>
std::string	serialize (const SpinMatrix &data, Mode mode)
template<>
std::string	serialize (const Statistics &data, Mode mode)
template<>
std::string	serialize (const std::vector< std::complex< double >> &data, Mode mode)
template<>
int	deserialize (const std::string &serialization, Mode mode)

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)
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)
template<typename DataType >
static std::enable_if<!std::is_pointer< DataType >::value, std::string >::type	serialize (const DataType &data, Mode mode)
template<typename DataType >
static std::enable_if< std::is_pointer< DataType >::value, std::string >::type	serialize (const DataType &data, Mode mode)
template<typename DataType >
static DataType	deserialize (const std::string &serialization, Mode mode)
static std::string	extract (const std::string &serialization, Mode mode, std::string component)

Detailed Description

List of HoppingAmplitudes .

Constructor & Destructor Documentation

HoppingAmplitudeList() [1/2]

TBTK::HoppingAmplitudeList::HoppingAmplitudeList

(

)

Constructs a HoppingAmplitudeList

HoppingAmplitudeList() [2/2]

TBTK::HoppingAmplitudeList::HoppingAmplitudeList	(	const std::string &	serializeation,
		Serializable::Mode	mode
	)

Constructor. Constructs the HoppingAmplitudeList from a serialization string.

Parameters

serialization	Serialization string from which to construct the HoppingAmplitudeList.
mode	Mode with which the string has been serialized.

Member Function Documentation

add()

void TBTK::HoppingAmplitudeList::add ( const HoppingAmplitude &  hoppingAmplitude )

inline

Append HoppingAmplitude to the end of the list.

Parameters

hoppingAmplitude

HoppingAmplitude to add.

getSize()

unsigned int TBTK::HoppingAmplitudeList::getSize ( ) const

inline

Get size.

Returns

Number of elements in the list.

getSizeInBytes()

unsigned int TBTK::HoppingAmplitudeList::getSizeInBytes ( ) const

inline

Get size in bytes.

Returns

Memory size required to store the HoppingAmplitudeList.

operator[]()

const HoppingAmplitude & TBTK::HoppingAmplitudeList::operator[] ( unsigned int  n ) const

inline

Subscript operator.

Parameters

n	Element to access.

Returns

THe HoppingAmplitude at position n.

serialize()

std::string TBTK::HoppingAmplitudeList::serialize ( Serializable::Mode  mode ) const

virtual

Serialize HoppingAmplitudeList.

Parameters

mode	Serialization mode to use.

Returns

Serialized string representation of the HoppingAmplitudeList.

Implements TBTK::Serializable.

---

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

• /TBTK/Lib/include/Core/TBTK/HoppingAmplitudeList.h