Herd::AxesArray< ContainedClass > Class Template Reference

An array that accepts axis as subscripts. More...

#include <common/AxesArray.h>

Inheritance diagram for Herd::AxesArray< ContainedClass >:

Public Types
using	BaseType = ArrayForwarder< ContainedClass, RefFrame::NAxes >
Public Types inherited from Herd::ArrayForwarder< ContainedClass, RefFrame::NAxes >
typedef ContainedClass	value_type
typedef value_type *	pointer
typedef const value_type *	const_pointer
typedef value_type &	reference
typedef const value_type &	const_reference
typedef value_type *	iterator
typedef const value_type *	const_iterator
typedef std::size_t	size_type
typedef std::ptrdiff_t	difference_type
typedef std::reverse_iterator< iterator >	reverse_iterator
typedef std::reverse_iterator< const_iterator >	const_reverse_iterator

Public Member Functions
ContainedClass &	operator[] (const RefFrame::Axis &axis)
	Accesses an element without validity check on the element index. More...
const ContainedClass &	operator[] (const RefFrame::Axis &axis) const
	Accesses an element without validity check on the element index. More...
ContainedClass &	at (const RefFrame::Axis &axis)
	Accesses an element with validity check on the element index. More...
const ContainedClass &	at (const RefFrame::Axis &axis) const
	Accesses an element with validity check on the element index. More...
Public Member Functions inherited from Herd::ArrayForwarder< ContainedClass, RefFrame::NAxes >
	ArrayForwarder ()
	ArrayForwarder (std::array< ContainedClass, _Nm > arr)
void	fill (const value_type &__u)
void	swap (ArrayForwarder &__other) noexcept(noexcept(std::swap(std::declval< ContainedClass & >(), std::declval< ContainedClass & >())))
_GLIBCXX17_CONSTEXPR iterator	begin () noexcept
_GLIBCXX17_CONSTEXPR const_iterator	begin () const noexcept
_GLIBCXX17_CONSTEXPR iterator	end () noexcept
_GLIBCXX17_CONSTEXPR const_iterator	end () const noexcept
_GLIBCXX17_CONSTEXPR reverse_iterator	rbegin () noexcept
_GLIBCXX17_CONSTEXPR const_reverse_iterator	rbegin () const noexcept
_GLIBCXX17_CONSTEXPR reverse_iterator	rend () noexcept
_GLIBCXX17_CONSTEXPR const_reverse_iterator	rend () const noexcept
_GLIBCXX17_CONSTEXPR const_iterator	cbegin () const noexcept
_GLIBCXX17_CONSTEXPR const_iterator	cend () const noexcept
_GLIBCXX17_CONSTEXPR const_reverse_iterator	crbegin () const noexcept
_GLIBCXX17_CONSTEXPR const_reverse_iterator	crend () const noexcept
constexpr size_type	size () const noexcept
constexpr size_type	max_size () const noexcept
constexpr bool	empty () const noexcept
_GLIBCXX17_CONSTEXPR reference	operator[] (size_type __n) noexcept
constexpr const_reference	operator[] (size_type __n) const noexcept
_GLIBCXX17_CONSTEXPR reference	at (size_type __n)
constexpr const_reference	at (size_type __n) const
_GLIBCXX17_CONSTEXPR reference	front () noexcept
constexpr const_reference	front () const noexcept
_GLIBCXX17_CONSTEXPR reference	back () noexcept
constexpr const_reference	back () const noexcept
_GLIBCXX17_CONSTEXPR pointer	data () noexcept
_GLIBCXX17_CONSTEXPR const_pointer	data () const noexcept

Detailed Description

template<typename ContainedClass>
class Herd::AxesArray< ContainedClass >

An array that accepts axis as subscripts.

The elements in an AxesArray can be indexed using RefFrame::Axis values. The class does not support the braced initialization lists like std::array, since it doesn't guarantee any relation between the position in the initializer list and the axis value. So it is not possible to initialize Axis Array as:

AxesArray<int> aa{0, 1,, 2}; // Compiler error aa = {4, 5, 6}; // Compiler error

Member Typedef Documentation

BaseType

template<typename ContainedClass>

using Herd::AxesArray< ContainedClass >::BaseType = ArrayForwarder<ContainedClass, RefFrame::NAxes>

Member Function Documentation

at() [1/2]

template<typename ContainedClass>

ContainedClass& Herd::AxesArray< ContainedClass >::at ( const RefFrame::Axis &  axis )

inline

Accesses an element with validity check on the element index.

Accesses the element corresponding to the given axis; if the axis is NONE then a std::out_of_range exception will be thrown.

Parameters

axis	The axis of the desired element.

Returns

a reference to the desired element.

Exceptions

std::out_of_range

if axis == RefFrame::Axis::NONE.

at() [2/2]

template<typename ContainedClass>

const ContainedClass& Herd::AxesArray< ContainedClass >::at ( const RefFrame::Axis &  axis ) const

inline

Accesses an element with validity check on the element index.

Accesses the element corresponding to the given axis; if the axis is NONE then a std::out_of_range exception will be thrown.

Parameters

axis	The axis of the desired element.

Returns

a const reference to the desired element.

Exceptions

std::out_of_range

if axis == RefFrame::Axis::NONE.

operator[]() [1/2]

template<typename ContainedClass>

ContainedClass& Herd::AxesArray< ContainedClass >::operator[] ( const RefFrame::Axis &  axis )

inline

Accesses an element without validity check on the element index.

Accesses the element corresponding to the given axis. No check is performed on the axis argument, so passing NONE will result in undefined behavior.

Parameters

axis	The axis of the desired element.

Returns

a reference to the desired element.

operator[]() [2/2]

template<typename ContainedClass>

const ContainedClass& Herd::AxesArray< ContainedClass >::operator[] ( const RefFrame::Axis &  axis ) const

inline

Accesses an element without validity check on the element index.

Accesses the element corresponding to the given axis. No check is performed on the axis argument, so passing NONE will result in undefined behavior.

Parameters

axis	The axis of the desired element.

Returns

a const reference to the desired element.

---

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

• /builds/herd/HerdSoftware/include/analysis/common/AxesArray.h