YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
yarp::sig::VectorBase< Derived, Scalar > Class Template Reference

#include <yarp/sig/VectorBase.h>

+ Inheritance diagram for yarp::sig::VectorBase< Derived, Scalar >:

Public Types

using value_type = Scalar
 
using iterator = typename std::vector< Scalar >::iterator
 
using const_iterator = typename std::vector< Scalar >::const_iterator
 

Public Member Functions

 VectorBase ()=default
 
 VectorBase (size_t size)
 
 VectorBase (std::initializer_list< Scalar > values)
 Initializer list constructor.
 
 VectorBase (size_t s, const Scalar &def)
 Build a vector and initialize it with def.
 
 VectorBase (size_t s, const Scalar *p)
 Builds a vector and initialize it with values from 'p'.
 
 VectorBase (const VectorBase &r)=default
 
VectorBase< Derived, Scalar > & operator= (const VectorBase< Derived, Scalar > &r)=default
 
 VectorBase (VectorBase< Derived, Scalar > &&other) noexcept=default
 
VectorBase & operator= (VectorBase< Derived, Scalar > &&other) noexcept=default
 
 ~VectorBase ()=default
 
size_t capacity () const
 Returns the capacity of the vector.
 
void reserve (size_t size)
 Reserve space in the vector.
 
void resize (size_t size)
 Resize the vector.
 
void pop_back ()
 Pop an element out of the vector: size is changed.
 
Scalar & operator[] (size_t i)
 Single element access, no range check.
 
const Scalar & operator[] (size_t i) const
 Single element access, no range check, const version.
 
Scalar & operator() (size_t i)
 Single element access, no range check.
 
const Scalar & operator() (size_t i) const
 Single element access, no range check, const version.
 
size_t size () const
 Returns the number of elements in the vector.
 
Derived & operator= (const Scalar &val)
 
Derived & operator= (std::initializer_list< Scalar > values)
 Initializer list assignment.
 
void clear ()
 Clear (removes all elements) the vector.
 
void push_back (const Scalar &elem)
 Push a new element in the vector: size is changed.
 
void push_back (Scalar &&elem)
 Move a new element in the vector: size is changed.
 
Scalar * data ()
 Return a pointer to the first element of the vector.
 
const Scalar * data () const
 Return a pointer to the first element of the vector, const version.
 
Derived subVector (unsigned int first, unsigned int last) const
 Creates and returns a new vector, being the portion of the original vector defined by the first and last indexes of the items to be included in the subvector.
 
void resize (size_t size, const Scalar &def)
 Resize the vector and initialize the element to a default value.
 
void zero ()
 Set to zero the elements of the vector.
 
iterator begin () noexcept
 Returns an iterator to the beginning of the Vector.
 
iterator end () noexcept
 
const_iterator begin () const noexcept
 
const_iterator end () const noexcept
 
const_iterator cbegin () const noexcept
 
void erase (iterator pos)
 Remove an element from the vector.
 
void erase (iterator first, iterator last)
 Remove one or more elements from the vector.
 
size_t getElementSize () const
 

Friends

bool operator== (const Derived &l, const Derived &r)
 

Detailed Description

template<typename Derived, typename Scalar>
class yarp::sig::VectorBase< Derived, Scalar >

Definition at line 25 of file VectorBase.h.

Member Typedef Documentation

◆ const_iterator

template<typename Derived , typename Scalar >
using yarp::sig::VectorBase< Derived, Scalar >::const_iterator = typename std::vector<Scalar>::const_iterator

Definition at line 31 of file VectorBase.h.

◆ iterator

template<typename Derived , typename Scalar >
using yarp::sig::VectorBase< Derived, Scalar >::iterator = typename std::vector<Scalar>::iterator

Definition at line 30 of file VectorBase.h.

◆ value_type

template<typename Derived , typename Scalar >
using yarp::sig::VectorBase< Derived, Scalar >::value_type = Scalar

Definition at line 29 of file VectorBase.h.

Constructor & Destructor Documentation

◆ VectorBase() [1/7]

template<typename Derived , typename Scalar >
yarp::sig::VectorBase< Derived, Scalar >::VectorBase ( )
default

◆ VectorBase() [2/7]

template<typename Derived , typename Scalar >
yarp::sig::VectorBase< Derived, Scalar >::VectorBase ( size_t  size)
inline

Definition at line 35 of file VectorBase.h.

◆ VectorBase() [3/7]

template<typename Derived , typename Scalar >
yarp::sig::VectorBase< Derived, Scalar >::VectorBase ( std::initializer_list< Scalar >  values)
inline

Initializer list constructor.

Parameters
[in]values,listof values with which initialize the Vector.

Definition at line 45 of file VectorBase.h.

◆ VectorBase() [4/7]

