TBTK
TBTK::HoppingAmplitudeSet Class Reference

HoppingAmplitude container. More...

#include <HoppingAmplitudeSet.h>

Inheritance diagram for TBTK::HoppingAmplitudeSet:
TBTK::Serializable TBTK::HoppingAmplitudeTree

Classes

class  ConstIterator
 
class  Iterator
 

Public Member Functions

 HoppingAmplitudeSet ()
 
 HoppingAmplitudeSet (const std::vector< unsigned int > &capacity)
 
 HoppingAmplitudeSet (const HoppingAmplitudeSet &hoppingAmplitudeSet)
 
 HoppingAmplitudeSet (HoppingAmplitudeSet &&hoppingAmplitudeSet)
 
 HoppingAmplitudeSet (const std::string &serializeation, Mode mode)
 
virtual ~HoppingAmplitudeSet ()
 
HoppingAmplitudeSetoperator= (const HoppingAmplitudeSet &rhs)
 
HoppingAmplitudeSetoperator= (HoppingAmplitudeSet &&rhs)
 
void construct ()
 
bool getIsConstructed () const
 
int getFirstIndexInBlock (const Index &blockIndex) const
 
int getLastIndexInBlock (const Index &blockIndex) const
 
IndexTree getIndexTree () const
 
IndexTree getIndexTree (const Index &subspace) const
 
void sort ()
 
void constructCOO ()
 
void destructCOO ()
 
void reconstructCOO ()
 
int getNumMatrixElements () const
 
const int * getCOORowIndices () const
 
const int * getCOOColIndices () const
 
const std::complex< double > * getCOOValues () const
 
SparseMatrix< std::complex< double > > getSparseMatrix () const
 
Iterator begin ()
 
ConstIterator begin () const
 
ConstIterator cbegin () const
 
Iterator begin (const Index &subspace)
 
ConstIterator begin (const Index &subspace) const
 
ConstIterator cbegin (const Index &subspace) const
 
Iterator end ()
 
ConstIterator end () const
 
ConstIterator cend () const
 
Iterator end (const Index &subspace)
 
ConstIterator end (const Index &subspace) const
 
ConstIterator cend (const Index &subspace) const
 
void print ()
 
void tabulate (std::complex< double > **amplitudes, int **indices, int *numHoppingAmplitudes, int *maxIndexSize) const
 
virtual std::string serialize (Mode mode) const
 
unsigned int getSizeInBytes () const
 

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)
 
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

HoppingAmplitude container.

A HoppingAmplitudeSet is a container for HoppingAmplitudes . The structure contains the root node for the tree structure in which the HoppingAmplitudes are stored, as well as functions for adding and accessing HoppingAmplitudes. Once all HoppingAmplitudes have been added to the HoppingAmplitudeSet, the construct method has to be called in order to construct an appropriate Hilbert space. The HoppingAmplitudeSet is most importantly used by the Model to store the Hamiltonian.

Constructor & Destructor Documentation

TBTK::HoppingAmplitudeSet::HoppingAmplitudeSet ( )

Constructs a HoppingAmplitudeSet.

TBTK::HoppingAmplitudeSet::HoppingAmplitudeSet ( const std::vector< unsigned int > &  capacity)

Constructs a HoppingAmplitudeSet with a preallocated storage structure such that the addition of HoppingAmplitudes with indices that have the same subindex structure as 'capacity', but with smaller subindices will not cause reallocation for the main storage structure. Internal containers for HoppingAmplitudes may still be reallocated.

Parameters
capacity'Index capacity'.
TBTK::HoppingAmplitudeSet::HoppingAmplitudeSet ( const HoppingAmplitudeSet hoppingAmplitudeSet)

Copy constructor.

Parameters
hoppingAmplitudeSetHoppingAmplitudeSet to copy.
TBTK::HoppingAmplitudeSet::HoppingAmplitudeSet ( HoppingAmplitudeSet &&  hoppingAmplitudeSet)

Move constructor.

Parameters
hoppingAMplitudeSetHoppingAmplitudeSet to move.
TBTK::HoppingAmplitudeSet::HoppingAmplitudeSet ( const std::string &  serializeation,
Mode  mode 
)

Constructor. Constructs the HoppingAmplitudeSet from a serialization string.

Parameters
serializationSerialization string from which to construct the HoppingAmplitudeSet.
modeMode with which the string has been serialized.
virtual TBTK::HoppingAmplitudeSet::~HoppingAmplitudeSet ( )
virtual

