shards Version of the Day
Loading...
Searching...
No Matches
shards::Array< Scalar, RankZero, void, void, void, void, void, void, void, void > Class Template Reference

Specialization for an array with Rank = 0. More...

#include <Shards_Array.hpp>

Array Attributes

enum  { Rank = 0 }
 Rank of the array is the number of non-void dimension tags. More...
 
enum  { Natural = false }
 If the multidimension follows the natural ordering. More...
 
enum  { Reverse = false }
 If the multidimension follows the reverse (Fortran) ordering. More...
 
enum  { Contiguous = true }
 If the member data storage is contiguous. More...
 
typedef Scalar value_type
 Type of member data.
 
typedef array_traits::int_t size_type
 Type for sizes.
 
typedef const ArrayDimTagtag_type
 Type of runtime dimension tags.
 
size_type rank () const
 Rank of the array is the number of non-void dimension tags.
 
bool natural () const
 If the multidimension follows the natural ordering.
 
bool reverse () const
 If the multidimension follows the reverse (Fortran) ordering.
 
bool contiguous () const
 If the member data storage is contiguous.
 
size_type size () const
 Total number of member data items.
 

Member data access operators

value_typecontiguous_data () const
 Pointer to contiguous block of member data.
 
value_typeoperator() () const
 Access member via Rank 0 multi-index.
 

Constructors and Assignment Operators

 Array ()
 
 Array (const Array &rhs)
 
Arrayoperator= (const Array &rhs)
 
 Array (value_type *arg_ptr)
 

Detailed Description

template<typename Scalar>
class shards::Array< Scalar, RankZero, void, void, void, void, void, void, void, void >

Specialization for an array with Rank = 0.

Definition at line 4146 of file Shards_Array.hpp.

Member Typedef Documentation

◆ value_type

template<typename Scalar >
typedef Scalar shards::Array< Scalar, RankZero, void, void, void, void, void, void, void, void >::value_type

Type of member data.

Definition at line 4154 of file Shards_Array.hpp.

◆ size_type

template<typename Scalar >
typedef array_traits::int_t shards::Array< Scalar, RankZero, void, void, void, void, void, void, void, void >::size_type

Type for sizes.

Definition at line 4157 of file Shards_Array.hpp.

◆ tag_type

template<typename Scalar >
typedef const ArrayDimTag* shards::Array< Scalar, RankZero, void, void, void, void, void, void, void, void >::tag_type

Type of runtime dimension tags.

Definition at line 4160 of file Shards_Array.hpp.

Member Enumeration Documentation

◆ anonymous enum

template<typename Scalar >
anonymous enum

Rank of the array is the number of non-void dimension tags.

Definition at line 4165 of file Shards_Array.hpp.

◆ anonymous enum

template<typename Scalar >
anonymous enum

If the multidimension follows the natural ordering.

Definition at line 4168 of file Shards_Array.hpp.

◆ anonymous enum

template<typename Scalar >
anonymous enum

If the multidimension follows the reverse (Fortran) ordering.

Definition at line 4171 of file Shards_Array.hpp.

◆ anonymous enum

template<typename Scalar >
anonymous enum

If the member data storage is contiguous.

Definition at line 4174 of file Shards_Array.hpp.

Constructor & Destructor Documentation

◆ Array() [1/3]

template<typename Scalar >
shards::Array< Scalar, RankZero, void, void, void, void, void, void, void, void >::Array ( )
inline

Definition at line 4211 of file Shards_Array.hpp.

◆ Array() [2/3]

template<typename Scalar >
shards::Array< Scalar, RankZero, void, void, void, void, void, void, void, void >::Array ( const Array< Scalar, RankZero, void, void, void, void, void, void, void, void > &  rhs)
inline

Definition at line 4213 of file Shards_Array.hpp.

◆ Array() [3/3]

template<typename Scalar >
shards::Array< Scalar, RankZero, void, void, void, void, void, void, void, void >::Array ( value_type arg_ptr)
inline

Definition at line 4221 of file Shards_Array.hpp.

Member Function Documentation

◆ rank()

template<typename Scalar >
size_type shards::Array< Scalar, RankZero, void, void, void, void, void, void, void, void >::rank ( ) const
inline

Rank of the array is the number of non-void dimension tags.

Definition at line 4177 of file Shards_Array.hpp.

◆ natural()

template<typename Scalar >
bool shards::Array< Scalar, RankZero, void, void, void, void, void, void, void, void >::natural ( ) const
inline

If the multidimension follows the natural ordering.

Definition at line 4180 of file Shards_Array.hpp.

◆ reverse()

template<typename Scalar >
bool shards::Array< Scalar, RankZero, void, void, void, void, void, void, void, void >::reverse ( ) const
inline

If the multidimension follows the reverse (Fortran) ordering.

Definition at line 4183 of file Shards_Array.hpp.

◆ contiguous()

template<typename Scalar >
bool shards::Array< Scalar, RankZero, void, void, void, void, void, void, void, void >::contiguous ( ) const
inline

If the member data storage is contiguous.

Definition at line 4186 of file Shards_Array.hpp.

◆ size()

template<typename Scalar >
size_type shards::Array< Scalar, RankZero, void, void, void, void, void, void, void, void >::size ( ) const
inline

Total number of member data items.

Definition at line 4191 of file Shards_Array.hpp.

◆ contiguous_data()

template<typename Scalar >
value_type * shards::Array< Scalar, RankZero, void, void, void, void, void, void, void, void >::contiguous_data ( ) const
inline

Pointer to contiguous block of member data.

Definition at line 4200 of file Shards_Array.hpp.

◆ operator()()

template<typename Scalar >
value_type & shards::Array< Scalar, RankZero, void, void, void, void, void, void, void, void >::operator() ( ) const
inline

Access member via Rank 0 multi-index.

Definition at line 4203 of file Shards_Array.hpp.

◆ operator=()

template<typename Scalar >
Array & shards::Array< Scalar, RankZero, void, void, void, void, void, void, void, void >::operator= ( const Array< Scalar, RankZero, void, void, void, void, void, void, void, void > &  rhs)
inline

Definition at line 4215 of file Shards_Array.hpp.


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