template<typename Derived , typename Scalar >
yarp::sig::VectorBase< Derived, Scalar >::VectorBase ( size_t  s,
const Scalar &  def 
)
inline

Build a vector and initialize it with def.

Parameters
sthe size
defa default value used to fill the vector

Definition at line 57 of file VectorBase.h.

◆ VectorBase() [5/7]

template<typename Derived , typename Scalar >
yarp::sig::VectorBase< Derived, Scalar >::VectorBase ( size_t  s,
const Scalar *  p 
)
inline

Builds a vector and initialize it with values from 'p'.

Copies memory.

Parameters
sthe size of the data to be copied
T*the pointer to the data

Definition at line 68 of file VectorBase.h.

◆ VectorBase() [6/7]

template<typename Derived , typename Scalar >
yarp::sig::VectorBase< Derived, Scalar >::VectorBase ( const VectorBase< Derived, Scalar > &  r)
default

◆ VectorBase() [7/7]

template<typename Derived , typename Scalar >
yarp::sig::VectorBase< Derived, Scalar >::VectorBase ( VectorBase< Derived, Scalar > &&  other)
defaultnoexcept

◆ ~VectorBase()

template<typename Derived , typename Scalar >
yarp::sig::VectorBase< Derived, Scalar >::~VectorBase ( )
default

Member Function Documentation

◆ begin() [1/2]

template<typename Derived , typename Scalar >
const_iterator yarp::sig::VectorBase< Derived, Scalar >::begin ( ) const
inlinenoexcept

Definition at line 317 of file VectorBase.h.

◆ begin() [2/2]

template<typename Derived , typename Scalar >
iterator yarp::sig::VectorBase< Derived, Scalar >::begin ( )
inlinenoexcept

Returns an iterator to the beginning of the Vector.

Definition at line 305 of file VectorBase.h.

◆ capacity()

template<typename Derived , typename Scalar >
size_t yarp::sig::VectorBase< Derived, Scalar >::capacity ( ) const
inline

Returns the capacity of the vector.

Returns
the capacity of the vector.

Definition at line 86 of file VectorBase.h.

◆ cbegin()

template<typename Derived , typename Scalar >
const_iterator yarp::sig::VectorBase< Derived, Scalar >::cbegin ( ) const
inlinenoexcept

Definition at line 329 of file VectorBase.h.

◆ clear()

template<typename Derived , typename Scalar >
void yarp::sig::VectorBase< Derived, Scalar >::clear ( )
inline

Clear (removes all elements) the vector.

Definition at line 216 of file VectorBase.h.

◆ data() [1/2]

template<typename Derived , typename Scalar >
Scalar * yarp::sig::VectorBase< Derived, Scalar >::data ( )
inline

Return a pointer to the first element of the vector.

Returns
a pointer to double (or nullptr if the vector is of zero length)

Definition at line 245 of file VectorBase.h.

◆ data() [2/2]

template<typename Derived , typename Scalar >
const Scalar * yarp::sig::VectorBase< Derived, Scalar >::data ( ) const
inline

Return a pointer to the first element of the vector, const version.

Returns
a (const) pointer to double (or nullptr if the vector is of zero length)

Definition at line 256 of file VectorBase.h.

◆ end() [1/2]

template<typename Derived , typename Scalar >
const_iterator yarp::sig::VectorBase< Derived, Scalar >::end ( ) const
inlinenoexcept

Definition at line 323 of file VectorBase.h.

◆ end() [2/2]

template<typename Derived , typename Scalar >
iterator yarp::sig::VectorBase< Derived, Scalar >::end ( )
inlinenoexcept

Definition at line 311 of file VectorBase.h.

◆ erase() [1/2]

template<typename Derived , typename Scalar >
void yarp::sig::VectorBase< Derived, Scalar >::erase ( iterator  first,
iterator  last 
)
inline

Remove one or more elements from the vector.

Parameters
firstiterator pointing at the first element to remove
lastiterator pointing at the last element to remove

Definition at line 350 of file VectorBase.h.

◆ erase() [2/2]

template<typename Derived , typename Scalar >
void yarp::sig::VectorBase< Derived, Scalar >::erase ( iterator  pos)
inline

Remove an element from the vector.

Parameters
positerator pointing at the element to remove

Definition at line 339 of file VectorBase.h.

◆ getElementSize()

template<typename Derived , typename Scalar >
size_t yarp::sig::VectorBase< Derived, Scalar >::getElementSize ( ) const
inline

Definition at line 356 of file VectorBase.h.

◆ operator()() [1/2]

template<typename Derived , typename Scalar >
Scalar & yarp::sig::VectorBase< Derived, Scalar >::operator() ( size_t  i)
inline

Single element access, no range check.

Parameters
ithe index of the element to access.
Returns
a reference to the requested element.

Definition at line 147 of file VectorBase.h.

◆ operator()() [2/2]

