trust::ArrayView< T > Class Template Reference

A view over a continuous sequence of objects. More...

#include <ArrayView.h>

Inheritance diagram for trust::ArrayView< T >:

Collaboration diagram for trust::ArrayView< T >:

Public Types
using	value_type = typename ArrayViewTraits< T >::value_type
using	reference = typename ArrayViewTraits< T >::reference
using	const_reference = typename ArrayViewTraits< T >::const_reference
using	const_pointer = typename ArrayViewTraits< T >::const_pointer
using	pointer = typename ArrayViewTraits< T >::pointer
using	size_type = typename ArrayViewTraits< T >::size_type
using	difference_type = typename ArrayViewTraits< T >::difference_type

Public Member Functions
	ArrayView ()=default
	~ArrayView () noexcept=default
	ArrayView (const ArrayView &)=default
ArrayView &	operator= (const ArrayView &)=default
	ArrayView (ArrayView &&)=default
ArrayView &	operator= (ArrayView &&)=default
	ArrayView (pointer src, size_type size)
	ArrayView (std::nullptr_t, size_type)
template<typename U >
	ArrayView (ArrayView< U > &src)
template<typename U >
	ArrayView (const ArrayView< U > &src)
template<typename U >
	ArrayView (ArrayView< U > &&src)
template<typename U , typename std::enable_if<!std::is_rvalue_reference< U && >::value, int >::type = 0>
	ArrayView (U &&src)
size_type	size () const
pointer	data ()
const_pointer	data () const
pointer	begin ()
pointer	end ()
const_pointer	cbegin () const
const_pointer	cend () const
const_pointer	begin () const
const_pointer	end () const
reference	operator[] (std::size_t index)
const_reference	operator[] (std::size_t index) const
reference	at (std::size_t index)
const_reference	at (std::size_t index) const
ArrayView	subview (std::size_t offset, std::size_t count) const
ArrayView	first (std::size_t count) const
ArrayView	last (std::size_t count) const

Private Attributes
pointer	ptr {nullptr}
size_type	sz {}

Detailed Description

template<typename T>
class trust::ArrayView< T >

A view over a continuous sequence of objects.

Template Parameters

T

element type Provides a view over a continuous sequence of objects owned by some other object. Contains a count of elements and a pointer to a location where they are stored. ArrayView does not own the mmemory it points to - it does not perform any allocation and deallocation. It can be constructed given a pointer and element count, or a container type argument. The class provides helper methods for creating subviews over the objects, and methods for by-value comparison with containers. ConstArrayView represents an immutable view.

Member Typedef Documentation

const_pointer

template<typename T >

using trust::ArrayView< T >::const_pointer = typename ArrayViewTraits<T>::const_pointer

const_reference

template<typename T >

using trust::ArrayView< T >::const_reference = typename ArrayViewTraits<T>::const_reference

difference_type

template<typename T >

using trust::ArrayView< T >::difference_type = typename ArrayViewTraits<T>::difference_type

pointer

template<typename T >

using trust::ArrayView< T >::pointer = typename ArrayViewTraits<T>::pointer

reference

template<typename T >

using trust::ArrayView< T >::reference = typename ArrayViewTraits<T>::reference

size_type

template<typename T >

using trust::ArrayView< T >::size_type = typename ArrayViewTraits<T>::size_type

value_type

template<typename T >

using trust::ArrayView< T >::value_type = typename ArrayViewTraits<T>::value_type

Constructor & Destructor Documentation

ArrayView() [1/9]

template<typename T >

trust::ArrayView< T >::ArrayView ( )

default

~ArrayView()

template<typename T >

trust::ArrayView< T >::~ArrayView ( )

defaultnoexcept

ArrayView() [2/9]

template<typename T >

trust::ArrayView< T >::ArrayView ( const ArrayView< T > &  )

default

ArrayView() [3/9]

template<typename T >

trust::ArrayView< T >::ArrayView ( ArrayView< T > &&  )

default

ArrayView() [4/9]

template<typename T >

trust::ArrayView< T >::ArrayView ( pointer  src, size_type  size  )

inline

                                               :
            ptr{src},
            sz{size} {
        }

ArrayView() [5/9]

template<typename T >

trust::ArrayView< T >::ArrayView ( std::nullptr_t  , size_type    )

inline

                                                 : ArrayView{nullptr, {}} {
        }

ArrayView() [6/9]

template<typename T >

template<typename U >

trust::ArrayView< T >::ArrayView ( ArrayView< U > &  src )

inline

                                     : ArrayView{src.data(), src.size()} {
        }

ArrayView() [7/9]

template<typename T >

template<typename U >

trust::ArrayView< T >::ArrayView ( const ArrayView< U > &  src )

inline

                                           : ArrayView{src.data(), src.size()} {
        }

ArrayView() [8/9]

template<typename T >

template<typename U >

trust::ArrayView< T >::ArrayView ( ArrayView< U > &&  src )

inline

                                      : ArrayView{src.data(), src.size()} {
        }

ArrayView() [9/9]

template<typename T >

template<typename U , typename std::enable_if<!std::is_rvalue_reference< U && >::value, int >::type = 0>

trust::ArrayView< T >::ArrayView ( U &&  src )

inlineexplicit

                                    : ArrayView{src.data(), src.size()} {
        }

Member Function Documentation

