Inheritance diagram for TiledArray::expressions::BinaryEngine< Derived >:

Collaboration diagram for TiledArray::expressions::BinaryEngine< Derived >:

Documentation

template<typename Derived>
class TiledArray::expressions::BinaryEngine< Derived >

Definition at line 43 of file binary_engine.h.

Public Types
typedef BinaryEngine< Derived >	BinaryEngine_
	This class type. More...

typedef ExprEngine< Derived >	ExprEngine_
	Base class type. More...

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

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

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

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

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

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

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

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

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

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

Public Member Functions
template<typename D >
	BinaryEngine (const BinaryExpr< D > &expr)

void	perm_indices (const BipartiteIndexList &target_indices)
	Set the index list for this expression. More...

void	init_indices (const BipartiteIndexList &target_indices)
	Initialize the index list of this expression. More...

void	init_indices (bool children_initialized=false)
	Initialize the index list of this expression. More...

void	init_struct (const BipartiteIndexList &target_indices)
	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 BipartiteIndexList &target_indices) const
	Expression print. More...

Static Public Attributes
static constexpr bool	consumable = EngineTrait<Derived>::consumable

static constexpr unsigned int	leaves = EngineTrait<Derived>::leaves

Protected Member Functions
template<TensorProduct ProductType>
void	init_indices_ (const BipartiteIndexList &target_indices={})

Protected Attributes
left_type	left_
	The left-hand argument. More...

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

BipartiteIndexList	left_indices_
	Target left-hand index list. More...

BipartiteIndexList	right_indices_
	Target right-hand index list. More...

PermutationType	left_outer_permtype_
	Left-hand permutation type. More...

PermutationType	right_outer_permtype_
	Right-hand permutation type. More...

PermutationType	left_inner_permtype_
	Left-hand permutation type. More...

PermutationType	right_inner_permtype_
	Right-hand permutation type. More...

BipartiteIndexList	indices_

BipartitePermutation	perm_
	The permutation that will be applied to the outer tensor of tensors. More...

bool	permute_tiles_

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

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

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

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

Member Typedef Documentation

◆ BinaryEngine_

template<typename Derived >

typedef BinaryEngine<Derived> TiledArray::expressions::BinaryEngine< Derived >::BinaryEngine_

This class type.

Definition at line 46 of file binary_engine.h.

◆ dist_eval_type

template<typename Derived >

typedef EngineTrait<Derived>::dist_eval_type TiledArray::expressions::BinaryEngine< Derived >::dist_eval_type

The distributed evaluator type.

Definition at line 63 of file binary_engine.h.

◆ ExprEngine_

template<typename Derived >

typedef ExprEngine<Derived> TiledArray::expressions::BinaryEngine< Derived >::ExprEngine_

Base class type.

Definition at line 47 of file binary_engine.h.

◆ left_type

template<typename Derived >

typedef EngineTrait<Derived>::left_type TiledArray::expressions::BinaryEngine< Derived >::left_type

The left-hand expression type.

Definition at line 51 of file binary_engine.h.

◆ op_type

template<typename Derived >

typedef EngineTrait<Derived>::op_type TiledArray::expressions::BinaryEngine< Derived >::op_type

The tile operation type.

Definition at line 59 of file binary_engine.h.

◆ pmap_interface

template<typename Derived >

typedef EngineTrait<Derived>::pmap_interface TiledArray::expressions::BinaryEngine< Derived >::pmap_interface

Process map interface type.

Definition at line 71 of file binary_engine.h.

◆ policy

template<typename Derived >

typedef EngineTrait<Derived>::policy TiledArray::expressions::BinaryEngine< Derived >::policy

The result policy type.

Definition at line 61 of file binary_engine.h.

◆ right_type

template<typename Derived >

typedef EngineTrait<Derived>::right_type TiledArray::expressions::BinaryEngine< Derived >::right_type

The right-hand expression type.

Definition at line 53 of file binary_engine.h.

◆ shape_type

template<typename Derived >

typedef EngineTrait<Derived>::shape_type TiledArray::expressions::BinaryEngine< Derived >::shape_type

Shape type.

Definition at line 69 of file binary_engine.h.

◆ size_type

template<typename Derived >

typedef EngineTrait<Derived>::size_type TiledArray::expressions::BinaryEngine< Derived >::size_type

Size type.

Definition at line 66 of file binary_engine.h.

◆ trange_type

template<typename Derived >

typedef EngineTrait<Derived>::trange_type TiledArray::expressions::BinaryEngine< Derived >::trange_type

Tiled range type.

Definition at line 68 of file binary_engine.h.

