A base class template for a multidimensional array with elements of type T arranged in a lattice of ndim dimensions. More...

#include <arraynd_base.h>

Inherited by sydevs::arraynd< T, ndims >.

Public Member Functions
	~arraynd_base ()=default
	Destructor. More...

std::array< int64, ndims >	dims () const
	Returns the lengths of each dimension. More...

std::array< int64, ndims >	strides () const
	Returns the number of element-size steps in memory between successive elements for each dimension. More...

bool	empty () const
	Returns `true` if there is at least one element. More...

int64	size () const
	Returns the total number of elements. More...

int64	offset () const
	Returns the number of element-size steps in memory before the first element. More...

const T *	data () const
	Returns a pointer to the element data (const). More...

T *	data ()
	Returns a pointer to the element data. More...

bool	is_contiguous () const
	Returns `true` if a row-major traversal of the multidimensional array accesses each element of `data` in sequence. More...

bool	is_view () const
	Returns `true` if this multidimensional array is a view of another, meaning that data is shared. More...

bool	is_readonly () const
	Returns `true` if the data is readonly, in which case attempts to modify it raise a std::logic_error. More...

const T &	operator() (const std::array< int64, ndims > &indices) const
	Returns a reference to an element (const). More...

T &	operator() (const std::array< int64, ndims > &indices)
	Returns a reference to an element. More...

const T &	operator() (const arraynd_base< int64, 1 > &indices) const
	Returns a reference to an element (const). More...

T &	operator() (const arraynd_base< int64, 1 > &indices)
	Returns a reference to an element. More...

template<typename... Indices>
const T &	operator() (Indices... indices) const
	Returns a reference to an element (const). More...

template<typename... Indices>
T &	operator() (Indices... indices)
	Returns a reference to an element. More...

void	fill (const T &value)
	Replaces every element with `value`. More...

void	assign (const arraynd_base< T, ndims > &rhs)
	Replaces every element with the corresponding value in `rhs`. More...

void	assign_from_function (std::function< T(const std::array< int64, ndims > &indices)> func)
	Replaces every element with the result of `func` evaluated at the cooresponding `indices`. More...

bool	traverse (std::function< bool(const std::array< int64, ndims > &indices, const T &value)> func) const
	Traverses the multidimensional array in row-major order, calling `func` at every element. More...

Protected Member Functions
	arraynd_base ()

	arraynd_base (const std::array< int64, ndims > &dims, const T &value)

	arraynd_base (const std::array< int64, ndims > &dims, const std::vector< T > &data)

	arraynd_base (const std::array< int64, ndims > &dims, std::function< T(const std::array< int64, ndims > &indices)> func)

	arraynd_base (const arraynd_base< T, ndims+1 > &rhs, int64 index, bool is_readonly)

	arraynd_base (const arraynd_base< T, ndims > &rhs, range r, bool is_readonly)

	arraynd_base (const arraynd_base< T, ndims > &rhs, bool is_view, bool is_readonly)

	arraynd_base (const arraynd_base< T, ndims > &rhs)

arraynd_base< T, ndims > &	operator= (const arraynd_base< T, ndims > &rhs)

	arraynd_base (arraynd_base< T, ndims > &&)=default

arraynd_base< T, ndims > &	operator= (arraynd_base< T, ndims > &&)=default

Static Protected Member Functions
static void	transpose (arraynd_base< T, ndims > &arr)

static void	swap_axes (arraynd_base< T, ndims > &arr, int64 idim0, int64 idim1)

static void	subdivide_axis (const arraynd_base< T, ndims > &arr0, arraynd_base< T, ndims+1 > &arr, int64 idim, const std::array< int64, 2 > &dims)

static void	absorb_axis (const arraynd_base< T, ndims > &arr0, arraynd_base< T, ndims-1 > &arr, int64 idim)

Friends
class	arraynd_base< T, ndims-1 >

class	arraynd_base< T, ndims+1 >

Detailed Description

template<typename T, int64 ndims>
class sydevs::arraynd_base< T, ndims >

A base class template for a multidimensional array with elements of type T arranged in a lattice of ndim dimensions.

arraynd_base contains all member variables, all member functions that behave the same for ndims == 1 and ndims > 1, and all member functions that do not return a multidimensional array.

Constructor & Destructor Documentation

◆ ~arraynd_base()

template<typename T , int64 ndims>

sydevs::arraynd_base< T, ndims >::~arraynd_base ( )

default

Destructor.

◆ arraynd_base() [1/9]

template<typename T , int64 ndims>

sydevs::arraynd_base< T, ndims >::arraynd_base

protected

◆ arraynd_base() [2/9]

template<typename T , int64 ndims>