Destructor.

Member Function Documentation

HoppingAmplitudeSet::Iterator TBTK::HoppingAmplitudeSet::begin ( )
inline

Create Iterator.

Returns
Iterator pointing to the first element in the HoppingAmplitudeSet.
HoppingAmplitudeSet::ConstIterator TBTK::HoppingAmplitudeSet::begin ( ) const
inline

Create ConstIterator.

Returns
ConstIterator pointing to the first element in the HoppingAmplitudeSet.
HoppingAmplitudeSet::Iterator TBTK::HoppingAmplitudeSet::begin ( const Index subspace)
inline

Create Iterator for a particular subspace.

Parameters
Indexfor the subspace the Iterator is to be iterating over.
Returns
Iterator pointing to the first element in the HoppingAmplitudeSet.
HoppingAmplitudeSet::ConstIterator TBTK::HoppingAmplitudeSet::begin ( const Index subspace) const
inline

Create ConstIterator for a particular subspace.

Parameters
Indexfor the subspace the ConstIterator is to be iterating over.
Returns
ConstIterator pointing to the first element in the HoppingAmplitudeSet.
HoppingAmplitudeSet::ConstIterator TBTK::HoppingAmplitudeSet::cbegin ( ) const
inline

Create ConstIterator.

Returns
ConstIterator pointing to the first element in the HoppingAmplitudeSet.
HoppingAmplitudeSet::ConstIterator TBTK::HoppingAmplitudeSet::cbegin ( const Index subspace) const
inline

Create ConstIterator for a particular subspace.

Parameters
Indexfor the subspace the ConstIterator is to be iterating over.
Returns
ConstIterator pointing to the first element in the HoppingAmplitudeSet.
HoppingAmplitudeSet::ConstIterator TBTK::HoppingAmplitudeSet::cend ( ) const
inline

Create ConstIterator pointing to the end.

Returns
ConstIterator pointing to the end of the HoppingAmplitudeSet.
HoppingAmplitudeSet::ConstIterator TBTK::HoppingAmplitudeSet::cend ( const Index subspace) const
inline

Create ConstIterator pointing to the end for a particular subspace.

Parameters
Indexfor the subspace the ConstIterator is to be iterating over.
Returns
ConstIterator pointing to the end of the HoppingAmplitudeSet.
void TBTK::HoppingAmplitudeSet::construct ( )
inline

Construct Hilbert space. No more HoppingAmplitudes should be added after this call.

void TBTK::HoppingAmplitudeSet::constructCOO ( )

Construct Hamiltonian on COO format.

void TBTK::HoppingAmplitudeSet::destructCOO ( )

Destruct Hamiltonian on COO format.

HoppingAmplitudeSet::Iterator TBTK::HoppingAmplitudeSet::end ( )
inline

Create Iterator pointing to the end.

Returns
Iterator pointing to the end of the HoppingAmplitudeSet.
HoppingAmplitudeSet::ConstIterator TBTK::HoppingAmplitudeSet::end ( ) const
inline

Create ConstIterator pointing to the end.

Returns
ConstIterator pointing to the end of the HoppingAmplitudeSet.
HoppingAmplitudeSet::Iterator TBTK::HoppingAmplitudeSet::end ( const Index subspace)
inline

Create Iterator pointing to the end for a particular subspace.

Parameters
Indexfor the subspace the Iterator is to be iterating over.
Returns
Iterator pointing to the end of the HoppingAmplitudeSet.
HoppingAmplitudeSet::ConstIterator TBTK::HoppingAmplitudeSet::end ( const Index subspace) const
inline

Create ConstIterator pointing to the end for a particular subspace.

Parameters
Indexfor the subspace the ConstIterator is to be iterating over.
Returns
ConstIterator pointing to the end of the HoppingAmplitudeSet.
const int * TBTK::HoppingAmplitudeSet::getCOOColIndices ( ) const
inline

Get col indices on COO format.

const int * TBTK::HoppingAmplitudeSet::getCOORowIndices ( ) const
inline

Get row indices on COO format.

const std::complex< double > * TBTK::HoppingAmplitudeSet::getCOOValues ( ) const
inline

Get row indices on COO format.

int TBTK::HoppingAmplitudeSet::getFirstIndexInBlock ( const Index blockIndex) const
inline

Get first index in block.

