PHX::Array< Scalar, array_order, void, void, void, void, void, void, void, void > Class Template Reference
[Mdarray_module]

The not-preferred multi-dimensional Array interface with runtime user-defined dimension ordinates. Typically used when runtime-polymorphic arrays are passed to functions. More...

#include <Phalanx_Array.hpp>

Collaboration diagram for PHX::Array< Scalar, array_order, void, void, void, void, void, void, void, void >:

[legend]List of all members.

Array Attributes
typedef Scalar	value_type
	Type of member data.
typedef unsigned	size_type
	Type for sizes.
typedef const ArrayDimTag *	tag_type
	Type of runtime dimension tags.
enum	{ Natural = NaturalOrder == array_order }
	If the multidimension follows the natural ordering.
enum	{ Reverse = FortranOrder == array_order }
	If the multidimension follows the reverse (Fortran) ordering.
enum	{ Contiguous = true }
	If the member data storage is contiguous.
unsigned	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.
tag_type	tag (const unsigned ordinal) const
	Access the dimension tag-singleton for a given ordinate.
unsigned	dimension (const unsigned ordinal) const
	Dimension of the given ordinate.
void	dimensions (std::vector< unsigned > &n)
	Dimension of all ordinate.
size_type	size () const
	Total number of data items.
Constructors and Assignment Operators
typedef ArrayReverse< Array >::type	ReverseType
	Array (const Array &rhs)
Array &	operator= (const Array &rhs)
	Array (const ReverseType &rhs)
	Copy constructor for reverse type.
Array &	operator= (const ReverseType &rhs)
	Assignment operator for reverse type.
template<ArrayOrder order, class Tag1, class Tag2, class Tag3, class Tag4, class Tag5, class Tag6, class Tag7, class Tag8>
	Array (const Array< value_type, order, Tag1, Tag2, Tag3, Tag4, Tag5, Tag6, Tag7, Tag8 > &rhs)
	Copy constructor from an Array with compile-time defined rank and dimension tags.
	Array (value_type *ptr, const unsigned rank, const unsigned *const dims, const tag_type *const tags)
Member data access operators
Array	truncate (const unsigned i) const
	Generate a subarray view of the array with the slowest striding ordinate offset by i and removed.
value_type *	contiguous_data () const
	Pointer to contiguous block of member data.
value_type &	operator[] (size_type i) const
	Access member via full ordering of members.
value_type &	operator() (const unsigned i1, const unsigned i2, const unsigned i3, const unsigned i4, const unsigned i5, const unsigned i6, const unsigned i7, const unsigned i8) const
	Access member via Rank 8 multi-index.
value_type &	operator() (const unsigned i1, const unsigned i2, const unsigned i3, const unsigned i4, const unsigned i5, const unsigned i6, const unsigned i7) const
value_type &	operator() (const unsigned i1, const unsigned i2, const unsigned i3, const unsigned i4, const unsigned i5, const unsigned i6) const
value_type &	operator() (const unsigned i1, const unsigned i2, const unsigned i3, const unsigned i4, const unsigned i5) const
value_type &	operator() (const unsigned i1, const unsigned i2, const unsigned i3, const unsigned i4) const
value_type &	operator() (const unsigned i1, const unsigned i2, const unsigned i3) const
value_type &	operator() (const unsigned i1, const unsigned i2) const
value_type &	operator() (const unsigned i1) const
Protected Attributes
value_type *	m_ptr
	Pointer to contiguous block of members.
unsigned	m_rank
	Rank of the array.
size_type	m_stride [8]
	Array of strides, smallest to largest.
tag_type	m_tag [8]
	Array of singleton tags, aligned with strides.
Friends
class	PHX::Array

---

Detailed Description

template<typename Scalar, ArrayOrder array_order>
class PHX::Array< Scalar, array_order, void, void, void, void, void, void, void, void >

The not-preferred multi-dimensional Array interface with runtime user-defined dimension ordinates. Typically used when runtime-polymorphic arrays are passed to functions.

Parameters:

	Scalar	The "plain old data" type of the array's member data.
	array_order	An ArrayOrder value that specifies whether to use Natural (a.k.a. C-language) or Fortran ordering for the multi-dimensions and multi-indices.

---

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

• Phalanx_Array.hpp

---