sydevs::arraynd_base< T, ndims >::arraynd_base	(	const std::array< int64, ndims > &	dims,
		const T &	value
	)

protected

◆ arraynd_base() [3/9]

template<typename T , int64 ndims>

sydevs::arraynd_base< T, ndims >::arraynd_base	(	const std::array< int64, ndims > &	dims,
		const std::vector< T > &	data
	)

protected

◆ arraynd_base() [4/9]

template<typename T , int64 ndims>

sydevs::arraynd_base< T, ndims >::arraynd_base	(	const std::array< int64, ndims > &	dims,
		std::function< T(const std::array< int64, ndims > &indices)>	func
	)

protected

◆ arraynd_base() [5/9]

template<typename T , int64 ndims>

sydevs::arraynd_base< T, ndims >::arraynd_base	(	const arraynd_base< T, ndims+1 > &	rhs,
		int64	index,
		bool	is_readonly
	)

protected

◆ arraynd_base() [6/9]

template<typename T , int64 ndims>

sydevs::arraynd_base< T, ndims >::arraynd_base	(	const arraynd_base< T, ndims > &	rhs,
		range	r,
		bool	is_readonly
	)

protected

◆ arraynd_base() [7/9]

template<typename T , int64 ndims>

sydevs::arraynd_base< T, ndims >::arraynd_base	(	const arraynd_base< T, ndims > &	rhs,
		bool	is_view,
		bool	is_readonly
	)

protected

◆ arraynd_base() [8/9]

template<typename T , int64 ndims>

sydevs::arraynd_base< T, ndims >::arraynd_base ( const arraynd_base< T, ndims > & rhs )

protected

◆ arraynd_base() [9/9]

template<typename T , int64 ndims>

sydevs::arraynd_base< T, ndims >::arraynd_base ( arraynd_base< T, ndims > && )

protecteddefault

Member Function Documentation

◆ absorb_axis()

template<typename T , int64 ndims>

void sydevs::arraynd_base< T, ndims >::absorb_axis	(	const arraynd_base< T, ndims > &	arr0,
		arraynd_base< T, ndims-1 > &	arr,
		int64	idim
	)

staticprotected

◆ assign()

template<typename T , int64 ndims>

void sydevs::arraynd_base< T, ndims >::assign ( const arraynd_base< T, ndims > & rhs )

Replaces every element with the corresponding value in rhs.

◆ assign_from_function()

template<typename T , int64 ndims>

void sydevs::arraynd_base< T, ndims >::assign_from_function ( std::function< T(const std::array< int64, ndims > &indices)> func )

Replaces every element with the result of func evaluated at the cooresponding indices.

◆ data() [1/2]

template<typename T , int64 ndims>

T * sydevs::arraynd_base< T, ndims >::data

Returns a pointer to the element data.

◆ data() [2/2]

template<typename T , int64 ndims>

const T * sydevs::arraynd_base< T, ndims >::data

Returns a pointer to the element data (const).

◆ dims()

template<typename T , int64 ndims>

std::array< int64, ndims > sydevs::arraynd_base< T, ndims >::dims

Returns the lengths of each dimension.

◆ empty()

template<typename T , int64 ndims>

bool sydevs::arraynd_base< T, ndims >::empty

Returns true if there is at least one element.

◆ fill()

template<typename T , int64 ndims>

void sydevs::arraynd_base< T, ndims >::fill ( const T & value )

Replaces every element with value.

◆ is_contiguous()

template<typename T , int64 ndims>

bool sydevs::arraynd_base< T, ndims >::is_contiguous

Returns true if a row-major traversal of the multidimensional array accesses each element of data in sequence.

◆ is_readonly()

template<typename T , int64 ndims>

bool sydevs::arraynd_base< T, ndims >::is_readonly

Returns true if the data is readonly, in which case attempts to modify it raise a std::logic_error.

◆ is_view()

template<typename T , int64 ndims>

bool sydevs::arraynd_base< T, ndims >::is_view

Returns true if this multidimensional array is a view of another, meaning that data is shared.

◆ offset()

template<typename T , int64 ndims>

int64 sydevs::arraynd_base< T, ndims >::offset

Returns the number of element-size steps in memory before the first element.

◆ operator()() [1/6]

template<typename T , int64 ndims>

T & sydevs::arraynd_base< T, ndims >::operator() ( const arraynd_base< int64, 1 > & indices )

Returns a reference to an element.

◆ operator()() [2/6]

template<typename T , int64 ndims>

const T & sydevs::arraynd_base< T, ndims >::operator() ( const arraynd_base< int64, 1 > & indices ) const

Returns a reference to an element (const).

◆ operator()() [3/6]

