Subtraction expression engine. More...

#include <subt_engine.h>

Inheritance diagram for TiledArray::expressions::SubtEngine< Left, Right, Result >:

Collaboration diagram for TiledArray::expressions::SubtEngine< Left, Right, Result >:

[legend]

Public Types
typedef SubtEngine< Left, Right, Result >	SubtEngine_
	This class type. More...

typedef BinaryEngine< SubtEngine_ >	BinaryEngine_
	Binary base class type. More...

typedef BinaryEngine_::ExprEngine_	ExprEngine_
	Expression engine base type. More...

typedef EngineTrait< SubtEngine_ >::left_type	left_type
	The left-hand expression type. More...

typedef EngineTrait< SubtEngine_ >::right_type	right_type
	The right-hand expression type. More...

typedef EngineTrait< SubtEngine_ >::value_type	value_type
	The result tile type. More...

typedef EngineTrait< SubtEngine_ >::op_base_type	op_base_type
	The tile operation type. More...

typedef EngineTrait< SubtEngine_ >::op_type	op_type
	The tile operation type. More...

typedef EngineTrait< SubtEngine_ >::policy	policy
	The result policy type. More...

typedef EngineTrait< SubtEngine_ >::dist_eval_type	dist_eval_type
	The distributed evaluator type. More...

typedef EngineTrait< SubtEngine_ >::size_type	size_type
	Size type. More...

typedef EngineTrait< SubtEngine_ >::trange_type	trange_type
	Tiled range type. More...

typedef EngineTrait< SubtEngine_ >::shape_type	shape_type
	Shape type. More...

typedef EngineTrait< SubtEngine_ >::pmap_interface	pmap_interface
	Process map interface type. More...

Public Types inherited from TiledArray::expressions::BinaryEngine< SubtEngine< Left, Right, Result > >
typedef BinaryEngine< SubtEngine< Left, Right, Result > >	BinaryEngine_
	This class type. More...

typedef ExprEngine< SubtEngine< Left, Right, Result > >	ExprEngine_
	Base class type. More...

typedef EngineTrait< SubtEngine< Left, Right, Result > >::left_type	left_type
	The left-hand expression type. More...

typedef EngineTrait< SubtEngine< Left, Right, Result > >::right_type	right_type
	The right-hand expression type. More...

typedef EngineTrait< SubtEngine< Left, Right, Result > >::value_type	value_type
	The result tile type. More...

typedef EngineTrait< SubtEngine< Left, Right, Result > >::op_type	op_type
	The tile operation type. More...

typedef EngineTrait< SubtEngine< Left, Right, Result > >::policy	policy
	The result policy type. More...

typedef EngineTrait< SubtEngine< Left, Right, Result > >::dist_eval_type	dist_eval_type
	The distributed evaluator type. More...

typedef EngineTrait< SubtEngine< Left, Right, Result > >::size_type	size_type
	Size type. More...

typedef EngineTrait< SubtEngine< Left, Right, Result > >::trange_type	trange_type
	Tiled range type. More...

typedef EngineTrait< SubtEngine< Left, Right, Result > >::shape_type	shape_type
	Shape type. More...

typedef EngineTrait< SubtEngine< Left, Right, Result > >::pmap_interface	pmap_interface
	Process map interface type. More...

Public Types inherited from TiledArray::expressions::ExprEngine< SubtEngine< Left, Right, Result > >
typedef ExprEngine< SubtEngine< Left, Right, Result > >	ExprEngine_

typedef SubtEngine< Left, Right, Result >	derived_type
	The derived object type. More...

typedef EngineTrait< SubtEngine< Left, Right, Result > >::value_type	value_type
	Tensor value type. More...

typedef EngineTrait< SubtEngine< Left, Right, Result > >::op_type	op_type
	Tile operation type. More...

typedef EngineTrait< SubtEngine< Left, Right, Result > >::policy	policy
	The result policy type. More...

typedef EngineTrait< SubtEngine< Left, Right, Result > >::dist_eval_type	dist_eval_type
	This expression's distributed evaluator type. More...

