TBTK
TBTK::InteractionAmplitude Class Reference

Public Member Functions

 InteractionAmplitude ()
 
 InteractionAmplitude (std::complex< double > amplitude, std::initializer_list< Index > creationOperatorIndices, std::initializer_list< Index > annihilationOperatorIndices)
 
 InteractionAmplitude (std::complex< double >(*amplitudeCallback)(const std::vector< Index > &, const std::vector< Index > &), std::initializer_list< Index > toIndex, std::initializer_list< Index > fromIndex)
 
 InteractionAmplitude (const InteractionAmplitude &ia)
 
 ~InteractionAmplitude ()
 
std::complex< double > getAmplitude () const
 
unsigned int getNumCreationOperators () const
 
unsigned int getNumAnnihilationOperators () const
 
const IndexgetCreationOperatorIndex (unsigned int n) const
 
const IndexgetAnnihilationOperatorIndex (unsigned int n) const
 

Constructor & Destructor Documentation

◆ InteractionAmplitude() [1/4]

TBTK::InteractionAmplitude::InteractionAmplitude ( )

Constructor.

◆ InteractionAmplitude() [2/4]

TBTK::InteractionAmplitude::InteractionAmplitude ( std::complex< double >  amplitude,
std::initializer_list< Index creationOperatorIndices,
std::initializer_list< Index annihilationOperatorIndices 
)

Constructor.

◆ InteractionAmplitude() [3/4]

TBTK::InteractionAmplitude::InteractionAmplitude ( std::complex< double >(*)(const std::vector< Index > &, const std::vector< Index > &)  amplitudeCallback,
std::initializer_list< Index toIndex,
std::initializer_list< Index fromIndex 
)

Constructor. Takes a callback function rather than a parameter value. The callback function has to be defined such that it returns a value for the given indices when called at run time.

◆ InteractionAmplitude() [4/4]

TBTK::InteractionAmplitude::InteractionAmplitude ( const InteractionAmplitude ia)

Copy constructor.

◆ ~InteractionAmplitude()

TBTK::InteractionAmplitude::~InteractionAmplitude ( )

Destructor.

Member Function Documentation

◆ getAmplitude()

std::complex< double > TBTK::InteractionAmplitude::getAmplitude ( ) const
inline

Get the amplitude value \(a_{\{c\}\{a\})}\), where \(\{c\}\) and \(\{a\}\) are sets of creation and annihilation operator indices.

◆ getAnnihilationOperatorIndex()

const Index & TBTK::InteractionAmplitude::getAnnihilationOperatorIndex ( unsigned int  n) const
inline

Get annihilation operator index.

◆ getCreationOperatorIndex()

const Index & TBTK::InteractionAmplitude::getCreationOperatorIndex ( unsigned int  n) const
inline

Get creation operator index.

◆ getNumAnnihilationOperators()

unsigned int TBTK::InteractionAmplitude::getNumAnnihilationOperators ( ) const
inline

Returns the number of annihilation operator indices.

◆ getNumCreationOperators()

unsigned int TBTK::InteractionAmplitude::getNumCreationOperators ( ) const
inline

Returns the number of creation operator indices.


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