Provides a generic multidimensional array container. More...

#include </home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/feature-whitlock-mir_update/src/axom/core/Array.hpp>

Inheritance diagram for axom::Array< T, DIM, SPACE >:

[legend]

Public Types
using	value_type = T

using	ArrayIterator = ArrayIteratorBase< Array< T, DIM, SPACE >, T >

using	ConstArrayIterator = ArrayIteratorBase< const Array< T, DIM, SPACE >, const T >

using	ArrayViewType = ArrayView< T, DIM, SPACE >

using	ConstArrayViewType = ArrayView< const T, DIM, SPACE >

using	RealConstT = typename std::conditional< is_array_view, T, const T >::type

using	SliceType = typename std::conditional< DIM==IdxDim, T &, typename detail::SubsliceProxy< T, DIM - IdxDim, Array< T, 1, MemorySpace::Dynamic > >::type >::type

using	ConstSliceType = typename std::conditional< DIM==IdxDim, RealConstT &, typename detail::SubsliceProxy< T, DIM - IdxDim, const Array< T, 1, MemorySpace::Dynamic > >::type >::type

Public Member Functions
virtual	~Array ()

template<int LENGTH1D, typename TT = T, int TDIM = DIM>
AXOM_HOST_DEVICE std::enable_if< TDIM==1, axom::StackArray< TT, LENGTH1D > >::type	to_stack_array () const
	Convert 1D Array into a StackArray. More...

template<typename... Args>
AXOM_HOST_DEVICE void	emplace_back_device (Args &&... args)
	Inserts new element at the end of the Array. More...

template<typename... Args>
Array< T, DIM, SPACE >::ArrayIterator	emplace (Array< T, DIM, SPACE >::ArrayIterator pos, Args &&... args)

AXOM_HOST_DEVICE SliceType< sizeof...(Args)>	operator() (Args... args)
	Dimension-aware accessor; with N=DIM indices, returns a reference to the given value at that index. Otherwise, returns a sub-array pointed to by the given sub-index. More...

AXOM_HOST_DEVICE ConstSliceType< sizeof...(Args)>	operator() (Args... args) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...

AXOM_HOST_DEVICE SliceType< 1 >	operator[] (const IndexType idx)
	Scalar accessor; returns a sub-array referenced by the given sub- index, beginning at array(idx, 0...) More...

AXOM_HOST_DEVICE ConstSliceType< 1 >	operator[] (const IndexType idx) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...

AXOM_HOST_DEVICE SliceType< UDim >	operator[] (const StackArray< IndexType, UDim > &idx)
	Dimension-aware accessor; with UDim=DIM indices, returns a reference to the given value at that index. Otherwise, returns a sub-array pointed to by the given sub-index. More...

AXOM_HOST_DEVICE ConstSliceType< UDim >	operator[] (const StackArray< IndexType, UDim > &idx) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...

void	swap (ArrayBase &other)
	Swaps two ArrayBases. More...

AXOM_HOST_DEVICE const StackArray< IndexType, DIM > &	shape () const
	Returns the dimensions of the Array. More...

AXOM_HOST_DEVICE const MDMapping< DIM > &	mapping () const
	Returns the multidimensional mapping for the Array. More...

AXOM_HOST_DEVICE const StackArray< IndexType, DIM > &	strides () const
	Returns the memory strides of the Array. More...

AXOM_HOST_DEVICE IndexType	minStride () const
	Returns the minimum stride between adjacent items. More...

Native Storage Array Constructors
	Array ()
	Default constructor. Constructs an Array instance with no elements and default allocator ID. More...

template<IndexType SFINAE_DIM = DIM, MemorySpace SFINAE_SPACE = SPACE, typename std::enable_if< SFINAE_DIM==1 >::type * = nullptr>
	Array (IndexType num_elements, IndexType capacity=0, int allocator_id=axom::detail::getAllocatorID< SPACE >())
	Constructs a 1D Array instance with the given number of elements. More...

template<IndexType SFINAE_DIM = DIM, MemorySpace SFINAE_SPACE = SPACE, typename std::enable_if< SFINAE_DIM==1 >::type * = nullptr>
	Array (ArrayOptions::Uninitialized, IndexType num_elements, IndexType capacity=0, int allocator_id=axom::detail::getAllocatorID< SPACE >())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...

	Array (const axom::StackArray< axom::IndexType, DIM > &shape, int allocator_id=axom::detail::getAllocatorID< SPACE >())

	Array (const axom::StackArray< axom::IndexType, DIM > &shape, axom::ArrayStrideOrder rowOrColumn, int allocator_id=axom::detail::getAllocatorID< SPACE >())
	Construct Array with row- or column-major data ordering. More...

template<typename DirType = axom::IndexType>
	Array (const axom::StackArray< axom::IndexType, DIM > &shape, const axom::StackArray< DirType, DIM > &slowestDirs, int allocator_id=axom::detail::getAllocatorID< SPACE >())
	Construct Array with data ordering specifications. More...

template<typename... Args, typename Enable = typename std::enable_if< sizeof...(Args) == DIM && detail::all_types_are_integral<Args...>::value>::type>
	Array (Args... args)
	Generic constructor for an Array of arbitrary dimension. More...

template<typename... Args, typename Enable = typename std::enable_if< sizeof...(Args) == DIM && detail::all_types_are_integral<Args...>::value>::type>
	Array (ArrayOptions::Uninitialized, Args... args)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...

template<int UDIM = DIM, typename Enable = typename std::enable_if<UDIM == 1>::type>
	Array (std::initializer_list< T > elems, int allocator_id=axom::detail::getAllocatorID< SPACE >())
	Initializer list constructor for a one-dimensional Array. More...

AXOM_HOST_DEVICE	Array (const Array &other)
	Copy constructor for an Array instance. More...

	Array (Array &&other) noexcept
	Move constructor for an Array instance. More...

template<typename OtherArrayType >
	Array (const ArrayBase< T, DIM, OtherArrayType > &other)
	Constructor for transferring between memory spaces. More...

template<typename OtherArrayType >
	Array (const ArrayBase< const T, DIM, OtherArrayType > &other)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...

template<typename OtherArrayType >
	Array (const ArrayBase< T, DIM, OtherArrayType > &other, int allocator_id)
	Constructor for transferring between memory spaces, with a user- specified allocator. More...

template<typename OtherArrayType >
	Array (const ArrayBase< const T, DIM, OtherArrayType > &other, int allocator_id)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...

Array copy and move operators
Array &	operator= (const Array &other)
	Copy assignment operator for Array. More...

Array &	operator= (Array &&other) noexcept
	Move assignment operator for Array. More...

template<int UDIM = DIM, typename Enable = typename std::enable_if<UDIM == 1>::type>
Array &	operator= (std::initializer_list< T > elems)
	Initializer list assignment operator for Array. More...

Array element access operators
AXOM_HOST_DEVICE T *	data ()
	Return a pointer to the array of data. More...

AXOM_HOST_DEVICE const T *	data () const

Array methods to modify the data.
void	fill (const T &value)
	Set all the values of the array. More...

void	fill (const T &value, IndexType n, IndexType pos)
	Set a range of elements to a given value. More...

void	set (const T *elements, IndexType n, IndexType pos)
	Modify the values of existing elements. More...

void	clear ()
	Clears the contents of the array. More...

void	insert (IndexType pos, const T &value)
	Insert an element into the array at the given position. More...

ArrayIterator	insert (ArrayIterator pos, const T &value)
	Insert an element into the array at the value before pos. More...

void	insert (IndexType pos, IndexType n, const T *values)
	Insert elements into the array at the given position. More...

ArrayIterator	insert (ArrayIterator pos, IndexType n, const T *values)
	Insert elements into the array at the value before pos. More...

void	insert (IndexType pos, IndexType n, const T &value)
	Insert n copies of element into the array at the given position. More...

ArrayIterator	insert (ArrayIterator pos, IndexType n, const T &value)
	Insert n copies of element into the array at the value before pos. More...

