This class implements an indexed-based constant accessor providing access to a subset of elements stored in an array. More...

Inheritance diagram for Ocean::ConstArraySubsetAccessor< T, TIndex >:

Public Types
typedef TIndex	IndexType
	Definition of the data type of the indices. More...

Public Types inherited from Ocean::ConstAccessor< T, size_t >
typedef T	Type
	Definition of the element type of this accessor. More...

typedef size_t	KeyType
	Definition of the key (or e.g., index) type of this accessor. More...

Public Member Functions
	ConstArraySubsetAccessor ()=default
	Creates a new empty accessor. More...

	ConstArraySubsetAccessor (ConstArraySubsetAccessor< T, TIndex > &&accessor) noexcept
	Move constructor. More...

	ConstArraySubsetAccessor (const T elements, const TIndex subsetIndices, const size_t subsetSize)
	Creates a new accessor object. More...

	ConstArraySubsetAccessor (const T *elements, const std::vector< TIndex > &subsetIndices)
	Creates a new accessor object. More...

	ConstArraySubsetAccessor (const std::vector< T > &elements, const std::vector< TIndex > &subsetIndices)
	Creates a new accessor object. More...

virtual size_t	size () const
	Returns the number of accessible elements of this accessor object. More...

virtual const T &	operator[] (const size_t &index) const
	Returns one element of this accessor object. More...

ConstArraySubsetAccessor< T, TIndex > &	operator= (ConstArraySubsetAccessor< T, TIndex > &&accessor) noexcept
	Move operator. More...

Public Member Functions inherited from Ocean::ConstIndexedAccessor< T >
virtual bool	canAccess (const size_t &index) const
	Returns whether this accessor has a specific element. More...

virtual bool	firstElement (T &element, size_t &index) const
	Returns the first element of this accessor. More...

virtual bool	nextElement (const size_t &previousIndex, T &nextElement, size_t &nextIndex) const
	Returns the next element which follows a given key of the previous element. More...

Public Member Functions inherited from Ocean::ConstAccessor< T, size_t >
virtual const T *	data () const
	Returns a pointer to the elements of this accessor if the data exists within one memory block without gaps. More...

Public Member Functions inherited from Ocean::Accessor
virtual	~Accessor ()=default
	Default destructor. More...

bool	isEmpty () const
	Returns whether this accessor provides no elements. More...

Protected Attributes
const T *	elements_ = nullptr
	The elements of this accessor. More...

const TIndex *	subsetIndices_ = nullptr
	The subset indices of this accessor. More...

size_t	subsetSize_ = 0
	The number of elements that can be accessed. More...

Additional Inherited Members
Static Public Member Functions inherited from Ocean::Accessor
template<typename TAccessor >
static std::vector< typename TAccessor::Type >	accessor2elements (const TAccessor &accessor)
	Returns all elements of a given accessor (as a block). More...

template<typename TAccessor >
static std::unordered_map< typename TAccessor::KeyType, typename TAccessor::Type >	accessor2map (const TAccessor &accessor)
	Returns all elements of a given accessor as a map with key and elements. More...

template<typename TAccessor , typename TIndex >
static std::vector< typename TAccessor::Type >	accessor2subsetElements (const TAccessor &accessor, const std::vector< TIndex > &subset)
	Returns a subset of all elements of a given accessor (as a block). More...

Protected Member Functions inherited from Ocean::ConstIndexedAccessor< T >
	ConstIndexedAccessor ()=default
	Creates a new indexed-based accessor object. More...

Protected Member Functions inherited from Ocean::ConstAccessor< T, size_t >
	ConstAccessor ()=default
	Protected default constructor. More...

Protected Member Functions inherited from Ocean::Accessor
	Accessor ()=default
	Protected default constructor. More...

	Accessor (const Accessor &accessor)=default
	Protected copy constructor. More...

Accessor &	operator= (const Accessor &accessor)=delete
	Deleted assign operator. More...

Detailed Description

template<typename T, typename TIndex>
class Ocean::ConstArraySubsetAccessor< T, TIndex >

This class implements an indexed-based constant accessor providing access to a subset of elements stored in an array.

The subset is defined by a set of indices defining also the order of the accessible elements.
An instance of this accessor does not copy the elements or the subset indices, thus the caller has to ensure that the actual elements exist as long as the instance of the accessor exists.

Template Parameters

T	The data type of the elements of the accessor
TIndex	The data type of the indices defining the subset of elements

Member Typedef Documentation

◆ IndexType

template<typename T , typename TIndex >

typedef TIndex Ocean::ConstArraySubsetAccessor< T, TIndex >::IndexType

Definition of the data type of the indices.

Constructor & Destructor Documentation

◆ ConstArraySubsetAccessor() [1/5]

template<typename T , typename TIndex >

