TiledArray::expressions::UnaryEngine< Derived > Class Template Reference
Inheritance diagram for TiledArray::expressions::UnaryEngine< Derived >:
Collaboration diagram for TiledArray::expressions::UnaryEngine< Derived >:

Documentation

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

Definition at line 40 of file unary_engine.h.

Public Types

typedef UnaryEngine< Derived > UnaryEngine_
 This class type. More...
 
typedef ExprEngine< Derived > ExprEngine_
 Base class type. More...
 
typedef EngineTrait< Derived >::argument_type argument_type
 The argument expression engine 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 >
 UnaryEngine (const UnaryExpr< 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 ()
 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...
 
derived_typederived ()
 Cast this object to its derived type. More...
 
const derived_typederived () const
 Cast this object to its derived type. More...
 
const BipartiteIndexListindices () const
 Index list accessor. More...
 

Static Public Attributes

static constexpr bool consumable = true
 
static constexpr unsigned int leaves = argument_type::leaves
 

Protected Attributes

argument_type arg_
 The argument. 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_interfacepmap_
 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

◆ argument_type

template<typename Derived >
typedef EngineTrait<Derived>::argument_type TiledArray::expressions::UnaryEngine< Derived >::argument_type

The argument expression engine type.

Definition at line 48 of file unary_engine.h.

◆ dist_eval_type

template<typename Derived >
typedef EngineTrait<Derived>::dist_eval_type TiledArray::expressions::UnaryEngine< Derived >::dist_eval_type

The distributed evaluator type.

Definition at line 58 of file unary_engine.h.

◆ ExprEngine_

template<typename Derived >
typedef ExprEngine<Derived> TiledArray::expressions::UnaryEngine< Derived >::ExprEngine_

Base class type.

Definition at line 44 of file unary_engine.h.

◆ op_type

template<typename Derived >
typedef EngineTrait<Derived>::op_type TiledArray::expressions::UnaryEngine< Derived >::op_type

The tile operation type.

Definition at line 54 of file unary_engine.h.

◆ pmap_interface

template<typename Derived >
typedef EngineTrait<Derived>::pmap_interface TiledArray::expressions::UnaryEngine< Derived >::pmap_interface

Process map interface type.

Definition at line 66 of file unary_engine.h.

◆ policy

template<typename Derived >
typedef EngineTrait<Derived>::policy TiledArray::expressions::UnaryEngine< Derived >::policy

The result policy type.

Definition at line 56 of file unary_engine.h.

◆ shape_type

template<typename Derived >
typedef EngineTrait<Derived>::shape_type TiledArray::expressions::UnaryEngine< Derived >::shape_type

Shape type.

Definition at line 64 of file unary_engine.h.

◆ size_type

template<typename Derived >
typedef EngineTrait<Derived>::size_type TiledArray::expressions::UnaryEngine< Derived >::size_type

Size type.

Definition at line 61 of file unary_engine.h.

◆ trange_type

template<typename Derived >
typedef EngineTrait<Derived>::trange_type TiledArray::expressions::UnaryEngine< Derived >::trange_type

Tiled range type.

Definition at line 63 of file unary_engine.h.

◆ UnaryEngine_

template<typename Derived >
typedef UnaryEngine<Derived> TiledArray::expressions::UnaryEngine< Derived >::UnaryEngine_

This class type.

Definition at line 43 of file unary_engine.h.

◆ value_type

template<typename Derived >
typedef EngineTrait<Derived>::value_type TiledArray::expressions::UnaryEngine< Derived >::value_type

The result tile type.

Definition at line 52 of file unary_engine.h.

Constructor & Destructor Documentation

◆ UnaryEngine()

template<typename Derived >
template<typename D >
TiledArray::expressions::UnaryEngine< Derived >::UnaryEngine ( const UnaryExpr< D > &  expr)
inline

Definition at line 90 of file unary_engine.h.

Member Function Documentation

◆ derived() [1/2]

template<typename Derived >
derived_type& TiledArray::expressions::ExprEngine< Derived >::derived
inline

Cast this object to its derived type.

Definition at line 209 of file expr_engine.h.

◆ derived() [2/2]

template<typename Derived >
const derived_type& TiledArray::expressions::ExprEngine< Derived >::derived
inline

Cast this object to its derived type.

Definition at line 212 of file expr_engine.h.

◆ indices()

template<typename Derived >
const BipartiteIndexList& TiledArray::expressions::ExprEngine< Derived >::indices
inline

Index list accessor.

Returns
A const reference to the index list

Definition at line 224 of file expr_engine.h.

◆ init_distribution()

template<typename Derived >
void TiledArray::expressions::UnaryEngine< 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
worldThe world were the result will be distributed
pmapThe process map for the result tensor tiles

Definition at line 138 of file unary_engine.h.

Here is the call graph for this function:

◆ init_indices() [1/2]

template<typename Derived >
void TiledArray::expressions::UnaryEngine< Derived >::init_indices ( )
inline

Initialize the index list of this expression.

Definition at line 117 of file unary_engine.h.

◆ init_indices() [2/2]

template<typename Derived >
void TiledArray::expressions::UnaryEngine< Derived >::init_indices ( const BipartiteIndexList target_indices)
inline

Initialize the index list of this expression.

Parameters
target_indicesThe target index list for this expression

Definition at line 111 of file unary_engine.h.

Here is the call graph for this function:

◆ init_struct()

template<typename Derived >
void TiledArray::expressions::UnaryEngine< 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_indicesThe target index list for the result tensor

Definition at line 127 of file unary_engine.h.

Here is the call graph for this function:

◆ make_dist_eval()

template<typename Derived >
dist_eval_type TiledArray::expressions::UnaryEngine< 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 160 of file unary_engine.h.

Here is the call graph for this function:

◆ make_trange() [1/2]

template<typename Derived >
trange_type TiledArray::expressions::UnaryEngine< Derived >::make_trange ( ) const
inline

Non-permuting tiled range factory function.

Returns
The result tiled range

Definition at line 147 of file unary_engine.h.

◆ make_trange() [2/2]

template<typename Derived >
trange_type TiledArray::expressions::UnaryEngine< Derived >::make_trange ( const Permutation perm) const
inline

Permuting tiled range factory function.

Parameters
permThe permutation to be applied to the tiled range
Returns
The result shape

Definition at line 153 of file unary_engine.h.

Here is the call graph for this function:

◆ perm_indices()

template<typename Derived >
void TiledArray::expressions::UnaryEngine< 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.

Parameters
target_indicesThe target index list for this expression

Definition at line 101 of file unary_engine.h.

Here is the caller graph for this function:

◆ print()

template<typename Derived >
void TiledArray::expressions::UnaryEngine< Derived >::print ( ExprOStream  os,
const BipartiteIndexList target_indices 
) const
inline

Expression print.

Parameters
osThe output stream
target_indicesThe target index list for this expression

Definition at line 180 of file unary_engine.h.

Here is the call graph for this function:

Member Data Documentation

◆ arg_

template<typename Derived >
argument_type TiledArray::expressions::UnaryEngine< Derived >::arg_
protected

The argument.

Definition at line 81 of file unary_engine.h.

◆ consumable

template<typename Derived >
constexpr bool TiledArray::expressions::UnaryEngine< Derived >::consumable = true
staticconstexpr

Definition at line 68 of file unary_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::UnaryEngine< Derived >::leaves = argument_type::leaves
staticconstexpr

Definition at line 69 of file unary_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.

◆ 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: