Property container for eigen values. More...

#include <EigenValues.h>

Inheritance diagram for TBTK::Property::EigenValues:

Public Member Functions
	EigenValues (int size)

	EigenValues (int size, const double *data)

	EigenValues (const std::string &serialization, Mode mode)

EigenValues &	operator+= (const EigenValues &rhs)

EigenValues	operator+ (const EigenValues &rhs) const

EigenValues &	operator-= (const EigenValues &rhs)

EigenValues	operator- (const EigenValues &rhs) const

EigenValues &	operator*= (const double &rhs)

EigenValues	operator* (const double &rhs) const

EigenValues &	operator/= (const double &rhs)

EigenValues	operator/ (const double &rhs) const

virtual std::string	toString () const

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 IndexDescriptor &	getIndexDescriptor () const

bool	contains (const Index &index) const

void	reduce (const std::vector< Index > &targetPatterns, const std::vector< Index > &newPatterns)

void	hermitianConjugate ()

std::vector< SparseMatrix< double > >	toSparseMatrices (const Model &model) 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< Subindex > &index)

const double &	operator() (const std::initializer_list< Subindex > &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)

void	replaceValues (const double &targetValue, const double &replacementValue)

virtual std::string	toString () 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)

Friends
EigenValues	operator* (const double &lhs, const EigenValues &rhs)

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 (const std::vector< int > &ranges, unsigned int blockSize)

	AbstractProperty (const std::vector< 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 ()

AbstractProperty &	operator= (const AbstractProperty &abstractProperty)

AbstractProperty &	operator= (AbstractProperty &&abstractProperty)

AbstractProperty &	operator+= (const AbstractProperty &rhs)

AbstractProperty &	operator-= (const AbstractProperty &rhs)

AbstractProperty &	operator*= (const double &rhs)

AbstractProperty &	operator/= (const double &rhs)

Protected Member Functions inherited from TBTK::Property::Property
	Property ()

virtual	~Property ()

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

Property container for eigen values.

The EigenValues is a Property with DataType double.

Conventions

EigenValues extracted by native PropertyExtractors satisfies the following convention.

The eigenvalues are ordered in accending order.

Example

#include "TBTK/Models/SquareLattice.h"
#include "TBTK/Property/EigenValues.h"
#include "TBTK/PropertyExtractor/Diagonalizer.h"
#include "TBTK/Solver/Diagonalizer.h"
#include "TBTK/Streams.h"
#include "TBTK/TBTK.h"
#include "TBTK/Visualization/MatPlotLib/Plotter.h"
 
using namespace TBTK;
using namespace Visualization::MatPlotLib;
 
int main(){
    Initialize();
 
    const unsigned int SIZE_X = 10;
    const unsigned int SIZE_Y = 10;
    double t = 1;
    Model model = Models::SquareLattice({SIZE_X, SIZE_Y}, {0, t});
    model.construct();
 
    Solver::Diagonalizer solver;
    solver.setModel(model);
    solver.run();
 
    PropertyExtractor::Diagonalizer propertyExtractor(solver);
 
    Property::EigenValues eigenValues
        = propertyExtractor.getEigenValues();
 
    Streams::out << "eigenValues(0) = " << eigenValues(0) << "\n";
    Streams::out << "eigenValues(10) = " << eigenValues(10) << "\n";
    Streams::out << "eigenValues(99) = " << eigenValues(99) << "\n";
 
    Plotter plotter;
    plotter.plot(eigenValues);
    plotter.save("figures/EigenValues.png");
}

Output

eigenValues(0) = -3.83797
eigenValues(10) = -2.61944
eigenValues(99) = 3.83797

Constructor & Destructor Documentation

◆ EigenValues() [1/3]

TBTK::Property::EigenValues::EigenValues ( int size )

Constructs EigenValues.

Parameters

size	The number of eigenvalues.

◆ EigenValues() [2/3]

TBTK::Property::EigenValues::EigenValues	(	int	size,
		const double *	data
	)

Constructs EigenValues and initializes it with data.

Parameters

size	The number of eigenvalues.
data	Raw data to initialize the EigenValues with.

◆ EigenValues() [3/3]

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

Constructor. Constructs the EigenValues from a serialization string.

Parameters

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

Member Function Documentation

◆ operator*()

EigenValues TBTK::Property::EigenValues::operator* ( const double & rhs ) const

inline

Multiplication operator.

Parameters

rhs	The right hand side of the equation.

Returns: A new EigenValues that is the product of the EigenValues and the right hand side.

◆ operator*=()

EigenValues & TBTK::Property::EigenValues::operator*= ( const double & rhs )

inline

Overrides AbstractProperty::operator*=().

◆ operator+()

EigenValues TBTK::Property::EigenValues::operator+ ( const EigenValues & rhs ) const

inline

Addition operator.

Parameters

rhs	The right hand side of the equation.

Returns: A new EigenValues that is the sum of this EigenValues and the right hand side.

◆ operator+=()

EigenValues & TBTK::Property::EigenValues::operator+= ( const EigenValues & rhs )

inline

Overrides AbstractProperty::operator+=().

◆ operator-()

EigenValues TBTK::Property::EigenValues::operator- ( const EigenValues & rhs ) const

inline

Subtraction operator.

Parameters

rhs	The right hand side of the equation.

Returns: A new EigenValues that is the difference between this EigenValues and the right hand side.

◆ operator-=()

EigenValues & TBTK::Property::EigenValues::operator-= ( const EigenValues & rhs )

inline

Overrides AbstractProperty::operator-=().

◆ operator/()

EigenValues TBTK::Property::EigenValues::operator/ ( const double & rhs ) const

inline

Division operator.

Parameters

rhs	The right hand side of the equation.

Returns: A new EigenValues that is the quotient between the EigenValues and the right hand side.

◆ operator/=()

EigenValues & TBTK::Property::EigenValues::operator/= ( const double & rhs )

inline

Overrides AbstractProperty::operator/=().

◆ serialize()

std::string TBTK::Property::EigenValues::serialize ( Mode mode ) const

virtual

Overrides AbstractProperty::serialize().

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

◆ toString()

virtual std::string TBTK::Property::EigenValues::toString ( ) const

virtual

Overriding Streamable::toString().

Implements TBTK::Streamable.

Friends And Related Function Documentation

◆ operator*

EigenValues operator*	(	const double &	lhs,
		const EigenValues &	rhs
	)

friend

Multiplication operator.

Parameters

lhs	The left hand side of the equation.
rhs	The right hand side of the equation.

Returns: A new EigenValues that is the product of the left hand side and the EigenValues.

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

/TBTK/Lib/include/TBTK/Property/EigenValues.h

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Conventions

Example

Output

Constructor & Destructor Documentation

◆ EigenValues() [1/3]

◆ EigenValues() [2/3]

◆ EigenValues() [3/3]

Member Function Documentation

◆ operator*()

◆ operator*=()

◆ operator+()

◆ operator+=()

◆ operator-()

◆ operator-=()

◆ operator/()

◆ operator/=()

◆ serialize()

◆ toString()

Friends And Related Function Documentation

◆ operator*