Ocean::ConstArraySubsetAccessor< T, TIndex >::ConstArraySubsetAccessor ( )

default

Creates a new empty accessor.

◆ ConstArraySubsetAccessor() [2/5]

template<typename T , typename TIndex >

Ocean::ConstArraySubsetAccessor< T, TIndex >::ConstArraySubsetAccessor ( ConstArraySubsetAccessor< T, TIndex > && accessor )

inlinenoexcept

Move constructor.

Parameters

accessor Accessor to be moved

◆ ConstArraySubsetAccessor() [3/5]

template<typename T , typename TIndex >

Ocean::ConstArraySubsetAccessor< T, TIndex >::ConstArraySubsetAccessor	(	const T *	elements,
		const TIndex *	subsetIndices,
		const size_t	subsetSize
	)

inline

Creates a new accessor object.

Beware: The given elements are not copied, they must not be deleted before the accessor is disposed.

Parameters

elements	The elements that can be accessed, may be nullptr if size is equal 0
subsetIndices	The indices that define a subset of the elements to be accessed, the maximal index must be smaller than the number of given elements
subsetSize	The number of indices (not the number of elements) that define the subset, may be 0 if indices is nullptr

◆ ConstArraySubsetAccessor() [4/5]

template<typename T , typename TIndex >

Ocean::ConstArraySubsetAccessor< T, TIndex >::ConstArraySubsetAccessor	(	const T *	elements,
		const std::vector< TIndex > &	subsetIndices
	)

inline

Creates a new accessor object.

Beware: The given elements are not copied, they must not be deleted before the accessor is disposed.

Parameters

elements	The elements that can be accessed, may be nullptr if size is equal 0
subsetIndices	The indices that define a subset of the elements to be accessed, the maximal index must be smaller than the number of given elements

◆ ConstArraySubsetAccessor() [5/5]

template<typename T , typename TIndex >

Ocean::ConstArraySubsetAccessor< T, TIndex >::ConstArraySubsetAccessor	(	const std::vector< T > &	elements,
		const std::vector< TIndex > &	subsetIndices
	)

inline

Creates a new accessor object.

Beware: The given elements are not copied, they must not be deleted before the accessor is disposed.

Parameters

elements	The elements that can be accessed, may be nullptr if size is equal 0
subsetIndices	The indices that define a subset of the elements to be accessed, the maximal index must be smaller than the number of given elements

Member Function Documentation

◆ operator=()

template<typename T , typename TIndex >

ConstArraySubsetAccessor< T, TIndex > & Ocean::ConstArraySubsetAccessor< T, TIndex >::operator= ( ConstArraySubsetAccessor< T, TIndex > && accessor )

inlinenoexcept

Move operator.

Parameters

accessor Accessor to be moved

Returns: Reference to this object

◆ operator[]()

template<typename T , typename TIndex >

const T & Ocean::ConstArraySubsetAccessor< T, TIndex >::operator[] ( const size_t & index ) const

virtual

Returns one element of this accessor object.

See also: ConstAccessor::operator[].

Implements Ocean::ConstIndexedAccessor< T >.

◆ size()

template<typename T , typename TIndex >

size_t Ocean::ConstArraySubsetAccessor< T, TIndex >::size

virtual

Returns the number of accessible elements of this accessor object.

See also: ConstAccessor::size().

Implements Ocean::Accessor.

Field Documentation

◆ elements_

template<typename T , typename TIndex >

const T* Ocean::ConstArraySubsetAccessor< T, TIndex >::elements_ = nullptr

protected

The elements of this accessor.

◆ subsetIndices_

template<typename T , typename TIndex >

const TIndex* Ocean::ConstArraySubsetAccessor< T, TIndex >::subsetIndices_ = nullptr

protected

The subset indices of this accessor.

◆ subsetSize_

template<typename T , typename TIndex >

size_t Ocean::ConstArraySubsetAccessor< T, TIndex >::subsetSize_ = 0

protected

The number of elements that can be accessed.

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

Accessor.h

Public Types

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

template<typename T, typename TIndex> class Ocean::ConstArraySubsetAccessor< T, TIndex >

Member Typedef Documentation

◆ IndexType

Constructor & Destructor Documentation

◆ ConstArraySubsetAccessor() [1/5]

◆ ConstArraySubsetAccessor() [2/5]

◆ ConstArraySubsetAccessor() [3/5]

◆ ConstArraySubsetAccessor() [4/5]

◆ ConstArraySubsetAccessor() [5/5]

Member Function Documentation

◆ operator=()

◆ operator[]()

◆ size()

Field Documentation

◆ elements_

◆ subsetIndices_

◆ subsetSize_

template<typename T, typename TIndex>
class Ocean::ConstArraySubsetAccessor< T, TIndex >