TiledArray::detail::PermIndex Class Reference

Documentation

A functor that permutes ordinal indices.

The purpose of this functor is to allow fast, repeated permutations of ordinal indices.

Definition at line 38 of file perm_index.h.

Public Member Functions

 PermIndex ()
 Default constructor. More...
 
 PermIndex (const Range &range, const Permutation &perm)
 Construct permuting functor. More...
 
 PermIndex (const PermIndex &other)
 
 ~PermIndex ()
 
PermIndexoperator= (const PermIndex &other)
 
int dim () const
 Dimension accessor. More...
 
const std::size_t * data () const
 Data accessor. More...
 
std::size_t operator() (std::size_t index) const
 Compute the permuted index for the current block. More...
 
 operator bool () const
 

Constructor & Destructor Documentation

◆ PermIndex() [1/3]

TiledArray::detail::PermIndex::PermIndex ( )
inline

Default constructor.

Definition at line 46 of file perm_index.h.

◆ PermIndex() [2/3]

TiledArray::detail::PermIndex::PermIndex ( const Range range,
const Permutation perm 
)
inline

Construct permuting functor.

Parameters
rangeThe input range of ordinal indices

Definition at line 51 of file perm_index.h.

Here is the call graph for this function:

◆ PermIndex() [3/3]

TiledArray::detail::PermIndex::PermIndex ( const PermIndex other)
inline

Definition at line 90 of file perm_index.h.

◆ ~PermIndex()

TiledArray::detail::PermIndex::~PermIndex ( )
inline

Definition at line 102 of file perm_index.h.

Member Function Documentation

◆ data()

const std::size_t* TiledArray::detail::PermIndex::data ( ) const
inline

Data accessor.

Returns
A pointer to the result data

Definition at line 137 of file perm_index.h.

◆ dim()

int TiledArray::detail::PermIndex::dim ( ) const
inline

Dimension accessor.

Returns
The dimension of the indices that can be permuted

Definition at line 132 of file perm_index.h.

◆ operator bool()

TiledArray::detail::PermIndex::operator bool ( ) const
inline

Definition at line 162 of file perm_index.h.

◆ operator()()

std::size_t TiledArray::detail::PermIndex::operator() ( std::size_t  index) const
inline

Compute the permuted index for the current block.

Definition at line 140 of file perm_index.h.

◆ operator=()

PermIndex& TiledArray::detail::PermIndex::operator= ( const PermIndex other)
inline

Definition at line 107 of file perm_index.h.


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