template<MemorySpace OtherSpace>
void	insert (IndexType pos, ArrayView< const T, DIM, OtherSpace > other)
	Inserts an Array to the end of the calling object. More...

template<MemorySpace OtherSpace>
void	insert (IndexType pos, ArrayView< T, DIM, OtherSpace > other)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...

template<MemorySpace OtherSpace>
void	append (ArrayView< const T, DIM, OtherSpace > other)
	Appends an Array to the end of the calling object. More...

template<MemorySpace OtherSpace>
void	append (ArrayView< T, DIM, OtherSpace > other)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...

ArrayIterator	erase (ArrayIterator pos)
	Erases an element from the Array. More...

ArrayIterator	erase (ArrayIterator first, ArrayIterator last)
	Erases elements in the range [first, last) from the Array. More...

template<typename... Args>
void	emplace (IndexType pos, Args &&... args)
	Inserts new element into Array at the given position. More...

template<typename... Args>
ArrayIterator	emplace (ArrayIterator pos, Args &&... args)
	Inserts new element into Array before pos. More...

void	push_back (const T &value)
	Push a value to the back of the array. More...

void	push_back (T &&value)
	Push a value to the back of the array. More...

template<typename... Args>
void	emplace_back (Args &&... args)
	Inserts new element at the end of the Array. More...

AXOM_HOST_DEVICE void	push_back_device (const T &value)
	Push a value to the back of the array. More...

AXOM_HOST_DEVICE void	push_back_device (T &&value)

Array methods to query and set attributes
IndexType	capacity () const
	Return the number of elements allocated for the data array. More...

void	reserve (IndexType capacity)
	Increase the capacity. Does nothing if the new capacity is less than the current capacity. More...

ArrayIterator	begin ()
	Returns an ArrayIterator to the first element of the Array. More...

ConstArrayIterator	begin () const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...

ArrayIterator	end ()
	Returns an ArrayIterator to the element following the last element of the Array. More...

ConstArrayIterator	end () const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...

T &	front ()
	Returns a reference to the first element in the Array. More...

const T &	front () const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...

T &	back ()
	Returns a reference to the last element in the Array. More...

const T &	back () const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...

void	shrink ()
	Shrink the capacity to be equal to the size. More...

AXOM_HOST_DEVICE bool	empty () const
	Returns true iff the Array stores no elements. More...

AXOM_HOST_DEVICE IndexType	size () const
	Return the number of elements stored in the data array. More...

template<typename... Args, typename Enable = typename std::enable_if< sizeof...(Args) == DIM && detail::all_types_are_integral<Args...>::value>::type>
void	resize (Args... args)
	Update the number of elements stored in the data array. More...

template<typename... Args, typename Enable = typename std::enable_if< sizeof...(Args) == DIM && detail::all_types_are_integral<Args...>::value>::type>
void	resize (ArrayOptions::Uninitialized, Args... args)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...

template<int Dims = DIM, typename Enable = std::enable_if_t<Dims == 1>>
void	resize (IndexType size, const T &value)

void	resize (const StackArray< IndexType, DIM > &size, const T &value)

void	swap (Array< T, DIM, SPACE > &other)
	Exchanges the contents of this Array with the other. More...

double	getResizeRatio () const
	Get the ratio by which the capacity increases upon dynamic resize. More...

void	setResizeRatio (double ratio)
	Set the ratio by which the capacity increases upon dynamic resize. More...

AXOM_HOST_DEVICE int	getAllocatorID () const
	Get the ID for the umpire allocator. More...

void	setDevicePreference (bool on_device)
	Sets the preferred space where operations on this array should be performed. More...

ArrayViewType	view ()
	Returns a view of the array. More...

ConstArrayViewType	view () const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...


AXOM_HOST_DEVICE T &	flatIndex (const IndexType idx)
	Accessor, returns a reference to the given value. For multidimensional arrays, indexes into the (flat) raw data. More...

AXOM_HOST_DEVICE RealConstT &	flatIndex (const IndexType idx) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...

Static Public Attributes
static constexpr double	DEFAULT_RESIZE_RATIO = 2.0

static constexpr IndexType	MIN_DEFAULT_CAPACITY = 32

static constexpr MemorySpace	space = SPACE

constexpr static int	Dims

Protected Member Functions
void	initialize (IndexType num_elements, IndexType capacity, bool should_default_construct=true)
	Initialize an Array instance with the given number of elements. More...

void	initialize_from_other (const T *data, IndexType num_elements, MemorySpace data_space, bool user_provided_allocator)
	Helper function for initializing an Array instance with an existing range of elements. More...

void	resizeImpl (const StackArray< IndexType, DIM > &dims, bool construct_with_values, const T *value=nullptr)
	Updates the number of elements stored in the data array. More...

T *	reserveForInsert (IndexType n, IndexType pos)
	Make space for a subsequent insertion into the array. More...

AXOM_DEVICE IndexType	reserveForDeviceInsert (IndexType n)
	Make space for a subsequent insertion into the array. More...

virtual void	updateNumElements (IndexType new_num_elements)
	Update the number of elements. More...

virtual void	setCapacity (IndexType new_capacity)
	Set the number of elements allocated for the data array. More...

virtual void	dynamicRealloc (IndexType new_num_elements)
	Reallocates the data array when the size exceeds the capacity. More...

AXOM_HOST_DEVICE void	setShape (const StackArray< IndexType, DIM > &shape_)
	Set the shape. More...

AXOM_SUPPRESS_HD_WARN AXOM_HOST_DEVICE void	setShapeAndStride (const StackArray< IndexType, DIM > &shape, const StackArray< IndexType, DIM > &stride)
	Set the shape and stride. More...

IndexType	blockSize () const
	Returns the minimum "chunk size" that should be allocated For example, 2 would be the chunk size of a 2D array whose second dimension is of size 2. This is used when resizing/reallocating; it wouldn't make sense to have a capacity of 3 in the array described above. More...

AXOM_HOST_DEVICE void	updateStrides (int min_stride=1)
	Updates the internal striding information to a row-major format Intended to be called after shape is updated. More...

void	updateShapeOnInsert (const StackArray< IndexType, DIM > &range_shape)
	Updates the internal dimensions and striding based on the insertion of a range of elements. Intended to be called after the insertion of a multidimensional subslice. More...

Protected Attributes
T *	m_data = nullptr

IndexType	m_num_elements = 0
	The full number of elements in the array i.e., 3 for a 1D Array of size 3, 9 for a 3x3 2D array, etc. More...

IndexType	m_capacity = 0

double	m_resize_ratio = DEFAULT_RESIZE_RATIO

int	m_allocator_id = INVALID_ALLOCATOR_ID

bool	m_executeOnGPU = false

StackArray< IndexType, DIM >	m_shape
	The extent in each direction. More...

MDMapping< DIM >	m_mapping
	For converting between multidim indices and offset. More...

IndexType	m_minStride
	Cached value for optimization. More...

Detailed Description

template<typename T, int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>
class axom::Array< T, DIM, SPACE >

Provides a generic multidimensional array container.

The Array class provides a generic multidimensional array container with dynamic reallocation and insertion. The dimensionality of the array must be known at compile time but the extents in each dimension are dynamic and can be changed at runtime. Array elements are stored contiguously.

Note: For a multi-component array container, where each element is a tuple of 1 or more components, Axom provides the MCArray alias, which corresponds to Array<T, 2>.

The Array class mirrors std::vector, with future support for GPUs in-development. The class's multidimensional array functionality roughly mirrors the multidimensional array support provided by numpy's ndarray.

See also: https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html

Some interfaces accomodate data ordering specifications. Unless otherwise specified, data storage defaults to row-major.

This class is meant to be a drop-in replacement for std::vector. However, it differs in its memory management and construction semantics. Specifically, we do not require axom::Array to initialize/construct its memory at allocation time and we use axom's memory_management and allocator ID abstractions rather than std::allocator.

Array always retains exclusive ownership of its data and is responsible for freeing its memory.

