TiledArray::expressions::ScalTsrExpr< Array, Scalar > Class Template Reference

Documentation

template<typename Array, typename Scalar>
class TiledArray::expressions::ScalTsrExpr< Array, Scalar >

Expression wrapper for scaled array objects.

Template Parameters

Array	A DistArray type
Scalar	The scaling factor type

Definition at line 67 of file scal_tsr_expr.h.

Public Types
typedef ScalTsrExpr< Array, Scalar >	ScalTsrExpr_
	This class type. More...
typedef Expr< ScalTsrExpr_ >	Expr_
	Expression base type. More...
typedef ExprTrait< ScalTsrExpr_ >::array_type	array_type
	The array type. More...
typedef ExprTrait< ScalTsrExpr_ >::engine_type	engine_type
	Expression engine type. More...
typedef ExprTrait< ScalTsrExpr_ >::scalar_type	scalar_type
	Scalar type. More...

Public Member Functions
	ScalTsrExpr (const ScalTsrExpr_ &)=default
	ScalTsrExpr (ScalTsrExpr_ &&)=default
	~ScalTsrExpr ()=default
ScalTsrExpr_ &	operator= (const ScalTsrExpr_ &)=delete
ScalTsrExpr_ &	operator= (ScalTsrExpr_ &&)=delete
	ScalTsrExpr (const array_type &array, const std::string &annotation, const scalar_type factor)
	Construct a scaled tensor expression. More...
const array_type &	array () const
	Array accessor. More...
const std::string &	annotation () const
	Tensor annotation accessor. More...
scalar_type	factor () const
	Scaling factor accessor. More...

Member Typedef Documentation

array_type

template<typename Array , typename Scalar >

typedef ExprTrait<ScalTsrExpr_>::array_type TiledArray::expressions::ScalTsrExpr< Array, Scalar >::array_type

The array type.

Definition at line 72 of file scal_tsr_expr.h.

engine_type

template<typename Array , typename Scalar >

typedef ExprTrait<ScalTsrExpr_>::engine_type TiledArray::expressions::ScalTsrExpr< Array, Scalar >::engine_type

Expression engine type.

Definition at line 74 of file scal_tsr_expr.h.

Expr_

template<typename Array , typename Scalar >

typedef Expr<ScalTsrExpr_> TiledArray::expressions::ScalTsrExpr< Array, Scalar >::Expr_

Expression base type.

Definition at line 70 of file scal_tsr_expr.h.

scalar_type

template<typename Array , typename Scalar >

typedef ExprTrait<ScalTsrExpr_>::scalar_type TiledArray::expressions::ScalTsrExpr< Array, Scalar >::scalar_type

Scalar type.

Definition at line 76 of file scal_tsr_expr.h.

ScalTsrExpr_

template<typename Array , typename Scalar >

typedef ScalTsrExpr<Array, Scalar> TiledArray::expressions::ScalTsrExpr< Array, Scalar >::ScalTsrExpr_

This class type.

Definition at line 69 of file scal_tsr_expr.h.

Constructor & Destructor Documentation

ScalTsrExpr() [1/3]

template<typename Array , typename Scalar >

TiledArray::expressions::ScalTsrExpr< Array, Scalar >::ScalTsrExpr ( const ScalTsrExpr_ &  )

default

ScalTsrExpr() [2/3]

template<typename Array , typename Scalar >

TiledArray::expressions::ScalTsrExpr< Array, Scalar >::ScalTsrExpr ( ScalTsrExpr_ &&  )

default

~ScalTsrExpr()

template<typename Array , typename Scalar >

TiledArray::expressions::ScalTsrExpr< Array, Scalar >::~ScalTsrExpr ( )

default

ScalTsrExpr() [3/3]

template<typename Array , typename Scalar >

TiledArray::expressions::ScalTsrExpr< Array, Scalar >::ScalTsrExpr ( const array_type &  array, const std::string &  annotation, const scalar_type  factor  )

inline

Construct a scaled tensor expression.

Parameters

array	The array object
annotation	The array annotation
factor	The scaling factor

Definition at line 99 of file scal_tsr_expr.h.

Member Function Documentation

annotation()

template<typename Array , typename Scalar >

const std::string& TiledArray::expressions::ScalTsrExpr< Array, Scalar >::annotation ( ) const

inline

Tensor annotation accessor.

Returns

A const reference to the annotation for this tensor

Definition at line 111 of file scal_tsr_expr.h.

Here is the caller graph for this function:

array()

template<typename Array , typename Scalar >

const array_type& TiledArray::expressions::ScalTsrExpr< Array, Scalar >::array ( ) const

inline

Array accessor.

Returns

a const reference to this array

Definition at line 106 of file scal_tsr_expr.h.

Here is the caller graph for this function:

factor()

template<typename Array , typename Scalar >

scalar_type TiledArray::expressions::ScalTsrExpr< Array, Scalar >::factor ( ) const

inline

Scaling factor accessor.

Returns

The expression scaling factor

Definition at line 116 of file scal_tsr_expr.h.

Here is the caller graph for this function:

operator=() [1/2]

template<typename Array , typename Scalar >

ScalTsrExpr_& TiledArray::expressions::ScalTsrExpr< Array, Scalar >::operator= ( const ScalTsrExpr_ &  )

delete

operator=() [2/2]

template<typename Array , typename Scalar >

ScalTsrExpr_& TiledArray::expressions::ScalTsrExpr< Array, Scalar >::operator= ( ScalTsrExpr_ &&  )

delete

---

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

• TiledArray/expressions/scal_tsr_engine.h
• TiledArray/expressions/scal_tsr_expr.h