◆ value_type

template<typename Derived >

typedef EngineTrait<Derived>::value_type TiledArray::expressions::BinaryEngine< Derived >::value_type

The result tile type.

Definition at line 57 of file binary_engine.h.

Constructor & Destructor Documentation

◆ BinaryEngine()

template<typename Derived >

template<typename D >

TiledArray::expressions::BinaryEngine< Derived >::BinaryEngine ( const BinaryExpr< D > & expr )

inline

Definition at line 182 of file binary_engine.h.

Member Function Documentation

◆ init_distribution()

template<typename Derived >

void TiledArray::expressions::BinaryEngine< Derived >::init_distribution	(	World *	world,
		const std::shared_ptr< pmap_interface > &	pmap
	)

inline

Initialize result tensor distribution.

This function will initialize the world and process map for the result tensor.

Parameters

world	The world were the result will be distributed
pmap	The process map for the result tensor tiles

Definition at line 261 of file binary_engine.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ init_indices() [1/2]

template<typename Derived >

void TiledArray::expressions::BinaryEngine< Derived >::init_indices ( bool children_initialized = false )

inline

Initialize the index list of this expression.

Definition at line 218 of file binary_engine.h.

◆ init_indices() [2/2]

template<typename Derived >

void TiledArray::expressions::BinaryEngine< Derived >::init_indices ( const BipartiteIndexList & target_indices )

inline

Initialize the index list of this expression.

Parameters

target_indices The target index list for this expression

Definition at line 211 of file binary_engine.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ init_indices_()

template<typename Derived >

template<TensorProduct ProductType>

void TiledArray::expressions::BinaryEngine< Derived >::init_indices_ ( const BipartiteIndexList & target_indices = {} )

inlineprotected

Definition at line 100 of file binary_engine.h.

◆ init_struct()

template<typename Derived >

void TiledArray::expressions::BinaryEngine< Derived >::init_struct ( const BipartiteIndexList & target_indices )

inline

Initialize result tensor structure.

This function will initialize the permutation, tiled range, and shape for the left-hand, right-hand, and result tensor.

Parameters

target_indices The target index list for the result tensor

Definition at line 234 of file binary_engine.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ make_dist_eval()

template<typename Derived >

dist_eval_type TiledArray::expressions::BinaryEngine< Derived >::make_dist_eval ( ) const

inline

Construct the distributed evaluator for this expression.

Returns: The distributed evaluator that will evaluate this expression

Definition at line 284 of file binary_engine.h.

Here is the caller graph for this function:

◆ make_trange() [1/2]

template<typename Derived >

trange_type TiledArray::expressions::BinaryEngine< Derived >::make_trange ( ) const

inline

Non-permuting tiled range factory function.

Returns: The result tiled range

Definition at line 271 of file binary_engine.h.

Here is the caller graph for this function:

◆ make_trange() [2/2]

template<typename Derived >

trange_type TiledArray::expressions::BinaryEngine< Derived >::make_trange ( const Permutation & perm ) const

inline

Permuting tiled range factory function.

Parameters

perm	The permutation to be applied to the tiled range

Returns: The result shape

Definition at line 277 of file binary_engine.h.

◆ perm_indices()

template<typename Derived >

void TiledArray::expressions::BinaryEngine< Derived >::perm_indices ( const BipartiteIndexList & target_indices )

inline

Set the index list for this expression.

This function will set the index list for this expression and its children such that the number of permutations is minimized. The final index list may not be set to target, which indicates that the result of this expression will be permuted to match target_indices.

Parameters

target_indices The target index list for this expression

Definition at line 192 of file binary_engine.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ print()

template<typename Derived >

void TiledArray::expressions::BinaryEngine< Derived >::print	(	ExprOStream	os,
		const BipartiteIndexList &	target_indices
	)		const

inline

Expression print.

Parameters

os	The output stream
target_indices	The target index list for this expression

Definition at line 306 of file binary_engine.h.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ consumable

template<typename Derived >

constexpr bool TiledArray::expressions::BinaryEngine< Derived >::consumable = EngineTrait<Derived>::consumable

staticconstexpr

Definition at line 73 of file binary_engine.h.

◆ indices_

template<typename Derived >

BipartiteIndexList TiledArray::expressions::ExprEngine< Derived >::indices_

protected

The index list of this expression; bipartite due to need to support recursive tensors (i.e. Tensor-of-Tensor)

Definition at line 75 of file expr_engine.h.

◆ leaves

template<typename Derived >

constexpr unsigned int TiledArray::expressions::BinaryEngine< Derived >::leaves = EngineTrait<Derived>::leaves

