This class implements an accessor providing direct access to an array of elements. More...

#include <Accessor.h>

Inheritance diagram for Ocean::NonconstArrayAccessor< T >:

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

	NonconstArrayAccessor (NonconstArrayAccessor< T > &&accessor) noexcept
	Move constructor.

	NonconstArrayAccessor (T *elements, const size_t size)
	Creates a new accessor object.

	NonconstArrayAccessor (std::vector< T > &elements)
	Creates a new accessor object.

	NonconstArrayAccessor (std::vector< T > &elements, const size_t resizeSize)
	Creates a new accessor object.

	NonconstArrayAccessor (std::vector< T > *elements, const size_t resizeSize=0)
	Creates a new accessor object.

virtual T *	data ()
	Returns a pointer to the elements of this accessor if the data exists within one memory block without gaps.

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

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

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

NonconstArrayAccessor< T > &	operator= (NonconstArrayAccessor< T > &&accessor) noexcept
	Move operator.

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

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

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.

NonconstIndexedAccessor< T > *	pointer ()
	Returns the pointer to this object if this accessor holds at least one element (if this accessor is not empty).

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

virtual bool	canAccess (const TKey &key) const =0
	Returns whether this accessor has a specific element.

virtual bool	firstElement (T &element, TKey &key) const =0
	Returns the first element of this accessor.

virtual bool	nextElement (const TKey &previousKey, T &nextElement, TKey &nextKey) const =0
	Returns the next element which follows a given key of the previous element.

virtual const T &	operator[] (const TKey &key) const =0
	Returns one element of this accessor object by a given key.

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

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

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

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

Additional Inherited Members
Public Types inherited from Ocean::ConstAccessor< T, TKey >
typedef T	Type
	Definition of the element type of this accessor.

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

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).

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.

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).

Protected Member Functions inherited from Ocean::NonconstIndexedAccessor< T >
	NonconstIndexedAccessor ()=default
	Creates a new accessor object.

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

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

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

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

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

Detailed Description

template<typename T>
class Ocean::NonconstArrayAccessor< T >

This class implements an accessor providing direct access to an array of elements.

An instance of this accessor does not copy the elements, 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

Constructor & Destructor Documentation

◆ NonconstArrayAccessor() [1/6]

template<typename T >

Ocean::NonconstArrayAccessor< T >::NonconstArrayAccessor ( )

default

Creates a new empty accessor.

◆ NonconstArrayAccessor() [2/6]

template<typename T >

Ocean::NonconstArrayAccessor< T >::NonconstArrayAccessor ( NonconstArrayAccessor< T > && accessor )

inlinenoexcept

Move constructor.

Parameters

accessor Accessor to be moved

◆ NonconstArrayAccessor() [3/6]

template<typename T >

Ocean::NonconstArrayAccessor< T >::NonconstArrayAccessor	(	T *	elements,
		const size_t	size
	)

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
size	The number of elements that can be accessed, may be 0 if elements is nullptr

◆ NonconstArrayAccessor() [4/6]

template<typename T >

Ocean::NonconstArrayAccessor< T >::NonconstArrayAccessor ( std::vector< T > & elements )

inlineexplicit

Creates a new accessor object.

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

Parameters

elements A vector holding all elements

◆ NonconstArrayAccessor() [5/6]

template<typename T >

Ocean::NonconstArrayAccessor< T >::NonconstArrayAccessor	(	std::vector< T > &	elements,
		const size_t	resizeSize
	)

inline

Creates a new accessor object.

This constructor simplifies the creation of an optional NonconstArrayAccessor object by allowing to provide an empty vector object while defining an explicit resize value.
Beware: The given elements are not copied, they must not be deleted before the accessor is disposed.

Parameters

elements	A vector holding all elements
resizeSize	An explicit resize value that will invoke a resizing of the given vector before the vector is connected with the accessor, with range [1, infinity), 0 to avoid any resizing

◆ NonconstArrayAccessor() [6/6]

template<typename T >

Ocean::NonconstArrayAccessor< T >::NonconstArrayAccessor	(	std::vector< T > *	elements,
		const size_t	resizeSize = `0`
	)

inlineexplicit

Creates a new accessor object.

This constructor simplifies the creation of an optional NonconstArrayAccessor object.
Beware: The given elements are not copied, they must not be deleted before the accessor is disposed.

Parameters

elements	An optional vector holding all elements, nullptr to create an empty invalid accessor
resizeSize	An optional possibility to resize the provided elements vector (if defined - otherwise nothing happens), with range [1, infinity), 0 to avoid any resizing

Member Function Documentation

◆ data()

template<typename T >

T * Ocean::NonconstArrayAccessor< T >::data ( )

virtual

Returns a pointer to the elements of this accessor if the data exists within one memory block without gaps.

See also: NonconstAccessor::data().

Reimplemented from Ocean::NonconstAccessor< T, size_t >.

◆ operator=()

template<typename T >

NonconstArrayAccessor< T > & Ocean::NonconstArrayAccessor< T >::operator= ( NonconstArrayAccessor< T > && accessor )

inlinenoexcept

Move operator.

Parameters

accessor Accessor to be moved

Returns: Reference to this accessor

◆ operator[]() [1/2]

template<typename T >

T & Ocean::NonconstArrayAccessor< T >::operator[] ( const size_t & index )

virtual

Returns one element of this accessor object.

See also: ConstAccessor::operator[].

Implements Ocean::NonconstIndexedAccessor< T >.

◆ operator[]() [2/2]

template<typename T >

const T & Ocean::NonconstArrayAccessor< T >::operator[] ( const size_t & index ) const

virtual

Returns one element of this accessor object.

See also: ConstAccessor::operator[].

Implements Ocean::NonconstIndexedAccessor< T >.

◆ size()

template<typename T >

size_t Ocean::NonconstArrayAccessor< T >::size ( ) const

virtual

Returns the number of accessible elements of this accessor object.

See also: ConstAccessor::size().

Implements Ocean::Accessor.

Field Documentation

◆ elements_

template<typename T >

T* Ocean::NonconstArrayAccessor< T >::elements_ = nullptr

protected

The elements of this accessor.

◆ size_

template<typename T >

size_t Ocean::NonconstArrayAccessor< T >::size_ = 0

protected

The number of elements that can be accessed.

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

Accessor.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ NonconstArrayAccessor() [1/6]

◆ NonconstArrayAccessor() [2/6]

◆ NonconstArrayAccessor() [3/6]

◆ NonconstArrayAccessor() [4/6]

◆ NonconstArrayAccessor() [5/6]

◆ NonconstArrayAccessor() [6/6]

Member Function Documentation

◆ data()

◆ operator=()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ size()

Field Documentation

◆ elements_

◆ size_