at() [1/2]

template<typename T >

reference trust::ArrayView< T >::at ( std::size_t  index )

inline

                                      {
            return this->operator[](index);
        }

at() [2/2]

template<typename T >

const_reference trust::ArrayView< T >::at ( std::size_t  index ) const

inline

                                                  {
            return this->operator[](index);
        }

begin() [1/2]

template<typename T >

pointer trust::ArrayView< T >::begin ( )

inline

                        {
            return ptr;
        }

Referenced by trust::operator==(), dnac::DNACalibDNAReaderImpl::setBlendShapeTargetDeltas(), dnac::SetBlendShapeTargetDeltasCommand::Impl::setDeltas(), dnac::SetSkinWeightsCommand::Impl::setJointIndices(), dnac::SetLODsCommand::Impl::setLODs(), dnac::SetBlendShapeTargetDeltasCommand::Impl::setMasks(), dnac::SetVertexPositionsCommand::Impl::setMasks(), dnac::DNACalibDNAReaderImpl::setNeutralJointRotations(), dnac::DNACalibDNAReaderImpl::setNeutralJointTranslations(), dnac::SetVertexPositionsCommand::Impl::setPositions(), dnac::SetNeutralJointRotationsCommand::Impl::setRotations(), dnac::SetNeutralJointTranslationsCommand::Impl::setTranslations(), dnac::DNACalibDNAReaderImpl::setVertexPositions(), and dnac::SetSkinWeightsCommand::Impl::setWeights().

begin() [2/2]

template<typename T >

const_pointer trust::ArrayView< T >::begin ( ) const

inline

                                    {
            return cbegin();
        }

cbegin()

template<typename T >

const_pointer trust::ArrayView< T >::cbegin ( ) const

inline

                                     {
            return ptr;
        }

cend()

template<typename T >

const_pointer trust::ArrayView< T >::cend ( ) const

inline

                                   {
            return ptr + sz;
        }

data() [1/2]

template<typename T >

pointer trust::ArrayView< T >::data ( )

inline

                       {
            return ptr;
        }

Referenced by dna::copyDefinition(), dna::StringView::dataOrEmpty(), dna::findIndices(), and trust::operator==().

data() [2/2]

template<typename T >

const_pointer trust::ArrayView< T >::data ( ) const

inline

                                   {
            return ptr;
        }

end() [1/2]

template<typename T >

pointer trust::ArrayView< T >::end ( )

inline

                      {
            return ptr + sz;
        }

Referenced by trust::operator==(), dnac::DNACalibDNAReaderImpl::setBlendShapeTargetDeltas(), dnac::SetBlendShapeTargetDeltasCommand::Impl::setDeltas(), dnac::SetSkinWeightsCommand::Impl::setJointIndices(), dnac::SetLODsCommand::Impl::setLODs(), dnac::SetBlendShapeTargetDeltasCommand::Impl::setMasks(), dnac::SetVertexPositionsCommand::Impl::setMasks(), dnac::DNACalibDNAReaderImpl::setNeutralJointRotations(), dnac::DNACalibDNAReaderImpl::setNeutralJointTranslations(), dnac::SetVertexPositionsCommand::Impl::setPositions(), dnac::SetNeutralJointRotationsCommand::Impl::setRotations(), dnac::SetNeutralJointTranslationsCommand::Impl::setTranslations(), dnac::DNACalibDNAReaderImpl::setVertexPositions(), and dnac::SetSkinWeightsCommand::Impl::setWeights().

end() [2/2]

template<typename T >

const_pointer trust::ArrayView< T >::end ( ) const

inline

                                  {
            return cend();
        }

first()

template<typename T >

ArrayView trust::ArrayView< T >::first ( std::size_t  count ) const

inline

                                               {
            assert(count <= sz);
            return {ptr, count};
        }

last()

template<typename T >

ArrayView trust::ArrayView< T >::last ( std::size_t  count ) const

inline

                                              {
            assert(count <= sz);
            return {ptr + (sz - count), count};
        }

operator=() [1/2]

template<typename T >

ArrayView & trust::ArrayView< T >::operator= ( ArrayView< T > &&  )

default

operator=() [2/2]

template<typename T >

ArrayView & trust::ArrayView< T >::operator= ( const ArrayView< T > &  )

default

operator[]() [1/2]

template<typename T >

reference trust::ArrayView< T >::operator[] ( std::size_t  index )

inline

                                              {
            assert(index < sz);
            return ptr[index];
        }

operator[]() [2/2]

template<typename T >

const_reference trust::ArrayView< T >::operator[] ( std::size_t  index ) const

inline

                                                          {
            assert(index < sz);
            return ptr[index];
        }

size()

template<typename T >

size_type trust::ArrayView< T >::size ( ) const

inline

                               {
            return sz;
        }

Referenced by trust::operator==().

subview()

template<typename T >

ArrayView trust::ArrayView< T >::subview ( std::size_t  offset, std::size_t  count  ) const

inline

                                                                   {
            assert(offset <= sz);
            assert((offset + count) <= sz);
            return {ptr + offset, count};
        }

Member Data Documentation

ptr

template<typename T >

pointer trust::ArrayView< T >::ptr {nullptr}

private

sz

template<typename T >

size_type trust::ArrayView< T >::sz {}

private

---

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

• ArrayView.h