See also: ArrayView for non-owning views of one- or multi-dimensional data Depending on which constructor is used, the Array object can have two different underlying storage types:

Template Parameters

T	the type of the values to hold.
DIM	The dimension of the array.
SPACE	The memory space of the array.

Precondition: T must be CopyAssignable and Erasable

See also: https://en.cppreference.com/w/cpp/named_req

Precondition: When Array is allocated on the device, T must be relocatable, i.e. moving the object to a new index and destroying the original should be equivalent to a memcpy.

See also: https://github.com/facebook/folly/blob/main/folly/docs/FBVector.md#object-relocation

Member Typedef Documentation

◆ value_type

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

using axom::Array< T, DIM, SPACE >::value_type = T

◆ ArrayIterator

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

using axom::Array< T, DIM, SPACE >::ArrayIterator = ArrayIteratorBase<Array<T, DIM, SPACE>, T>

◆ ConstArrayIterator

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

using axom::Array< T, DIM, SPACE >::ConstArrayIterator = ArrayIteratorBase<const Array<T, DIM, SPACE>, const T>

◆ ArrayViewType

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

using axom::Array< T, DIM, SPACE >::ArrayViewType = ArrayView<T, DIM, SPACE>

◆ ConstArrayViewType

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

using axom::Array< T, DIM, SPACE >::ConstArrayViewType = ArrayView<const T, DIM, SPACE>

◆ RealConstT

using axom::ArrayBase< T, DIM, Array< T, 1, MemorySpace::Dynamic > >::RealConstT = typename std::conditional<is_array_view, T, const T>::type

inherited

◆ SliceType

using axom::ArrayBase< T, DIM, Array< T, 1, MemorySpace::Dynamic > >::SliceType = typename std::conditional< DIM == IdxDim, T&, typename detail::SubsliceProxy<T, DIM - IdxDim, Array< T, 1, MemorySpace::Dynamic > >::type>::type

inherited

◆ ConstSliceType

using axom::ArrayBase< T, DIM, Array< T, 1, MemorySpace::Dynamic > >::ConstSliceType = typename std::conditional< DIM == IdxDim, RealConstT&, typename detail::SubsliceProxy<T, DIM - IdxDim, const Array< T, 1, MemorySpace::Dynamic > >::type>::type

inherited

Constructor & Destructor Documentation

◆ Array() [1/15]

template<typename T , int DIM, MemorySpace SPACE>

axom::Array< T, DIM, SPACE >::Array

Default constructor. Constructs an Array instance with no elements and default allocator ID.

◆ Array() [2/15]

template<typename T , int DIM, MemorySpace SPACE>

template<IndexType SFINAE_DIM, MemorySpace SFINAE_SPACE, typename std::enable_if< SFINAE_DIM==1 >::type * >

axom::Array< T, DIM, SPACE >::Array	(	IndexType	num_elements,
		IndexType	capacity = `0`,
		int	allocator_id = `axom::detail::getAllocatorID<SPACE>()`
	)

Constructs a 1D Array instance with the given number of elements.

Parameters

[in]	num_elements	the number of elements the Array holds.
[in]	capacity	the number of elements to allocate space for.
[in]	allocator_id	the ID of the allocator to use (optional)

Note: If no capacity or capacity less than num_elements is specified then it will default to at least num_elements * DEFAULT_RESIZE_RATIO.; a capacity is specified for the number of elements to store in the array and does not correspond to the actual bytesize.; The option to select a capacity is only available for 1-dimensional Arrays; Some overloads have an ArrayOptions::Uninitialized first parameter. These are intended for cases where the array data should not be initialized when memory is allocated, e.g. if the code is known to initialize the data

Precondition: num_elements >= 0

Postcondition: capacity() >= size(); size() == num_elements; getResizeRatio() == DEFAULT_RESIZE_RATIO

References axom::Array< T, DIM, SPACE >::capacity(), axom::Dynamic, axom::detail::getAllocatorSpace(), axom::Array< T, DIM, SPACE >::initialize(), and axom::Array< T, DIM, SPACE >::m_allocator_id.

◆ Array() [3/15]

template<typename T , int DIM, MemorySpace SPACE>

template<IndexType SFINAE_DIM, MemorySpace SFINAE_SPACE, typename std::enable_if< SFINAE_DIM==1 >::type * >

