Class TempLat::BinaryOperator

template <typename R, typename T>

ClassList > TempLat > BinaryOperator

A parent class which implements the common methods that all binary operators (*, +, -,... ) share. More...

#include <binaryoperator.h>

Inherited by the following classes: TempLat::ChiralProjector, TempLat::GWProjector, TempLat::HermSymTracelessMultiplicationTrace, TempLat::MatrixMatrixMultiplicationTrace, TempLat::Operators::Addition, TempLat::Operators::Arg, TempLat::Operators::Arg2, TempLat::Operators::Division, TempLat::Operators::Multiplication, TempLat::Operators::Power, TempLat::Operators::SafeDivision, TempLat::Operators::Subtraction, TempLat::SU2Dotter, TempLat::SymSymTracelessMultiplicationTrace, TempLat::VectorDotter

Public Functions

Type	Name
	BinaryOperator (const R & pR, const T & pT)
device::Idx	confirmGhostsUpToDate () const
void	confirmSpace (const LayoutStruct< NDim > & newLayout, const SpaceStateType & spaceType) const
void	doWeNeedGhosts () const
auto	getDx () const
auto	getKIR () const
auto	getToolBox () const
virtual std::string	operatorString () const = 0 Override this method in your derived class, to have an easy implementation of your toString method.
void	postGet ()
void	preGet ()
std::string	toString () const If your descending class implements `operatorString()` and your operator is of the type "a OP b" (where OP is or whatever), this toString method does all the work for you.*

Public Static Functions

Type	Name
consteval size_t	getNDim ()

Protected Attributes

Type	Name
R	mR
T	mT

Detailed Description

Unit test: ctest -R test-binaryoperator

Public Functions Documentation

function BinaryOperator

inline TempLat::BinaryOperator::BinaryOperator (
    const R & pR,
    const T & pT
)

function confirmGhostsUpToDate

inline device::Idx TempLat::BinaryOperator::confirmGhostsUpToDate () const

function confirmSpace

template<size_t NDim>
inline void TempLat::BinaryOperator::confirmSpace (
    const LayoutStruct < NDim > & newLayout,
    const SpaceStateType & spaceType
) const

function doWeNeedGhosts

inline void TempLat::BinaryOperator::doWeNeedGhosts () const

function getDx

inline auto TempLat::BinaryOperator::getDx () const

function getKIR

inline auto TempLat::BinaryOperator::getKIR () const

function getToolBox

inline auto TempLat::BinaryOperator::getToolBox () const

For measurement objects.

function operatorString

Override this method in your derived class, to have an easy implementation of your toString method.

virtual std::string TempLat::BinaryOperator::operatorString () const = 0

function postGet

inline void TempLat::BinaryOperator::postGet ()

function preGet

inline void TempLat::BinaryOperator::preGet ()

function toString

If your descending class implements operatorString() and your operator is of the type "a OP b" (where OP is * or whatever), this toString method does all the work for you.

inline std::string TempLat::BinaryOperator::toString () const

Public Static Functions Documentation

function getNDim

static inline consteval size_t TempLat::BinaryOperator::getNDim ()

Protected Attributes Documentation

variable mR

R TempLat::BinaryOperator< R, T >::mR;

variable mT

T TempLat::BinaryOperator< R, T >::mT;

The documentation for this class was generated from the following file cosmolatticeweb/tmp/code_source/templat/include/TempLat/lattice/algebra/operators/binaryoperator.h