staticconstexpr

Definition at line 74 of file binary_engine.h.

◆ left_

template<typename Derived >

left_type TiledArray::expressions::BinaryEngine< Derived >::left_

protected

The left-hand argument.

Definition at line 86 of file binary_engine.h.

◆ left_indices_

template<typename Derived >

BipartiteIndexList TiledArray::expressions::BinaryEngine< Derived >::left_indices_

protected

Target left-hand index list.

Definition at line 88 of file binary_engine.h.

◆ left_inner_permtype_

template<typename Derived >

PermutationType TiledArray::expressions::BinaryEngine< Derived >::left_inner_permtype_

protected

Initial value:

=

PermutationType::general

Left-hand permutation type.

Definition at line 94 of file binary_engine.h.

◆ left_outer_permtype_

template<typename Derived >

PermutationType TiledArray::expressions::BinaryEngine< Derived >::left_outer_permtype_

protected

Initial value:

=

PermutationType::general

Left-hand permutation type.

Definition at line 90 of file binary_engine.h.

◆ perm_

template<typename Derived >

BipartitePermutation TiledArray::expressions::ExprEngine< Derived >::perm_

protected

The permutation that will be applied to the outer tensor of tensors.

Definition at line 80 of file expr_engine.h.

◆ permute_tiles_

template<typename Derived >

bool TiledArray::expressions::ExprEngine< Derived >::permute_tiles_

protected

Result tile permutation flag (true == permute tile)

Definition at line 77 of file expr_engine.h.

◆ pmap_

template<typename Derived >

std::shared_ptr<pmap_interface> TiledArray::expressions::ExprEngine< Derived >::pmap_

protected

The process map for the result tensor.

Definition at line 84 of file expr_engine.h.

◆ right_

template<typename Derived >

right_type TiledArray::expressions::BinaryEngine< Derived >::right_

protected

The right-hand argument.

Definition at line 87 of file binary_engine.h.

◆ right_indices_

template<typename Derived >

BipartiteIndexList TiledArray::expressions::BinaryEngine< Derived >::right_indices_

protected

Target right-hand index list.

Definition at line 89 of file binary_engine.h.

◆ right_inner_permtype_

template<typename Derived >

PermutationType TiledArray::expressions::BinaryEngine< Derived >::right_inner_permtype_

protected

Initial value:

=

PermutationType::general

Right-hand permutation type.

Definition at line 96 of file binary_engine.h.

◆ right_outer_permtype_

template<typename Derived >

PermutationType TiledArray::expressions::BinaryEngine< Derived >::right_outer_permtype_

protected

Initial value:

=

PermutationType::general

Right-hand permutation type.

Definition at line 92 of file binary_engine.h.

◆ shape_

template<typename Derived >

shape_type TiledArray::expressions::ExprEngine< Derived >::shape_

protected

The shape of the result tensor.

Definition at line 82 of file expr_engine.h.

◆ trange_

template<typename Derived >

trange_type TiledArray::expressions::ExprEngine< Derived >::trange_

protected

The tiled range of the result tensor.

Definition at line 81 of file expr_engine.h.

◆ world_

template<typename Derived >

World* TiledArray::expressions::ExprEngine< Derived >::world_

protected

The world where this expression will be evaluated.

Definition at line 73 of file expr_engine.h.

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

TiledArray/expressions/binary_engine.h

Documentation

template<typename Derived> class TiledArray::expressions::BinaryEngine< Derived >

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Member Typedef Documentation

◆ BinaryEngine_

◆ dist_eval_type

◆ ExprEngine_

◆ left_type

◆ op_type

◆ pmap_interface

◆ policy

◆ right_type

◆ shape_type

◆ size_type

◆ trange_type

◆ value_type

Constructor & Destructor Documentation

◆ BinaryEngine()

Member Function Documentation

◆ init_distribution()

◆ init_indices() [1/2]

◆ init_indices() [2/2]

◆ init_indices_()

◆ init_struct()

◆ make_dist_eval()

◆ make_trange() [1/2]

◆ make_trange() [2/2]

◆ perm_indices()

◆ print()

Member Data Documentation

◆ consumable

◆ indices_

◆ leaves

◆ left_

◆ left_indices_

◆ left_inner_permtype_

◆ left_outer_permtype_

◆ perm_

◆ permute_tiles_

◆ pmap_

◆ right_

◆ right_indices_

◆ right_inner_permtype_

◆ right_outer_permtype_

◆ shape_

◆ trange_

◆ world_

template<typename Derived>
class TiledArray::expressions::BinaryEngine< Derived >