axom::Array< T, DIM, SPACE >::Array	(	ArrayOptions::Uninitialized	,
		IndexType	num_elements,
		IndexType	capacity = `0`,
		int	allocator_id = `axom::detail::getAllocatorID<SPACE>()`
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

References axom::Array< T, DIM, SPACE >::capacity(), axom::Dynamic, axom::detail::getAllocatorSpace(), axom::Array< T, DIM, SPACE >::initialize(), and axom::Array< T, DIM, SPACE >::m_allocator_id.

◆ Array() [4/15]

template<typename T , int DIM, MemorySpace SPACE>

axom::Array< T, DIM, SPACE >::Array	(	const axom::StackArray< axom::IndexType, DIM > &	shape,
		int	allocator_id = `axom::detail::getAllocatorID<SPACE>()`
	)

References axom::Array< T, DIM, SPACE >::initialize(), axom::StackArray< T, N >::m_data, axom::detail::packProduct(), and axom::ArrayBase< T, 1, Array< T, 1, MemorySpace::Dynamic > >::shape().

◆ Array() [5/15]

template<typename T , int DIM, MemorySpace SPACE>

axom::Array< T, DIM, SPACE >::Array	(	const axom::StackArray< axom::IndexType, DIM > &	shape,
		axom::ArrayStrideOrder	rowOrColumn,
		int	allocator_id = `axom::detail::getAllocatorID<SPACE>()`
	)

Construct Array with row- or column-major data ordering.

Precondition: rowOrColumn must be either ArrayStrideOrder::ROW or ArrayStrideOrder::COLUMN (or, if DIM is 1, ArrayStrideOrder::BOTH).

References axom::ArrayBase< T, 1, Array< T, 1, MemorySpace::Dynamic > >::shape().

◆ Array() [6/15]

template<typename T , int DIM, MemorySpace SPACE>

template<typename DirType >

axom::Array< T, DIM, SPACE >::Array	(	const axom::StackArray< axom::IndexType, DIM > &	shape,
		const axom::StackArray< DirType, DIM > &	slowestDirs,
		int	allocator_id = `axom::detail::getAllocatorID<SPACE>()`
	)

Construct Array with data ordering specifications.

Example of 3D Array where j is slowest and i is fastest: Array<3, int> ar( shape, axom::StackArray<axom::IndexType, DIM>{2, 0, 1});

Precondition: slowestDirs must be a permutation of [0 ... DIM-1]

References axom::ArrayBase< T, 1, Array< T, 1, MemorySpace::Dynamic > >::shape().

◆ Array() [7/15]

template<typename T , int DIM, MemorySpace SPACE>

template<typename... Args, typename Enable >

axom::Array< T, DIM, SPACE >::Array ( Args... args )

Generic constructor for an Array of arbitrary dimension.

Parameters

[in] args The parameter pack containing the "shape" of the Array

See also: https://numpy.org/doc/stable/reference/generated/numpy.empty.html#numpy.empty

Precondition: sizeof...(Args) == DIM

Postcondition: capacity() >= size(); size() == num_elements; getResizeRatio() == DEFAULT_RESIZE_RATIO

◆ Array() [8/15]

template<typename T , int DIM, MemorySpace SPACE>

template<typename... Args, typename Enable >

axom::Array< T, DIM, SPACE >::Array	(	ArrayOptions::Uninitialized	,
		Args...	args
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ Array() [9/15]

template<typename T , int DIM, MemorySpace SPACE>

template<int UDIM, typename Enable >

axom::Array< T, DIM, SPACE >::Array	(	std::initializer_list< T >	elems,
		int	allocator_id = `axom::detail::getAllocatorID<SPACE>()`
	)

Initializer list constructor for a one-dimensional Array.

Parameters

[in]	elems	The elements to initialize the array with
[in]	allocator_id	the ID of the allocator to use (optional)

References axom::Dynamic, and axom::Array< T, DIM, SPACE >::initialize_from_other().

◆ Array() [10/15]

template<typename T , int DIM, MemorySpace SPACE>

AXOM_HOST_DEVICE axom::Array< T, DIM, SPACE >::Array ( const Array< T, DIM, SPACE > & other )

Copy constructor for an Array instance.

References axom::Array< T, DIM, SPACE >::capacity(), axom::Array< T, DIM, SPACE >::data(), axom::Dynamic, axom::detail::getAllocatorSpace(), axom::isDeviceAllocator(), axom::Array< T, DIM, SPACE >::m_allocator_id, axom::Array< T, DIM, SPACE >::m_data, axom::Array< T, DIM, SPACE >::m_executeOnGPU, axom::Array< T, DIM, SPACE >::setCapacity(), axom::Array< T, DIM, SPACE >::size(), and axom::Array< T, DIM, SPACE >::updateNumElements().

◆ Array() [11/15]

template<typename T , int DIM, MemorySpace SPACE>

axom::Array< T, DIM, SPACE >::Array ( Array< T, DIM, SPACE > && other )

noexcept

Move constructor for an Array instance.

References axom::INVALID_ALLOCATOR_ID, and axom::isDeviceAllocator().

◆ Array() [12/15]

template<typename T , int DIM, MemorySpace SPACE>

template<typename OtherArrayType >

axom::Array< T, DIM, SPACE >::Array ( const ArrayBase< T, DIM, OtherArrayType > & other )

Constructor for transferring between memory spaces.

Parameters

[in] other The array in a different memory space to copy from

Note: The new Array will be constructed with the allocator ID of the copied-from array, if compatible with the memory space of the target array. Otherwise, the new Array will be constructed with the default allocator for the memory space.

An Array specified with the default Dynamic memory space will always propagate the allocator ID from the source array.

References axom::Array< T, DIM, SPACE >::data(), axom::detail::getAllocatorSpace(), axom::Array< T, DIM, SPACE >::initialize_from_other(), axom::Array< T, DIM, SPACE >::m_allocator_id, and axom::Array< T, DIM, SPACE >::size().

◆ Array() [13/15]

template<typename T , int DIM, MemorySpace SPACE>

template<typename OtherArrayType >

axom::Array< T, DIM, SPACE >::Array ( const ArrayBase< const T, DIM, OtherArrayType > & other )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

References axom::Array< T, DIM, SPACE >::data(), axom::detail::getAllocatorSpace(), axom::Array< T, DIM, SPACE >::initialize_from_other(), axom::Array< T, DIM, SPACE >::m_allocator_id, and axom::Array< T, DIM, SPACE >::size().

◆ Array() [14/15]

template<typename T , int DIM, MemorySpace SPACE>

template<typename OtherArrayType >

axom::Array< T, DIM, SPACE >::Array	(	const ArrayBase< T, DIM, OtherArrayType > &	other,
		int	allocator_id
	)

Constructor for transferring between memory spaces, with a user- specified allocator.

Parameters

[in]	other	The array in a different memory space to copy from
[in]	allocator_id	the ID of the allocator to use

Note: The specified allocator ID must be compatible with the memory space of the new Array.

References axom::Array< T, DIM, SPACE >::data(), axom::Array< T, DIM, SPACE >::getAllocatorID(), axom::detail::getAllocatorSpace(), axom::Array< T, DIM, SPACE >::initialize_from_other(), and axom::Array< T, DIM, SPACE >::size().

◆ Array() [15/15]

template<typename T , int DIM, MemorySpace SPACE>

template<typename OtherArrayType >

axom::Array< T, DIM, SPACE >::Array	(	const ArrayBase< const T, DIM, OtherArrayType > &	other,
		int	allocator_id
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

References axom::Array< T, DIM, SPACE >::data(), axom::Array< T, DIM, SPACE >::getAllocatorID(), axom::detail::getAllocatorSpace(), axom::Array< T, DIM, SPACE >::initialize_from_other(), and axom::Array< T, DIM, SPACE >::size().

◆ ~Array()

template<typename T , int DIM, MemorySpace SPACE>

axom::Array< T, DIM, SPACE >::~Array

virtual

Destructor. Frees the associated buffer.

Reimplemented in axom::sidre::Array< T, DIM >.

References axom::deallocate().

Member Function Documentation

◆ operator=() [1/3]

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

Array& axom::Array< T, DIM, SPACE >::operator= ( const Array< T, DIM, SPACE > & other )

inline

Copy assignment operator for Array.

Precondition: T must be TriviallyCopyable

◆ operator=() [2/3]

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

Array& axom::Array< T, DIM, SPACE >::operator= ( Array< T, DIM, SPACE > && other )

inlinenoexcept

Move assignment operator for Array.

References axom::Array< T, DIM, SPACE >::clear(), axom::deallocate(), axom::Array< T, DIM, SPACE >::DEFAULT_RESIZE_RATIO, axom::INVALID_ALLOCATOR_ID, axom::isDeviceAllocator(), axom::Array< T, DIM, SPACE >::m_allocator_id, axom::Array< T, DIM, SPACE >::m_capacity, axom::Array< T, DIM, SPACE >::m_data, axom::Array< T, DIM, SPACE >::m_executeOnGPU, axom::Array< T, DIM, SPACE >::m_num_elements, and axom::Array< T, DIM, SPACE >::m_resize_ratio.

◆ operator=() [3/3]

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

template<int UDIM = DIM, typename Enable = typename std::enable_if<UDIM == 1>::type>

Array& axom::Array< T, DIM, SPACE >::operator= ( std::initializer_list< T > elems )

inline

Initializer list assignment operator for Array.

Parameters

[in] elems the elements to set the array to.

References axom::Array< T, DIM, SPACE >::clear(), and axom::Array< T, DIM, SPACE >::insert().

◆ data() [1/2]

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

AXOM_HOST_DEVICE T* axom::Array< T, DIM, SPACE >::data ( )

inline

Return a pointer to the array of data.

References axom::Array< T, DIM, SPACE >::m_data.

◆ data() [2/2]

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

AXOM_HOST_DEVICE const T* axom::Array< T, DIM, SPACE >::data ( ) const

inline

References axom::Array< T, DIM, SPACE >::m_data.

◆ to_stack_array()

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

template<int LENGTH1D, typename TT = T, int TDIM = DIM>

AXOM_HOST_DEVICE std::enable_if<TDIM == 1, axom::StackArray<TT, LENGTH1D> >::type axom::Array< T, DIM, SPACE >::to_stack_array ( ) const

inline

Convert 1D Array into a StackArray.

References axom::Array< T, DIM, SPACE >::m_data, and axom::Array< T, DIM, SPACE >::m_num_elements.

◆ fill() [1/2]

template<typename T , int DIM, MemorySpace SPACE>

void axom::Array< T, DIM, SPACE >::fill ( const T & value )

inline

Set all the values of the array.

Parameters

[in] value the value to set to.

◆ fill() [2/2]

template<typename T , int DIM, MemorySpace SPACE>

void axom::Array< T, DIM, SPACE >::fill	(	const T &	value,
		IndexType	n,
		IndexType	pos
	)

inline

Set a range of elements to a given value.

Parameters

[in]	value	the value to set to.
[in]	n	the number of elements to write.
[in]	pos	the position at which to begin writing.

Note: The size is unchanged by calls to fill.

Precondition: pos + n <= m_num_elements.

◆ set()

template<typename T , int DIM, MemorySpace SPACE>

void axom::Array< T, DIM, SPACE >::set	(	const T *	elements,
		IndexType	n,
		IndexType	pos
	)

inline

Modify the values of existing elements.

Parameters

[in]	elements	the new elements to write.
[in]	n	the number of elements to write.
[in]	pos	the position at which to begin writing.

Note: It's assumed that elements is of length n.; The size is unchanged by calls to set.

Precondition: pos + n <= m_num_elements.

References axom::Dynamic.

◆ clear()

template<typename T , int DIM, MemorySpace SPACE>

void axom::Array< T, DIM, SPACE >::clear

inline

Clears the contents of the array.

Postcondition: size of Array is 0; capacity is unchanged

◆ insert() [1/8]

template<typename T , int DIM, MemorySpace SPACE>

void axom::Array< T, DIM, SPACE >::insert	(	IndexType	pos,
		const T &	value
	)

inline

Insert an element into the array at the given position.

Parameters

[in]	pos	the position at which to insert.
[in]	value	the element value to insert.

Note: Reallocation is done if the new size will exceed the capacity.; The size increases by 1.

◆ insert() [2/8]

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

ArrayIterator axom::Array< T, DIM, SPACE >::insert	(	ArrayIterator	pos,
		const T &	value
	)

Insert an element into the array at the value before pos.

Parameters

[in]	pos	the ArrayIterator before which value will be inserted.
[in]	value	the element value to insert.

Note: Reallocation is done if the new size will exceed the capacity.; The size increases by 1.

Returns: ArrayIterator to inserted value

◆ insert() [3/8]

template<typename T , int DIM, MemorySpace SPACE>

void axom::Array< T, DIM, SPACE >::insert	(	IndexType	pos,
		IndexType	n,
		const T *	values
	)

inline

Insert elements into the array at the given position.

Parameters

[in]	pos	the position at which to begin the insertion.
[in]	n	the number of elements to insert.
[in]	values	the element values to insert.

Note: It's assumed that elements is of length n.; Reallocation is done if the new size will exceed the capacity.; The size increases by n.

Precondition: pos <= m_num_elements.

References axom::Dynamic.

◆ insert() [4/8]

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

ArrayIterator axom::Array< T, DIM, SPACE >::insert	(	ArrayIterator	pos,
		IndexType	n,
		const T *	values
	)

Insert elements into the array at the value before pos.

Parameters

[in]	pos	the ArrayIterator before which value will be inserted.
[in]	n	the number of elements to insert.
[in]	values	the element values to insert.

Note: It's assumed that elements is of length n.; Reallocation is done if the new size will exceed the capacity.; The size increases by n.

Precondition: pos <= end()

Returns: ArrayIterator to first element inserted (pos if n == 0)

◆ insert() [5/8]

template<typename T , int DIM, MemorySpace SPACE>

void axom::Array< T, DIM, SPACE >::insert	(	IndexType	pos,
		IndexType	n,
		const T &	value
	)

inline

Insert n copies of element into the array at the given position.

Parameters

[in]	pos	the position at which to begin the insertion.
[in]	n	the number of elements to insert.
[in]	value	the element value to insert.

Note: Reallocation is done if the new size will exceed the capacity.; The size increases by n.; This method is used to create space for elements in the middle of the array.

Precondition: pos <= m_num_elements.

◆ insert() [6/8]

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

ArrayIterator axom::Array< T, DIM, SPACE >::insert	(	ArrayIterator	pos,
		IndexType	n,
		const T &	value
	)

Insert n copies of element into the array at the value before pos.

Parameters

[in]	pos	the ArrayIterator before which value will be inserted.
[in]	n	the number of elements to insert.
[in]	value	the element value to insert.

Note: Reallocation is done if the new size will exceed the capacity.; The size increases by n.; This method is used to create space for elements in the middle of the array.

Precondition: pos <= end()

Returns: ArrayIterator to first element inserted (pos if n == 0)

◆ insert() [7/8]

template<typename T , int DIM, MemorySpace SPACE>

template<MemorySpace OtherSpace>

void axom::Array< T, DIM, SPACE >::insert	(	IndexType	pos,
		ArrayView< const T, DIM, OtherSpace >	other
	)

inline

Inserts an Array to the end of the calling object.

Parameters

[in] other The Array to append

Precondition: The shapes of the calling Array and other are the same (excluding the leading dimension), i.e., shape()[1:] == other.shape()[1:]

Note: Reallocation is done if the new size will exceed the capacity.

References axom::ArrayView< T, DIM, SPACE >::data(), axom::ArrayBase< T, DIM, ArrayType >::shape(), and axom::ArrayView< T, DIM, SPACE >::size().

◆ insert() [8/8]

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

template<MemorySpace OtherSpace>

void axom::Array< T, DIM, SPACE >::insert	(	IndexType	pos,
		ArrayView< T, DIM, OtherSpace >	other
	)

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

References axom::Array< T, DIM, SPACE >::insert().

◆ append() [1/2]

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

template<MemorySpace OtherSpace>

void axom::Array< T, DIM, SPACE >::append ( ArrayView< const T, DIM, OtherSpace > other )

inline

Appends an Array to the end of the calling object.

Parameters

[in] other The Array to append

Template Parameters

OtherArrayType The underlying type of the other array

Note: Reallocation is done if the new size will exceed the capacity.

References axom::Array< T, DIM, SPACE >::insert(), and axom::Array< T, DIM, SPACE >::size().

◆ append() [2/2]

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

template<MemorySpace OtherSpace>

void axom::Array< T, DIM, SPACE >::append ( ArrayView< T, DIM, OtherSpace > other )

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

References axom::Array< T, DIM, SPACE >::insert(), and axom::Array< T, DIM, SPACE >::size().

◆ erase() [1/2]

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

ArrayIterator axom::Array< T, DIM, SPACE >::erase ( ArrayIterator pos )

Erases an element from the Array.

Parameters

[in] pos the ArrayIterator to the element in the Array

Returns: An ArrayIterator following the last element removed.

◆ erase() [2/2]

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

ArrayIterator axom::Array< T, DIM, SPACE >::erase	(	ArrayIterator	first,
		ArrayIterator	last
	)

Erases elements in the range [first, last) from the Array.

Parameters

[in]	first	the ArrayIterator to the beginning of the range.
[in]	last	the ArrayIterator to end of range.

Returns: An ArrayIterator following the last element removed.

◆ emplace() [1/3]

template<typename T , int DIM, MemorySpace SPACE>

template<typename... Args>

void axom::Array< T, DIM, SPACE >::emplace	(	IndexType	pos,
		Args &&...	args
	)

inline

Inserts new element into Array at the given position.

Parameters

[in]	pos	the position to insert element at.
[in]	args	the arguments to forward to constructor of the element.

Note: Reallocation is done if the new size will exceed the capacity.; The size increases by 1.

Precondition: T must be MoveAssignable

◆ emplace() [2/3]

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

template<typename... Args>

ArrayIterator axom::Array< T, DIM, SPACE >::emplace	(	ArrayIterator	pos,
		Args &&...	args
	)

Inserts new element into Array before pos.

Parameters

[in]	pos	the ArrayIterator to insert element before.
[in]	args	the arguments to forward to constructor of the element.

Note: Reallocation is done if the new size will exceed the capacity.; The size increases by 1.

Precondition: T must be MoveAssignable

Returns: An ArrayIterator to the emplaced element.

◆ push_back() [1/2]

template<typename T , int DIM, MemorySpace SPACE>

void axom::Array< T, DIM, SPACE >::push_back ( const T & value )

inline

Push a value to the back of the array.

Parameters

[in] value the value to be added to the back.

Note: Reallocation is done if the new size will exceed the capacity.

Precondition: DIM == 1

◆ push_back() [2/2]

template<typename T , int DIM, MemorySpace SPACE>

void axom::Array< T, DIM, SPACE >::push_back ( T && value )

inline

Push a value to the back of the array.

Parameters

[in] value the value to move to the back.

Note: Reallocation is done if the new size will exceed the capacity.

Precondition: DIM == 1

◆ emplace_back()

template<typename T , int DIM, MemorySpace SPACE>

template<typename... Args>

void axom::Array< T, DIM, SPACE >::emplace_back ( Args &&... args )

inline

Inserts new element at the end of the Array.

Parameters

[in] args the arguments to forward to constructor of the element.

Note: Reallocation is done if the new size will exceed the capacity.; The size increases by 1.

Precondition: DIM == 1

◆ push_back_device() [1/2]

template<typename T , int DIM, MemorySpace SPACE>

AXOM_SUPPRESS_HD_WARN AXOM_HOST_DEVICE void axom::Array< T, DIM, SPACE >::push_back_device ( const T & value )

inline

Push a value to the back of the array.

Parameters

[in] value the value to move to the back.

Note: Reallocation is done if the new size will exceed the capacity.; If used in a device kernel, the number of push_backs must not exceed the capacity, since device-side reallocations aren't supported.; Array must be allocated in unified memory if calling on the device.

Precondition: DIM == 1

◆ push_back_device() [2/2]

template<typename T , int DIM, MemorySpace SPACE>

AXOM_HOST_DEVICE void axom::Array< T, DIM, SPACE >::push_back_device ( T && value )

inline

◆ emplace_back_device()

template<typename T , int DIM, MemorySpace SPACE>

template<typename... Args>

AXOM_HOST_DEVICE void axom::Array< T, DIM, SPACE >::emplace_back_device ( Args &&... args )

inline

Inserts new element at the end of the Array.

Parameters

[in] args the arguments to forward to constructor of the element.

Note: Reallocation is done if the new size will exceed the capacity.; The size increases by 1.; If used in a device kernel, the number of push_backs must not exceed the capacity, since device-side reallocations aren't supported.; Array must be allocated in unified memory if calling on the device.

Precondition: DIM == 1

◆ capacity()

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

IndexType axom::Array< T, DIM, SPACE >::capacity ( ) const

inline

Return the number of elements allocated for the data array.

References axom::Array< T, DIM, SPACE >::m_capacity.

◆ reserve()

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

void axom::Array< T, DIM, SPACE >::reserve ( IndexType capacity )

inline

Increase the capacity. Does nothing if the new capacity is less than the current capacity.

Parameters

[in] capacity the new number of elements to allocate.

References axom::Array< T, DIM, SPACE >::capacity(), axom::Array< T, DIM, SPACE >::m_capacity, and axom::Array< T, DIM, SPACE >::setCapacity().

◆ begin() [1/2]

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

ArrayIterator axom::Array< T, DIM, SPACE >::begin ( )

inline

Returns an ArrayIterator to the first element of the Array.

◆ begin() [2/2]

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

ConstArrayIterator axom::Array< T, DIM, SPACE >::begin ( ) const

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ end() [1/2]

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

ArrayIterator axom::Array< T, DIM, SPACE >::end ( )

inline

Returns an ArrayIterator to the element following the last element of the Array.

References axom::Array< T, DIM, SPACE >::size().

◆ end() [2/2]

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

ConstArrayIterator axom::Array< T, DIM, SPACE >::end ( ) const

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

References axom::Array< T, DIM, SPACE >::size().

◆ front() [1/2]

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

T& axom::Array< T, DIM, SPACE >::front ( )

inline

Returns a reference to the first element in the Array.

Precondition: array.empty() == false

References axom::Array< T, DIM, SPACE >::begin(), and axom::Array< T, DIM, SPACE >::empty().

◆ front() [2/2]

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

const T& axom::Array< T, DIM, SPACE >::front ( ) const

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

References axom::Array< T, DIM, SPACE >::begin(), and axom::Array< T, DIM, SPACE >::empty().

◆ back() [1/2]

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

T& axom::Array< T, DIM, SPACE >::back ( )

inline

Returns a reference to the last element in the Array.

Precondition: array.size() > 0

References axom::Array< T, DIM, SPACE >::empty(), and axom::Array< T, DIM, SPACE >::end().

◆ back() [2/2]

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

const T& axom::Array< T, DIM, SPACE >::back ( ) const

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

References axom::Array< T, DIM, SPACE >::empty(), and axom::Array< T, DIM, SPACE >::end().

◆ shrink()

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

void axom::Array< T, DIM, SPACE >::shrink ( )

inline

Shrink the capacity to be equal to the size.

References axom::Array< T, DIM, SPACE >::m_num_elements, and axom::Array< T, DIM, SPACE >::setCapacity().

◆ empty()

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

AXOM_HOST_DEVICE bool axom::Array< T, DIM, SPACE >::empty ( ) const

inline

Returns true iff the Array stores no elements.

Note: If the Array is empty the capacity can still be greater than zero.

References axom::Array< T, DIM, SPACE >::m_num_elements.

◆ size()

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

AXOM_HOST_DEVICE IndexType axom::Array< T, DIM, SPACE >::size ( ) const

inline

Return the number of elements stored in the data array.

References axom::Array< T, DIM, SPACE >::m_num_elements.

◆ resize() [1/4]

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

template<typename... Args, typename Enable = typename std::enable_if< sizeof...(Args) == DIM && detail::all_types_are_integral<Args...>::value>::type>

void axom::Array< T, DIM, SPACE >::resize ( Args... args )

inline

Update the number of elements stored in the data array.

Note: Reallocation is done if the new size will exceed the capacity.

References axom::Array< T, DIM, SPACE >::resizeImpl().

◆ resize() [2/4]

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

template<typename... Args, typename Enable = typename std::enable_if< sizeof...(Args) == DIM && detail::all_types_are_integral<Args...>::value>::type>

void axom::Array< T, DIM, SPACE >::resize	(	ArrayOptions::Uninitialized	,
		Args...	args
	)

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

References axom::Array< T, DIM, SPACE >::resizeImpl().

◆ resize() [3/4]

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

template<int Dims = DIM, typename Enable = std::enable_if_t<Dims == 1>>

void axom::Array< T, DIM, SPACE >::resize	(	IndexType	size,
		const T &	value
	)

inline

References axom::Array< T, DIM, SPACE >::resizeImpl(), and axom::Array< T, DIM, SPACE >::size().

◆ resize() [4/4]

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

void axom::Array< T, DIM, SPACE >::resize	(	const StackArray< IndexType, DIM > &	size,
		const T &	value
	)

inline

References axom::Array< T, DIM, SPACE >::resizeImpl(), and axom::Array< T, DIM, SPACE >::size().

◆ swap() [1/2]

template<typename T , int DIM, MemorySpace SPACE>

void axom::Array< T, DIM, SPACE >::swap ( Array< T, DIM, SPACE > & other )

inline

Exchanges the contents of this Array with the other.

References axom::Array< T, DIM, SPACE >::m_allocator_id, axom::Array< T, DIM, SPACE >::m_capacity, axom::Array< T, DIM, SPACE >::m_data, axom::Array< T, DIM, SPACE >::m_num_elements, axom::Array< T, DIM, SPACE >::m_resize_ratio, and axom::utilities::swap().

◆ getResizeRatio()

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

double axom::Array< T, DIM, SPACE >::getResizeRatio ( ) const

inline

Get the ratio by which the capacity increases upon dynamic resize.

References axom::Array< T, DIM, SPACE >::m_resize_ratio.

◆ setResizeRatio()

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

void axom::Array< T, DIM, SPACE >::setResizeRatio ( double ratio )

inline

Set the ratio by which the capacity increases upon dynamic resize.

Parameters

[in] ratio the new resize ratio.

References axom::Array< T, DIM, SPACE >::m_resize_ratio.

◆ getAllocatorID()

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

AXOM_HOST_DEVICE int axom::Array< T, DIM, SPACE >::getAllocatorID ( ) const

inline

Get the ID for the umpire allocator.

References axom::Array< T, DIM, SPACE >::m_allocator_id.

◆ setDevicePreference()

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

void axom::Array< T, DIM, SPACE >::setDevicePreference ( bool on_device )

inline

Sets the preferred space where operations on this array should be performed.

This option only has an effect for memory which is both accessible on the CPU and the GPU. For CUDA this is the Unified and Pinned memory spaces, while for HIP this is the Unified, Pinned, and Device memory spaces.

References axom::Array< T, DIM, SPACE >::m_executeOnGPU.

◆ view() [1/2]

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

ArrayViewType axom::Array< T, DIM, SPACE >::view ( )

inline

Returns a view of the array.

See also: ArrayView

◆ view() [2/2]

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

ConstArrayViewType axom::Array< T, DIM, SPACE >::view ( ) const

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ initialize()

template<typename T , int DIM, MemorySpace SPACE>

void axom::Array< T, DIM, SPACE >::initialize	(	IndexType	num_elements,
		IndexType	capacity,
		bool	should_default_construct = `true`
	)

inlineprotected

Initialize an Array instance with the given number of elements.

Parameters

[in]	num_elements	the number of elements the Array holds.
[in]	capacity	the number of elements to allocate space for.
[in]	should_default_construct	whether to create default-constructed objects in the region [0, num_elements). Defaults to true.

Note: If no capacity or capacity less than num_elements is specified then it will default to at least num_elements * DEFAULT_RESIZE_RATIO.; a capacity is specified for the number of elements to store in the array and does not correspond to the actual bytesize.

Precondition: num_elements >= 0

Postcondition: capacity() >= size(); size() == num_elements; getResizeRatio() == DEFAULT_RESIZE_RATIO

References axom::isDeviceAllocator().

◆ initialize_from_other()

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

void axom::Array< T, DIM, SPACE >::initialize_from_other	(	const T *	data,
		IndexType	num_elements,
		MemorySpace	data_space,
		bool	user_provided_allocator
	)

inlineprotected

Helper function for initializing an Array instance with an existing range of elements.

Parameters

[in]	data	pointer to the existing array of elements
[in]	num_elements	the number of elements in the existing array
[in]	data_space	the memory space in which data has been allocated
[in]	user_provided_allocator	true if the Array's allocator ID was provided by the user

References axom::Dynamic, axom::detail::getAllocatorSpace(), and axom::isDeviceAllocator().

◆ resizeImpl()

template<typename T , int DIM, MemorySpace SPACE>

void axom::Array< T, DIM, SPACE >::resizeImpl	(	const StackArray< IndexType, DIM > &	dims,
		bool	construct_with_values,
		const T *	value = `nullptr`
	)

inlineprotected

Updates the number of elements stored in the data array.

Parameters

[in]	dims	the number of elements to allocate in each dimension
[in]	construct_with_values	if true, sets new elements in the array to a specified value
[in]	value	pointer to the value to fill new elements in the array with. If null, will default-construct elements in place.

References axom::detail::allNonNegative(), axom::StackArray< T, N >::m_data, and axom::detail::packProduct().

◆ reserveForInsert()

template<typename T , int DIM, MemorySpace SPACE>

T * axom::Array< T, DIM, SPACE >::reserveForInsert	(	IndexType	n,
		IndexType	pos
	)

inlineprotected

Make space for a subsequent insertion into the array.

Parameters

[in]	n	the number of elements to insert.
[in]	pos	the position at which to begin the insertion.

Returns: a pointer to the beginning of the insertion space.

Note: Reallocation is done if the new size will exceed the capacity.

◆ reserveForDeviceInsert()

template<typename T , int DIM, MemorySpace SPACE>

AXOM_DEVICE IndexType axom::Array< T, DIM, SPACE >::reserveForDeviceInsert ( IndexType n )

inlineprotected

Make space for a subsequent insertion into the array.

Parameters

[in] n the number of elements to insert.

Note: This version supports concurrent GPU insertions.; Reallocation is not supported.

References axom::slic::abort(), and AXOM_UNUSED_VAR.

◆ updateNumElements()

template<typename T , int DIM, MemorySpace SPACE>

void axom::Array< T, DIM, SPACE >::updateNumElements ( IndexType new_num_elements )

inlineprotectedvirtual

Update the number of elements.

Parameters

[in] new_num_elements the new number of elements.

Reimplemented in axom::sidre::Array< T, DIM >.

◆ setCapacity()

template<typename T , int DIM, MemorySpace SPACE>

void axom::Array< T, DIM, SPACE >::setCapacity ( IndexType new_capacity )

inlineprotectedvirtual

Set the number of elements allocated for the data array.

Parameters

[in] capacity the new number of elements to allocate.

Reimplemented in axom::sidre::Array< T, DIM >, and axom::mint::ExternalArray< T, DIM >.

References axom::deallocate().

◆ dynamicRealloc()

template<typename T , int DIM, MemorySpace SPACE>

void axom::Array< T, DIM, SPACE >::dynamicRealloc ( IndexType new_num_elements )

inlineprotectedvirtual

Reallocates the data array when the size exceeds the capacity.

Parameters

[in] new_num_elements the number of elements which exceeds the current capacity.

Reimplemented in axom::sidre::Array< T, DIM >, and axom::mint::ExternalArray< T, DIM >.

References axom::utilities::processAbort().

◆ emplace() [3/3]

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

template<typename... Args>

Array<T, DIM, SPACE>::ArrayIterator axom::Array< T, DIM, SPACE >::emplace	(	Array< T, DIM, SPACE >::ArrayIterator	pos,
		Args &&...	args
	)

inline

References axom::utilities::annotations::begin(), and axom::utilities::annotations::end().

◆ operator()() [1/2]

AXOM_HOST_DEVICE SliceType<sizeof...(Args)> axom::ArrayBase< T, DIM, Array< T, 1, MemorySpace::Dynamic > >::operator() ( Args... args )

inlineinherited

Dimension-aware accessor; with N=DIM indices, returns a reference to the given value at that index. Otherwise, returns a sub-array pointed to by the given sub-index.

Parameters

[in] args the parameter pack of indices in each dimension.

Note: equivalent to *(array.data() + idx).

Precondition: sizeof...(Args) <= DIM; 0 <= args[i] < shape()[i] for i in [0, sizeof...(Args))

◆ operator()() [2/2]

AXOM_HOST_DEVICE ConstSliceType<sizeof...(Args)> axom::ArrayBase< T, DIM, Array< T, 1, MemorySpace::Dynamic > >::operator() ( Args... args ) const

inlineinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ operator[]() [1/4]

AXOM_HOST_DEVICE SliceType<1> axom::ArrayBase< T, DIM, Array< T, 1, MemorySpace::Dynamic > >::operator[] ( const IndexType idx )

inlineinherited

Scalar accessor; returns a sub-array referenced by the given sub- index, beginning at array(idx, 0...)

Parameters

[in] idx the index of the first dimension.

Precondition: 0 <= idx < shape()[0]

◆ operator[]() [2/4]

AXOM_HOST_DEVICE ConstSliceType<1> axom::ArrayBase< T, DIM, Array< T, 1, MemorySpace::Dynamic > >::operator[] ( const IndexType idx ) const

inlineinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ operator[]() [3/4]

AXOM_HOST_DEVICE SliceType<UDim> axom::ArrayBase< T, DIM, Array< T, 1, MemorySpace::Dynamic > >::operator[] ( const StackArray< IndexType, UDim > & idx )

inlineinherited

Dimension-aware accessor; with UDim=DIM indices, returns a reference to the given value at that index. Otherwise, returns a sub-array pointed to by the given sub-index.

Parameters

[in] args a stack array of indices in each dimension.

Note: equivalent to *(array.data() + idx).

Precondition: UDim <= DIM; 0 <= args[i] < shape()[i] for i in [0, UDim)

◆ operator[]() [4/4]

AXOM_HOST_DEVICE ConstSliceType<UDim> axom::ArrayBase< T, DIM, Array< T, 1, MemorySpace::Dynamic > >::operator[] ( const StackArray< IndexType, UDim > & idx ) const

inlineinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ flatIndex() [1/2]

AXOM_HOST_DEVICE T& axom::ArrayBase< T, DIM, Array< T, 1, MemorySpace::Dynamic > >::flatIndex ( const IndexType idx )

inlineinherited

Accessor, returns a reference to the given value. For multidimensional arrays, indexes into the (flat) raw data.

Parameters

[in] idx the position of the value to return.

Note: equivalent to *(array.data() + idx * minStride()).

Precondition: 0 <= idx < asDerived().size()

◆ flatIndex() [2/2]

AXOM_HOST_DEVICE RealConstT& axom::ArrayBase< T, DIM, Array< T, 1, MemorySpace::Dynamic > >::flatIndex ( const IndexType idx ) const

inlineinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ swap() [2/2]

void axom::ArrayBase< T, DIM, Array< T, 1, MemorySpace::Dynamic > >::swap ( ArrayBase< T, 1, Array< T, 1, MemorySpace::Dynamic > > & other )

inlineinherited

Swaps two ArrayBases.

◆ shape()

AXOM_HOST_DEVICE const StackArray<IndexType, DIM>& axom::ArrayBase< T, DIM, Array< T, 1, MemorySpace::Dynamic > >::shape ( ) const

inlineinherited

Returns the dimensions of the Array.

◆ mapping()

AXOM_HOST_DEVICE const MDMapping<DIM>& axom::ArrayBase< T, DIM, Array< T, 1, MemorySpace::Dynamic > >::mapping ( ) const

inlineinherited

Returns the multidimensional mapping for the Array.

◆ strides()

AXOM_HOST_DEVICE const StackArray<IndexType, DIM>& axom::ArrayBase< T, DIM, Array< T, 1, MemorySpace::Dynamic > >::strides ( ) const

inlineinherited

Returns the memory strides of the Array.

◆ minStride()

AXOM_HOST_DEVICE IndexType axom::ArrayBase< T, DIM, Array< T, 1, MemorySpace::Dynamic > >::minStride ( ) const

inlineinherited

Returns the minimum stride between adjacent items.

◆ setShape()

AXOM_HOST_DEVICE void axom::ArrayBase< T, DIM, Array< T, 1, MemorySpace::Dynamic > >::setShape ( const StackArray< IndexType, DIM > & shape_ )

inlineprotectedinherited

Set the shape.

◆ setShapeAndStride()

AXOM_SUPPRESS_HD_WARN AXOM_HOST_DEVICE void axom::ArrayBase< T, DIM, Array< T, 1, MemorySpace::Dynamic > >::setShapeAndStride	(	const StackArray< IndexType, DIM > &	shape,
		const StackArray< IndexType, DIM > &	stride
	)

inlineprotectedinherited

Set the shape and stride.

◆ blockSize()

IndexType axom::ArrayBase< T, DIM, Array< T, 1, MemorySpace::Dynamic > >::blockSize ( ) const

inlineprotectedinherited

Returns the minimum "chunk size" that should be allocated For example, 2 would be the chunk size of a 2D array whose second dimension is of size 2. This is used when resizing/reallocating; it wouldn't make sense to have a capacity of 3 in the array described above.

◆ updateStrides()

AXOM_HOST_DEVICE void axom::ArrayBase< T, DIM, Array< T, 1, MemorySpace::Dynamic > >::updateStrides ( int min_stride = 1 )

inlineprotectedinherited

Updates the internal striding information to a row-major format Intended to be called after shape is updated.

◆ updateShapeOnInsert()

void axom::ArrayBase< T, DIM, Array< T, 1, MemorySpace::Dynamic > >::updateShapeOnInsert ( const StackArray< IndexType, DIM > & range_shape )

inlineprotectedinherited

Updates the internal dimensions and striding based on the insertion of a range of elements. Intended to be called after the insertion of a multidimensional subslice.

Member Data Documentation

◆ DEFAULT_RESIZE_RATIO

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

constexpr double axom::Array< T, DIM, SPACE >::DEFAULT_RESIZE_RATIO = 2.0

staticconstexpr

◆ MIN_DEFAULT_CAPACITY

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

constexpr IndexType axom::Array< T, DIM, SPACE >::MIN_DEFAULT_CAPACITY = 32

staticconstexpr

◆ space

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

constexpr MemorySpace axom::Array< T, DIM, SPACE >::space = SPACE

staticconstexpr

◆ m_data

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

T* axom::Array< T, DIM, SPACE >::m_data = nullptr

protected

◆ m_num_elements

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

IndexType axom::Array< T, DIM, SPACE >::m_num_elements = 0

protected

The full number of elements in the array i.e., 3 for a 1D Array of size 3, 9 for a 3x3 2D array, etc.

◆ m_capacity

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

IndexType axom::Array< T, DIM, SPACE >::m_capacity = 0

protected

◆ m_resize_ratio

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

double axom::Array< T, DIM, SPACE >::m_resize_ratio = DEFAULT_RESIZE_RATIO

protected

◆ m_allocator_id

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

int axom::Array< T, DIM, SPACE >::m_allocator_id = INVALID_ALLOCATOR_ID

protected

◆ m_executeOnGPU

template<typename T , int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>

bool axom::Array< T, DIM, SPACE >::m_executeOnGPU = false

protected

◆ Dims

constexpr static int axom::ArrayBase< T, DIM, Array< T, 1, MemorySpace::Dynamic > >::Dims

staticconstexprinherited

◆ m_shape

StackArray<IndexType, DIM> axom::ArrayBase< T, DIM, Array< T, 1, MemorySpace::Dynamic > >::m_shape

protectedinherited

The extent in each direction.

◆ m_mapping

MDMapping<DIM> axom::ArrayBase< T, DIM, Array< T, 1, MemorySpace::Dynamic > >::m_mapping

protectedinherited

For converting between multidim indices and offset.

◆ m_minStride

IndexType axom::ArrayBase< T, DIM, Array< T, 1, MemorySpace::Dynamic > >::m_minStride

protectedinherited

Cached value for optimization.

See also: minStride()

For some reason, computing min stride in minStride() slows down flatIndex() for CUDA and HIP, even though it doesn't seem tricky to optimize. As a work around, we cache the value in m_minStrides and update it when m_mapping changes. BTNG, March 2024.

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

/home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/feature-whitlock-mir_update/src/axom/core/Array.hpp

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

template<typename T, int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic> class axom::Array< T, DIM, SPACE >

Member Typedef Documentation

◆ value_type

◆ ArrayIterator

◆ ConstArrayIterator

◆ ArrayViewType

◆ ConstArrayViewType

◆ RealConstT

◆ SliceType

◆ ConstSliceType

Constructor & Destructor Documentation

◆ Array() [1/15]

◆ Array() [2/15]

◆ Array() [3/15]

◆ Array() [4/15]

◆ Array() [5/15]

◆ Array() [6/15]

◆ Array() [7/15]

◆ Array() [8/15]

◆ Array() [9/15]

◆ Array() [10/15]

◆ Array() [11/15]

◆ Array() [12/15]

◆ Array() [13/15]

◆ Array() [14/15]

◆ Array() [15/15]

◆ ~Array()

Member Function Documentation

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

◆ data() [1/2]

◆ data() [2/2]

◆ to_stack_array()

◆ fill() [1/2]

◆ fill() [2/2]

◆ set()

◆ clear()

◆ insert() [1/8]

◆ insert() [2/8]

◆ insert() [3/8]

◆ insert() [4/8]

◆ insert() [5/8]

◆ insert() [6/8]

◆ insert() [7/8]

◆ insert() [8/8]

◆ append() [1/2]

◆ append() [2/2]

◆ erase() [1/2]

◆ erase() [2/2]

◆ emplace() [1/3]

◆ emplace() [2/3]

◆ push_back() [1/2]

◆ push_back() [2/2]

◆ emplace_back()

◆ push_back_device() [1/2]

◆ push_back_device() [2/2]

◆ emplace_back_device()

◆ capacity()

◆ reserve()

◆ begin() [1/2]

◆ begin() [2/2]

◆ end() [1/2]

◆ end() [2/2]

◆ front() [1/2]

◆ front() [2/2]

◆ back() [1/2]

◆ back() [2/2]

◆ shrink()

◆ empty()

◆ size()

◆ resize() [1/4]

◆ resize() [2/4]

◆ resize() [3/4]

template<typename T, int DIM = 1, MemorySpace SPACE = MemorySpace::Dynamic>
class axom::Array< T, DIM, SPACE >