template<typename Derived , typename Scalar >
const Scalar & yarp::sig::VectorBase< Derived, Scalar >::operator() ( size_t  i) const
inline

Single element access, no range check, const version.

Parameters
ithe index of the element to access.
Returns
a reference to the requested element.

Definition at line 158 of file VectorBase.h.

◆ operator=() [1/4]

template<typename Derived , typename Scalar >
Derived & yarp::sig::VectorBase< Derived, Scalar >::operator= ( const Scalar &  val)
inline

Definition at line 173 of file VectorBase.h.

◆ operator=() [2/4]

template<typename Derived , typename Scalar >
VectorBase< Derived, Scalar > & yarp::sig::VectorBase< Derived, Scalar >::operator= ( const VectorBase< Derived, Scalar > &  r)
default

◆ operator=() [3/4]

template<typename Derived , typename Scalar >
Derived & yarp::sig::VectorBase< Derived, Scalar >::operator= ( std::initializer_list< Scalar >  values)
inline

Initializer list assignment.

Parameters
[in]values,listof values with which to assign the Vector.

Definition at line 186 of file VectorBase.h.

◆ operator=() [4/4]

template<typename Derived , typename Scalar >
VectorBase & yarp::sig::VectorBase< Derived, Scalar >::operator= ( VectorBase< Derived, Scalar > &&  other)
defaultnoexcept

◆ operator[]() [1/2]

template<typename Derived , typename Scalar >
Scalar & yarp::sig::VectorBase< Derived, Scalar >::operator[] ( size_t  i)
inline

Single element access, no range check.

Parameters
ithe index of the element to access.
Returns
a reference to the requested element.

Definition at line 125 of file VectorBase.h.

◆ operator[]() [2/2]

template<typename Derived , typename Scalar >
const Scalar & yarp::sig::VectorBase< Derived, Scalar >::operator[] ( size_t  i) const
inline

Single element access, no range check, const version.

Parameters
ithe index of the element to access.
Returns
a reference to the requested element.

Definition at line 136 of file VectorBase.h.

◆ pop_back()

template<typename Derived , typename Scalar >
void yarp::sig::VectorBase< Derived, Scalar >::pop_back ( )
inline

Pop an element out of the vector: size is changed.

Definition at line 114 of file VectorBase.h.

◆ push_back() [1/2]

template<typename Derived , typename Scalar >
void yarp::sig::VectorBase< Derived, Scalar >::push_back ( const Scalar &  elem)
inline

Push a new element in the vector: size is changed.

Definition at line 225 of file VectorBase.h.

◆ push_back() [2/2]

template<typename Derived , typename Scalar >
void yarp::sig::VectorBase< Derived, Scalar >::push_back ( Scalar &&  elem)
inline

Move a new element in the vector: size is changed.

Parameters
elem,elementto be moved.

Definition at line 235 of file VectorBase.h.

◆ reserve()

template<typename Derived , typename Scalar >
void yarp::sig::VectorBase< Derived, Scalar >::reserve ( size_t  size)
inline

Reserve space in the vector.

Parameters
sizethe new capacity of the vector.

Definition at line 96 of file VectorBase.h.

◆ resize() [1/2]

template<typename Derived , typename Scalar >
void yarp::sig::VectorBase< Derived, Scalar >::resize ( size_t  size)
inline

Resize the vector.

Parameters
sizethe new size of the vector.

Definition at line 106 of file VectorBase.h.

◆ resize() [2/2]

template<typename Derived , typename Scalar >
void yarp::sig::VectorBase< Derived, Scalar >::resize ( size_t  size,
const Scalar &  def 
)
inline

Resize the vector and initialize the element to a default value.

Parameters
sthe new size
defthe default value

Definition at line 286 of file VectorBase.h.

◆ size()

template<typename Derived , typename Scalar >
size_t yarp::sig::VectorBase< Derived, Scalar >::size ( ) const
inline

Returns the number of elements in the vector.

Definition at line 167 of file VectorBase.h.

◆ subVector()

template<typename Derived , typename Scalar >
Derived yarp::sig::VectorBase< Derived, Scalar >::subVector ( unsigned int  first,
unsigned int  last 
) const
inline

Creates and returns a new vector, being the portion of the original vector defined by the first and last indexes of the items to be included in the subvector.

The indexes are checked: if wrong, a null vector is returned.

Definition at line 268 of file VectorBase.h.

◆ zero()

template<typename Derived , typename Scalar >
void yarp::sig::VectorBase< Derived, Scalar >::zero ( )
inline

Set to zero the elements of the vector.

Definition at line 296 of file VectorBase.h.

Friends And Related Symbol Documentation

◆ operator==

template<typename Derived , typename Scalar >
bool operator== ( const Derived &  l,
const Derived &  r 
)
friend

Definition at line 204 of file VectorBase.h.


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