Parameters
subspaceIndexThe physical Index of the subspace.
Returns
The first Hilbert space index in the given subspace. If the subspace is emtpy, -1 is returned.
IndexTree TBTK::HoppingAmplitudeSet::getIndexTree ( ) const

Get an IndexTree containing all the Indices that are contained in the HoppingAmplitudeSet.

Returns
An IndexTree containing all the Indices that are contained in the HoppingAmplitudeSet.
IndexTree TBTK::HoppingAmplitudeSet::getIndexTree ( const Index subspace) const

Get an IndexTree containing all the Indices that are contained in the given subspace of the HoppingAmplitudeSet.

Parameters
subspaceThe subspaec to get the IndexTree for.
Returns
An IndexTree containing all the Indices that are contained in the given subspace of the HoppingAmplitudeSet.
bool TBTK::HoppingAmplitudeSet::getIsConstructed ( ) const
inline

Check whether the Hilbert space basis has been constructed.

Returns
True if the Hilbert space basis has been constructed.
int TBTK::HoppingAmplitudeSet::getLastIndexInBlock ( const Index blockIndex) const
inline

Get last index in block.

Parameters
subspaceIndexThe physical Index of the subspace.
Returns
The last Hilbert space index in the given subspace. If the subspace is empty, -1 is returned.
int TBTK::HoppingAmplitudeSet::getNumMatrixElements ( ) const

Get number of matrix elements in the Hamiltonian corresponding to the HoppingAmplitudeSet. Only used if COO format has been constructed.

unsigned int TBTK::HoppingAmplitudeSet::getSizeInBytes ( ) const
inline

Get size in bytes.

SparseMatrix< std::complex< double > > TBTK::HoppingAmplitudeSet::getSparseMatrix ( ) const
inline

Get a sprase matrix corresponding to the HoppingAMplitudeSet. The basis of the matrix is the Hilbert space basis.

Returns
A sparse matrix representation of the HoppingAmplitudeSet.
HoppingAmplitudeSet& TBTK::HoppingAmplitudeSet::operator= ( const HoppingAmplitudeSet rhs)

Assignment operator.

Parameters
rhsHoppingAmplitude to assign to the left hand side.
Returns
Reference to the assigned HoppingAmplitudeSet.
HoppingAmplitudeSet& TBTK::HoppingAmplitudeSet::operator= ( HoppingAmplitudeSet &&  rhs)

Move assignment operator.

Parameters
rhsHoppingAmplitude to assign to the left hand side.
Returns
Reference to the assigned HoppingAmplitudeSet.
void TBTK::HoppingAmplitudeSet::print ( )

Print tree structure. Mainly for debuging.

void TBTK::HoppingAmplitudeSet::reconstructCOO ( )

Reconstruct Hamiltonian on COO format. Only has any effect if a Hamiltonian on COO format already is constructed. Is necessary to reflect changes in the Hamiltonain due to changes in values returned by HoppingAmplitude-callback functions. The function is intended to be called by the Model whenever it is notified of possible changes in values returned by the callback-functions.

virtual std::string TBTK::HoppingAmplitudeSet::serialize ( Mode  mode) const
virtual

Implements Serializable::serialize().

Reimplemented from TBTK::HoppingAmplitudeTree.

void TBTK::HoppingAmplitudeSet::sort ( )
inline

Sort HoppingAmplitudes.

void TBTK::HoppingAmplitudeSet::tabulate ( std::complex< double > **  amplitudes,
int **  indices,
int *  numHoppingAmplitudes,
int *  maxIndexSize 
) const

Tabulates HoppingAmplitudes to make them possible to export.

Parameters
amplitudesPointer to amplitude table pointer. Memory will be allocated and has to be freed by the user. The array will contain all the HoppingAmplitude values when the function returns.
tablePointer to index table pointer. Memory will be allocated and has to be freed by the user. The array will contain the 'to'- and 'from'-indices for the corresponding HoppingAmplitude values in amplitudes. The values are stored sequentially using the format [to0] [padding] [from0] [padding] [to1] ..., where the padding is added to align 'to'- and 'from'-indices in memory in case multiple index sizes are encounterd. The number of padding elements will be zero for indices of size maxIndexSize and the padding value is -1. The total array size is 2*numHoppingAmplitudes*maxIndexSize.
numHoppingAmplitudesPointer to int that will contain the number of HoppingAMplitudes when the function returns.
maxIndexSizePointer to int that will contain the maximum number of subindices encountered.

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