SIRIUS 7.5.0
Electronic structure library and applications
Public Types | Public Member Functions | Private Attributes | List of all members
sirius::sddk::mdarray_index_descriptor Class Reference

Index descriptor of mdarray. More...

#include <memory.hpp>

Public Types

using index_type = int64_t
 

Public Member Functions

 mdarray_index_descriptor ()
 Constructor of empty descriptor. More...
 
 mdarray_index_descriptor (size_t const size__)
 Constructor for index range [0, size). More...
 
 mdarray_index_descriptor (index_type const begin__, index_type const end__)
 Constructor for index range [begin, end]. More...
 
 mdarray_index_descriptor (std::pair< int, int > const range__)
 Constructor for index range [begin, end]. More...
 
index_type begin () const
 Return first index value. More...
 
index_type end () const
 Return last index value. More...
 
size_t size () const
 Return index size. More...
 
bool check_range (index_type i__) const
 

Private Attributes

index_type begin_ {0}
 Beginning of index. More...
 
index_type end_ {-1}
 End of index. More...
 
size_t size_ {0}
 Size of index. More...
 

Detailed Description

Index descriptor of mdarray.

Definition at line 553 of file memory.hpp.

Member Typedef Documentation

◆ index_type

using sirius::sddk::mdarray_index_descriptor::index_type = int64_t

Definition at line 556 of file memory.hpp.

Constructor & Destructor Documentation

◆ mdarray_index_descriptor() [1/4]

sirius::sddk::mdarray_index_descriptor::mdarray_index_descriptor ( )
inline

Constructor of empty descriptor.

Definition at line 570 of file memory.hpp.

◆ mdarray_index_descriptor() [2/4]

sirius::sddk::mdarray_index_descriptor::mdarray_index_descriptor ( size_t const  size__)
inline

Constructor for index range [0, size).

Definition at line 575 of file memory.hpp.

◆ mdarray_index_descriptor() [3/4]

sirius::sddk::mdarray_index_descriptor::mdarray_index_descriptor ( index_type const  begin__,
index_type const  end__ 
)
inline

Constructor for index range [begin, end].

Definition at line 582 of file memory.hpp.

◆ mdarray_index_descriptor() [4/4]

sirius::sddk::mdarray_index_descriptor::mdarray_index_descriptor ( std::pair< int, int > const  range__)
inline

Constructor for index range [begin, end].

Definition at line 591 of file memory.hpp.

Member Function Documentation

◆ begin()

index_type sirius::sddk::mdarray_index_descriptor::begin ( ) const
inline

Return first index value.

Definition at line 600 of file memory.hpp.

◆ end()

index_type sirius::sddk::mdarray_index_descriptor::end ( ) const
inline

Return last index value.

Definition at line 606 of file memory.hpp.

◆ size()

size_t sirius::sddk::mdarray_index_descriptor::size ( ) const
inline

Return index size.

Definition at line 612 of file memory.hpp.

◆ check_range()

bool sirius::sddk::mdarray_index_descriptor::check_range ( index_type  i__) const
inline

Definition at line 617 of file memory.hpp.

Member Data Documentation

◆ begin_

index_type sirius::sddk::mdarray_index_descriptor::begin_ {0}
private

Beginning of index.

Definition at line 560 of file memory.hpp.

◆ end_

index_type sirius::sddk::mdarray_index_descriptor::end_ {-1}
private

End of index.

Definition at line 563 of file memory.hpp.

◆ size_

size_t sirius::sddk::mdarray_index_descriptor::size_ {0}
private

Size of index.

Definition at line 566 of file memory.hpp.


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