tatami::ArrayView< Type_ > Class Template Reference

View into a pre-allocated array. More...

#include <ArrayView.hpp>

Public Member Functions
	ArrayView (const Type_ *const ptr, const std::size_t number)
	ArrayView ()
std::size_t	size () const
const Type_ *	data () const
const Type_ *	begin () const
const Type_ *	end () const
Type_	operator[] (std::size_t i) const

Detailed Description

template<typename Type_>
class tatami::ArrayView< Type_ >

View into a pre-allocated array.

This allows us to use a pre-existing array in the tatami classes, assuming that the array lives longer than the view created on it. We provide some methods to mimic a std::vector for use within the tatami constructors. This is implemented in lieu of having access to C++20's std::span class.

Template Parameters

Type_

Array type, usually numeric.

Constructor & Destructor Documentation

ArrayView() [1/2]

template<typename Type_ >

tatami::ArrayView< Type_ >::ArrayView ( const Type_ *const ptr, const std::size_t number )

inline

Parameters

[in]	ptr	Pointer to the start of the array. The lifetime of the array is assumed to exceed that of the constructed ArrayView instance.
	number	Number of array elements.

ArrayView() [2/2]

template<typename Type_ >

tatami::ArrayView< Type_ >::ArrayView ( )

inline

Default constructor to create a zero-length view.

Member Function Documentation

size()

template<typename Type_ >

std::size_t tatami::ArrayView< Type_ >::size ( ) const

inline

Returns

Number of array elements.

data()

template<typename Type_ >

const Type_ * tatami::ArrayView< Type_ >::data ( ) const

inline

Returns

Pointer to the start of the array.

begin()

template<typename Type_ >

const Type_ * tatami::ArrayView< Type_ >::begin ( ) const

inline

Returns

Pointer to the start of the array.

end()

template<typename Type_ >

const Type_ * tatami::ArrayView< Type_ >::end ( ) const

inline

Returns

Pointer to one-past-the-end of the array.

operator[]()

template<typename Type_ >

Type_ tatami::ArrayView< Type_ >::operator[] ( std::size_t i ) const

inline

Parameters

i	Index of the array.

Returns

Value of the array at element i.

---

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

• tatami/utils/ArrayView.hpp