template<typename T , int64 ndims>

T & sydevs::arraynd_base< T, ndims >::operator() ( const std::array< int64, ndims > & indices )

Returns a reference to an element.

◆ operator()() [4/6]

template<typename T , int64 ndims>

const T & sydevs::arraynd_base< T, ndims >::operator() ( const std::array< int64, ndims > & indices ) const

Returns a reference to an element (const).

◆ operator()() [5/6]

template<typename T , int64 ndims>

template<typename... Indices>

T & sydevs::arraynd_base< T, ndims >::operator() ( Indices... indices )

Returns a reference to an element.

◆ operator()() [6/6]

template<typename T , int64 ndims>

template<typename... Indices>

const T & sydevs::arraynd_base< T, ndims >::operator() ( Indices... indices ) const

Returns a reference to an element (const).

◆ operator=() [1/2]

template<typename T , int64 ndims>

arraynd_base<T, ndims>& sydevs::arraynd_base< T, ndims >::operator= ( arraynd_base< T, ndims > && )

protecteddefault

◆ operator=() [2/2]

template<typename T , int64 ndims>

arraynd_base< T, ndims > & sydevs::arraynd_base< T, ndims >::operator= ( const arraynd_base< T, ndims > & rhs )

protected

◆ size()

template<typename T , int64 ndims>

int64 sydevs::arraynd_base< T, ndims >::size

Returns the total number of elements.

◆ strides()

template<typename T , int64 ndims>

std::array< int64, ndims > sydevs::arraynd_base< T, ndims >::strides

Returns the number of element-size steps in memory between successive elements for each dimension.

◆ subdivide_axis()

template<typename T , int64 ndims>

void sydevs::arraynd_base< T, ndims >::subdivide_axis	(	const arraynd_base< T, ndims > &	arr0,
		arraynd_base< T, ndims+1 > &	arr,
		int64	idim,
		const std::array< int64, 2 > &	dims
	)

staticprotected

◆ swap_axes()

template<typename T , int64 ndims>

void sydevs::arraynd_base< T, ndims >::swap_axes	(	arraynd_base< T, ndims > &	arr,
		int64	idim0,
		int64	idim1
	)

staticprotected

◆ transpose()

template<typename T , int64 ndims>

void sydevs::arraynd_base< T, ndims >::transpose ( arraynd_base< T, ndims > & arr )

staticprotected

◆ traverse()

template<typename T , int64 ndims>

bool sydevs::arraynd_base< T, ndims >::traverse ( std::function< bool(const std::array< int64, ndims > &indices, const T &value)> func ) const

Traverses the multidimensional array in row-major order, calling func at every element.

For each element traversed in row-major order, func is called with the indices of the element and the element's value. If func returns true, the traversal continues. If func returns false, the traversal is terminated.

Parameters

func	The function to be called at every element.

Returns: true if the entire multidimensional array is traversed and func returns true at every element; false otherwise.

Friends And Related Function Documentation

◆ arraynd_base< T, ndims+1 >

template<typename T , int64 ndims>

friend class arraynd_base< T, ndims+1 >

friend

◆ arraynd_base< T, ndims-1 >

template<typename T , int64 ndims>

friend class arraynd_base< T, ndims-1 >

friend

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

src/sydevs/core/arraynd_base.h

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Friends

Detailed Description

template<typename T, int64 ndims> class sydevs::arraynd_base< T, ndims >

Constructor & Destructor Documentation

◆ ~arraynd_base()

◆ arraynd_base() [1/9]

◆ arraynd_base() [2/9]

◆ arraynd_base() [3/9]

◆ arraynd_base() [4/9]

◆ arraynd_base() [5/9]

◆ arraynd_base() [6/9]

◆ arraynd_base() [7/9]

◆ arraynd_base() [8/9]

◆ arraynd_base() [9/9]

Member Function Documentation

◆ absorb_axis()

◆ assign()

◆ assign_from_function()

◆ data() [1/2]

◆ data() [2/2]

◆ dims()

◆ empty()

◆ fill()

◆ is_contiguous()

◆ is_readonly()

◆ is_view()

◆ offset()

◆ operator()() [1/6]

◆ operator()() [2/6]

◆ operator()() [3/6]

◆ operator()() [4/6]

◆ operator()() [5/6]

◆ operator()() [6/6]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ size()

◆ strides()

◆ subdivide_axis()

◆ swap_axes()

◆ transpose()

◆ traverse()

Friends And Related Function Documentation

◆ arraynd_base< T, ndims+1 >

◆ arraynd_base< T, ndims-1 >

template<typename T, int64 ndims>
class sydevs::arraynd_base< T, ndims >