typedef EngineTrait< SubtEngine< Left, Right, Result > >::size_type	size_type
	Size type. More...

typedef EngineTrait< SubtEngine< Left, Right, Result > >::trange_type	trange_type
	Tiled range type type. More...

typedef EngineTrait< SubtEngine< Left, Right, Result > >::shape_type	shape_type
	Tensor shape type. More...

typedef EngineTrait< SubtEngine< Left, Right, Result > >::pmap_interface	pmap_interface
	Process map interface type. More...

Public Member Functions
template<typename L , typename R >
	SubtEngine (const SubtExpr< L, R > &expr)
	Constructor. More...

shape_type	make_shape () const
	Non-permuting shape factory function. More...

shape_type	make_shape (const Permutation &perm) const
	Permuting shape factory function. More...

const char *	make_tag () const
	Expression identification tag. More...

Public Member Functions inherited from TiledArray::expressions::BinaryEngine< SubtEngine< Left, Right, Result > >
	BinaryEngine (const BinaryExpr< D > &expr)

void	perm_vars (const VariableList &target_vars)
	Set the variable list for this expression. More...

void	init_vars (const VariableList &target_vars)
	Initialize the variable list of this expression. More...

void	init_vars ()
	Initialize the variable list of this expression. More...

void	init_struct (const VariableList &target_vars)
	Initialize result tensor structure. More...

void	init_distribution (World *world, const std::shared_ptr< pmap_interface > &pmap)
	Initialize result tensor distribution. More...

trange_type	make_trange () const
	Non-permuting tiled range factory function. More...

trange_type	make_trange (const Permutation &perm) const
	Permuting tiled range factory function. More...

dist_eval_type	make_dist_eval () const
	Construct the distributed evaluator for this expression. More...

void	print (ExprOStream os, const VariableList &target_vars) const
	Expression print. More...

Public Member Functions inherited from TiledArray::expressions::ExprEngine< SubtEngine< Left, Right, Result > >
	ExprEngine (const Expr< D > &expr)
	Default constructor. More...

void	init (World &world, std::shared_ptr< pmap_interface > pmap, const VariableList &target_vars)
	Construct and initialize the expression engine. More...

void	init_struct (const VariableList &target_vars)
	Initialize result tensor structure. More...

void	init_distribution (World *world, const std::shared_ptr< pmap_interface > &pmap)
	Initialize result tensor distribution. More...

Permutation	make_perm (const VariableList &target_vars) const
	Permutation factory function. More...

op_type	make_op () const
	Tile operation factory function. More...

derived_type &	derived ()
	Cast this object to it's derived type. More...

const derived_type &	derived () const
	Cast this object to it's derived type. More...

World *	world () const
	World accessor. More...

const VariableList &	vars () const
	Variable list accessor. More...

const Permutation &	perm () const
	Permutation accessor. More...

const trange_type &	trange () const
	Tiled range accessor. More...

const shape_type &	shape () const
	Shape accessor. More...

const std::shared_ptr< pmap_interface > &	pmap () const
	Process map accessor. More...

void	permute_tiles (const bool status)
	Set the permute tiles flag. More...

void	print (ExprOStream &os, const VariableList &target_vars) const
	Expression print. More...

const char *	make_tag () const
	Expression identification tag. More...

Static Public Member Functions
static op_type	make_tile_op ()
	Non-permuting tile operation factory function. More...

static op_type	make_tile_op (const Permutation &perm)
	Permuting tile operation factory function. More...

Additional Inherited Members
Static Public Attributes inherited from TiledArray::expressions::BinaryEngine< SubtEngine< Left, Right, Result > >
static constexpr bool	consumable

static constexpr unsigned int	leaves

Protected Attributes inherited from TiledArray::expressions::BinaryEngine< SubtEngine< Left, Right, Result > >
left_type	left_
	The left-hand argument. More...

right_type	right_
	The right-hand argument. More...

World *	world_
	The world where this expression will be evaluated. More...

VariableList	vars_
	The variable list of this expression. More...

Permutation	perm_
	The permutation that will be applied to the result. More...

trange_type	trange_
	The tiled range of the result tensor. More...

