#include </home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/develop/src/axom/core/ArrayBase.hpp>

Public Types
using	DefaultCtorTag = std::is_default_constructible< T >

Static Public Member Functions
static void	init_impl (T *data, IndexType begin, IndexType nelems, std::true_type)
	Helper for default-initializing the "new" segment of an array. More...

static void	init_impl (T *, IndexType, IndexType, std::false_type)

static void	init (T *data, IndexType begin, IndexType nelems)
	Default-initializes the "new" segment of an array. More...

static void	fill (T *array, IndexType begin, IndexType nelems, const T &value)
	Fills an uninitialized array with objects of type T. More...

static void	fill_range (T array, IndexType begin, IndexType nelems, const T values, MemorySpace space)
	Fills an uninitialized array with a range of objects of type T. More...

template<typename... Args>
static void	emplace (T *array, IndexType i, Args &&... args)
	Constructs a new element in uninitialized memory. More...

static void	destroy (T *array, IndexType begin, IndexType nelems)
	Calls the destructor on a range of typed elements in the array. More...

static void	move (T *array, IndexType src_begin, IndexType src_end, IndexType dst)
	Moves a range of data in the array. More...

static void	realloc_move (T array, IndexType nelems, T values)
	Moves a range of elements to a new allocation. More...

Member Typedef Documentation

◆ DefaultCtorTag

template<typename T >

using axom::detail::ArrayOpsBase< T, false >::DefaultCtorTag = std::is_default_constructible<T>

Member Function Documentation

◆ init_impl() [1/2]

template<typename T >

static void axom::detail::ArrayOpsBase< T, false >::init_impl	(	T *	data,
		IndexType	begin,
		IndexType	nelems,
		std::true_type
	)

inlinestatic

Helper for default-initializing the "new" segment of an array.

Parameters

[in,out]	data	The data to initialize
[in]	begin	The beginning of the subset of data that should be initialized
[in]	nelems	the number of elements to initialize

Note: Specialization for when T is default-constructible.

References axom::utilities::annotations::begin().

◆ init_impl() [2/2]

template<typename T >

static void axom::detail::ArrayOpsBase< T, false >::init_impl	(	T *	,
		IndexType	,
		IndexType	,
		std::false_type
	)

inlinestatic

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

Note: Specialization for when T is not default-constructible.

◆ init()

template<typename T >

static void axom::detail::ArrayOpsBase< T, false >::init	(	T *	data,
		IndexType	begin,
		IndexType	nelems
	)

inlinestatic

Default-initializes the "new" segment of an array.

Parameters

[in,out]	data	The data to initialize
[in]	begin	The beginning of the subset of data that should be initialized
[in]	nelems	the number of elements to initialize

Note: Specialization for when T is default-constructible.

References axom::utilities::annotations::begin().

◆ fill()

template<typename T >

static void axom::detail::ArrayOpsBase< T, false >::fill	(	T *	array,
		IndexType	begin,
		IndexType	nelems,
		const T &	value
	)

inlinestatic

Fills an uninitialized array with objects of type T.

Parameters

[in,out]	array	the array to fill
[in]	begin	the index in the array to begin filling elements at
[in]	nelems	the number of elements to fill the array with
[in]	value	the value to set each array element to

References axom::utilities::annotations::begin().

◆ fill_range()

template<typename T >

static void axom::detail::ArrayOpsBase< T, false >::fill_range	(	T *	array,
		IndexType	begin,
		IndexType	nelems,
		const T *	values,
		MemorySpace	space
	)

inlinestatic

Fills an uninitialized array with a range of objects of type T.

Parameters

[in,out]	array	the array to fill
[in]	begin	the index at which to begin placing elements
[in]	nelems	the number of elements in the range to fill the array with
[in]	values	the values to set each array element to
[in]	space	the memory space in which values resides

References AXOM_UNUSED_VAR, axom::utilities::annotations::begin(), and axom::copy().

◆ emplace()

template<typename T >

template<typename... Args>

static void axom::detail::ArrayOpsBase< T, false >::emplace	(	T *	array,
		IndexType	i,
		Args &&...	args
	)

inlinestatic

Constructs a new element in uninitialized memory.

Parameters

[in,out]	array	the array to construct in
[in]	i	the array index in which to construct the new object
[in]	args	the arguments to forward to constructor of the element.

◆ destroy()

template<typename T >

static void axom::detail::ArrayOpsBase< T, false >::destroy	(	T *	array,
		IndexType	begin,
		IndexType	nelems
	)

inlinestatic

Calls the destructor on a range of typed elements in the array.

Parameters

[in,out]	array	the array with elements to destroy
[in]	begin	the start index of the range of elements to destroy
[in]	value	one past the end index of the range of elements to destroy

References axom::utilities::annotations::begin().

◆ move()

template<typename T >

static void axom::detail::ArrayOpsBase< T, false >::move	(	T *	array,
		IndexType	src_begin,
		IndexType	src_end,
		IndexType	dst
	)

inlinestatic

Moves a range of data in the array.

Parameters

[in,out]	array	the array with elements to move
[in]	src_begin	the start index of the source range
[in]	src_end	the end index of the source range, exclusive
[in]	dst	the destination index of the range of elements

◆ realloc_move()

template<typename T >

static void axom::detail::ArrayOpsBase< T, false >::realloc_move	(	T *	array,
		IndexType	nelems,
		T *	values
	)

inlinestatic

Moves a range of elements to a new allocation.

Parameters

[in,out]	array	the array to move the elements to.
[in]	nelems	the number of elements to move.
[in]	values	the destination index of the range of elements

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

/home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/develop/src/axom/core/ArrayBase.hpp

Public Types

Static Public Member Functions

Member Typedef Documentation

◆ DefaultCtorTag

Member Function Documentation

◆ init_impl() [1/2]

◆ init_impl() [2/2]

◆ init()

◆ fill()

◆ fill_range()

◆ emplace()

◆ destroy()

◆ move()

◆ realloc_move()