TBTK::FieldWrapper Class Reference

#include <FieldWrapper.h>

Public Types
enum	DataType { ComplexDouble }
enum	ArgumentType { Double }

Public Member Functions
template<typename DataType , typename ArgumentType >
	FieldWrapper (Field< DataType, ArgumentType > &field)
DataType	getDataType () const
ArgumentType	getArgumentType () const
template<typename Data , typename Argument >
Data	operator() (std::initializer_list< Argument > arguments) const
template<typename Data , typename Argument >
bool	getIsCompact () const
template<typename Data , typename Argument >
const std::vector< Argument > &	getCoordinates () const
template<typename Data , typename Argument >
Argument	getExtent () const
template<>
	FieldWrapper (Field< std::complex< double >, double > &field)

Detailed Description

FieldWrapper.

Member Enumeration Documentation

ArgumentType

enum TBTK::FieldWrapper::ArgumentType

strong

Enum class for describing the argument type.

DataType

enum TBTK::FieldWrapper::DataType

strong

Enum class for describing the data type.

Constructor & Destructor Documentation

FieldWrapper()

template<typename DataType , typename ArgumentType >

TBTK::FieldWrapper::FieldWrapper

(

Field< DataType, ArgumentType > &

field

)

Constructor.

Member Function Documentation

getArgumentType()

FieldWrapper::ArgumentType TBTK::FieldWrapper::getArgumentType ( ) const

inline

Get argument type.

getCoordinates()

template<typename Data , typename Argument >

const std::vector<Argument>& TBTK::FieldWrapper::getCoordinates

(

)

const

Get coordinates.

getDataType()

FieldWrapper::DataType TBTK::FieldWrapper::getDataType ( ) const

inline

Get data type.

getExtent()

template<typename Data , typename Argument >

Argument TBTK::FieldWrapper::getExtent

(

)

const

Wrapping Field::getExtent().

getIsCompact()

template<typename Data , typename Argument >

bool TBTK::FieldWrapper::getIsCompact

(

)

const

Returns true if the wrapped field is compact.

operator()()

template<typename Data , typename Argument >

Data TBTK::FieldWrapper::operator()

(

std::initializer_list< Argument >

arguments

)

const

Function call operator wrapping Field::operator().

---

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

• /home/kristofer.bjornson/SecondQuantizationCom/TBTK/Lib/include/Uncategorized/TBTK/FieldWrapper.h