shape_type	shape_
	The shape of the result tensor. More...

std::shared_ptr< pmap_interface >	pmap_
	The process map for the result tensor. More...

bool	permute_tiles_
	Result tile permutation flag (`true` == permute tile) More...

Protected Attributes inherited from TiledArray::expressions::ExprEngine< SubtEngine< Left, Right, Result > >
World *	world_
	The world where this expression will be evaluated. More...

VariableList	vars_
	The variable list of this expression. More...

bool	permute_tiles_
	Result tile permutation flag (`true` == permute tile) More...

Permutation	perm_
	The permutation that will be applied to the result. More...

trange_type	trange_
	The tiled range of the result tensor. More...

shape_type	shape_
	The shape of the result tensor. More...

std::shared_ptr< pmap_interface >	pmap_
	The process map for the result tensor. More...

std::shared_ptr< EngineParamOverride< SubtEngine< Left, Right, Result > > >	override_ptr_
	The engine params overriding the default. More...

Detailed Description

template<typename Left, typename Right, typename Result>
class TiledArray::expressions::SubtEngine< Left, Right, Result >

Subtraction expression engine.

Template Parameters

Left	The left-hand expression type
Right	The right-hand expression type
Result	The result tile type

Definition at line 39 of file subt_engine.h.

Member Typedef Documentation

◆ BinaryEngine_

template<typename Left , typename Right , typename Result >

typedef BinaryEngine<SubtEngine_ > TiledArray::expressions::SubtEngine< Left, Right, Result >::BinaryEngine_

Binary base class type.

Definition at line 131 of file subt_engine.h.

◆ dist_eval_type

template<typename Left , typename Right , typename Result >

typedef EngineTrait<SubtEngine_>::dist_eval_type TiledArray::expressions::SubtEngine< Left, Right, Result >::dist_eval_type

The distributed evaluator type.

Definition at line 151 of file subt_engine.h.

◆ ExprEngine_

template<typename Left , typename Right , typename Result >

typedef BinaryEngine_::ExprEngine_ TiledArray::expressions::SubtEngine< Left, Right, Result >::ExprEngine_

Expression engine base type.

Definition at line 133 of file subt_engine.h.

◆ left_type

template<typename Left , typename Right , typename Result >

typedef EngineTrait<SubtEngine_>::left_type TiledArray::expressions::SubtEngine< Left, Right, Result >::left_type

The left-hand expression type.

Definition at line 137 of file subt_engine.h.

◆ op_base_type

template<typename Left , typename Right , typename Result >

typedef EngineTrait<SubtEngine_>::op_base_type TiledArray::expressions::SubtEngine< Left, Right, Result >::op_base_type

The tile operation type.

Definition at line 145 of file subt_engine.h.

◆ op_type

template<typename Left , typename Right , typename Result >

typedef EngineTrait<SubtEngine_>::op_type TiledArray::expressions::SubtEngine< Left, Right, Result >::op_type

The tile operation type.

Definition at line 147 of file subt_engine.h.

◆ pmap_interface

template<typename Left , typename Right , typename Result >

typedef EngineTrait<SubtEngine_>::pmap_interface TiledArray::expressions::SubtEngine< Left, Right, Result >::pmap_interface

Process map interface type.

Definition at line 161 of file subt_engine.h.

◆ policy

template<typename Left , typename Right , typename Result >

typedef EngineTrait<SubtEngine_>::policy TiledArray::expressions::SubtEngine< Left, Right, Result >::policy

The result policy type.

Definition at line 149 of file subt_engine.h.

◆ right_type

template<typename Left , typename Right , typename Result >

typedef EngineTrait<SubtEngine_>::right_type TiledArray::expressions::SubtEngine< Left, Right, Result >::right_type

The right-hand expression type.

Definition at line 139 of file subt_engine.h.

◆ shape_type

template<typename Left , typename Right , typename Result >

typedef EngineTrait<SubtEngine_>::shape_type TiledArray::expressions::SubtEngine< Left, Right, Result >::shape_type

Shape type.

Definition at line 159 of file subt_engine.h.

◆ size_type

template<typename Left , typename Right , typename Result >

typedef EngineTrait<SubtEngine_>::size_type TiledArray::expressions::SubtEngine< Left, Right, Result >::size_type

Size type.

Definition at line 155 of file subt_engine.h.

◆ SubtEngine_

template<typename Left , typename Right , typename Result >

typedef SubtEngine<Left, Right, Result> TiledArray::expressions::SubtEngine< Left, Right, Result >::SubtEngine_

This class type.

Definition at line 129 of file subt_engine.h.

◆ trange_type

template<typename Left , typename Right , typename Result >

typedef EngineTrait<SubtEngine_>::trange_type TiledArray::expressions::SubtEngine< Left, Right, Result >::trange_type

Tiled range type.

Definition at line 157 of file subt_engine.h.

◆ value_type

template<typename Left , typename Right , typename Result >

typedef EngineTrait<SubtEngine_>::value_type TiledArray::expressions::SubtEngine< Left, Right, Result >::value_type

The result tile type.

Definition at line 143 of file subt_engine.h.

Constructor & Destructor Documentation

◆ SubtEngine()

template<typename Left , typename Right , typename Result >

template<typename L , typename R >

TiledArray::expressions::SubtEngine< Left, Right, Result >::SubtEngine ( const SubtExpr< L, R > & expr )

inline

Constructor.

Template Parameters

L	The left-hand argument expression type
R	The right-hand argument expression type

Parameters

expr	The parent expression

Definition at line 169 of file subt_engine.h.

Member Function Documentation

◆ make_shape() [1/2]

template<typename Left , typename Right , typename Result >

shape_type TiledArray::expressions::SubtEngine< Left, Right, Result >::make_shape ( ) const

inline

Non-permuting shape factory function.

Returns: The result shape

Definition at line 174 of file subt_engine.h.

Here is the call graph for this function:

◆ make_shape() [2/2]

template<typename Left , typename Right , typename Result >

shape_type TiledArray::expressions::SubtEngine< Left, Right, Result >::make_shape ( const Permutation & perm ) const

inline

Permuting shape factory function.

Parameters

perm	The permutation to be applied to the array

Returns: The result shape

Definition at line 182 of file subt_engine.h.

Here is the call graph for this function:

◆ make_tag()

template<typename Left , typename Right , typename Result >

const char* TiledArray::expressions::SubtEngine< Left, Right, Result >::make_tag ( ) const

inline

Expression identification tag.

Returns: An expression tag used to identify this expression

Definition at line 200 of file subt_engine.h.

◆ make_tile_op() [1/2]

template<typename Left , typename Right , typename Result >

static op_type TiledArray::expressions::SubtEngine< Left, Right, Result >::make_tile_op ( )

inlinestatic

Non-permuting tile operation factory function.

Returns: The tile operation

Definition at line 189 of file subt_engine.h.

◆ make_tile_op() [2/2]

template<typename Left , typename Right , typename Result >

static op_type TiledArray::expressions::SubtEngine< Left, Right, Result >::make_tile_op ( const Permutation & perm )

inlinestatic

Permuting tile operation factory function.

Parameters

perm	The permutation to be applied to tiles

Returns: The tile operation

Definition at line 195 of file subt_engine.h.

Here is the call graph for this function:

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

TiledArray/expressions/subt_engine.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

template<typename Left, typename Right, typename Result> class TiledArray::expressions::SubtEngine< Left, Right, Result >

Member Typedef Documentation

◆ BinaryEngine_

◆ dist_eval_type

◆ ExprEngine_

◆ left_type

◆ op_base_type

◆ op_type

◆ pmap_interface

◆ policy

◆ right_type

◆ shape_type

◆ size_type

◆ SubtEngine_

◆ trange_type

◆ value_type

Constructor & Destructor Documentation

◆ SubtEngine()

Member Function Documentation

◆ make_shape() [1/2]

◆ make_shape() [2/2]

◆ make_tag()

◆ make_tile_op() [1/2]

◆ make_tile_op() [2/2]

template<typename Left, typename Right, typename Result>
class TiledArray::expressions::SubtEngine< Left, Right, Result >