Orocos Real-Time Toolkit  2.5.0
Public Types | Public Member Functions | Public Attributes
RTT::extras::MultiVector< S, T > Struct Template Reference

A static allocated Vector. More...

#include <rtt/extras/MultiVector.hpp>

List of all members.

Public Types

enum  Size { size = S }
 The size of this MultiVector is stored in this enum.
typedef T DataType [S]
 You can use DataType if you want to refer to a pointer holding S elements.

Public Member Functions

 operator const T * () const
 Returns a pointer to the data.
 operator T & ()
 Returns a reference to the data.
 MultiVector (const T d)
 Creates a vector with all elements initialized to d.
 MultiVector ()
 Creates a vector with all elements initialized to zero.
template<class Alloc >
 MultiVector (const std::vector< T, Alloc > &vect)
 Creates a vector from a std::vector.
MultiVector & operator+= (const MultiVector &d)
 Adds another MultiVector to this MultiVector.
MultiVector & operator*= (const MultiVector &d)
 Vector product of another MultiVector with this MultiVector.
MultiVector & operator*= (const T d)
 Scalar product of a scalar with this MultiVector.
MultiVector operator- (const MultiVector &d) const
 Returns the difference between this and another MultiVector.
MultiVector operator- () const
MultiVector operator+ (const MultiVector &d) const
 Returns the addition of this and another MultiVector.
MultiVector operator* (const MultiVector &d) const
 Returns the vector product of this and another MultiVector.
MultiVector operator/ (const T d) const
MultiVector operator* (const T d) const
 Returns the scalar product of this and a scalar value.
MultiVector & operator= (const MultiVector &d)
 Assigns all elements of this MultiVector to all elements of another MultiVector.
bool operator== (const MultiVector &d)
 Compares all elements of this MultiVector to all elements of another MultiVector.
bool operator!= (const MultiVector &d)
 Compares elements of this MultiVector are different from elements of another MultiVector.
template<class Alloc >
void getVector (std::vector< T, Alloc > &vect) const
 Return the contents of this MultiVector as an std::vector Resizes vect to the size of this MultiVector.
template<class Alloc >
bool setVector (const std::vector< T, Alloc > &vect)
 Set the contents of this MultiVector from an std::vector.
MultiVector & operator= (const T d)
 Assigns a scalar value to all elements of this Multivector and returns a reference of the result.
T & operator[] (unsigned int i)
 Not checked index operator to the internal data.

Public Attributes

DataType data
 The data contained in the MultiVector.

Detailed Description

template<unsigned S = 6, class T = double>
struct RTT::extras::MultiVector< S, T >

A static allocated Vector.

The MultiVector is an n (defaults to 6) dimensional vector of any type T, mostly used for holding primitive types. Most common casting and operators are defined on this class.

Parameters:
SThe number of elements in the vector
TThe type of all elements in the vector

Definition at line 72 of file MultiVector.hpp.

Constructor & Destructor Documentation

template<unsigned S = 6, class T = double>
RTT::extras::MultiVector< S, T >::MultiVector ( const T  d) [inline]

Creates a vector with all elements initialized to d.

Parameters:
dThe value to be used for initialisation of all elements

Definition at line 113 of file MultiVector.hpp.

References RTT::extras::MultiVector< S, T >::data.

template<unsigned S = 6, class T = double>
template<class Alloc >
RTT::extras::MultiVector< S, T >::MultiVector ( const std::vector< T, Alloc > &  vect) [inline]

Creates a vector from a std::vector.

If there are more items in vect than the size of this Multivector, they are ignored, if there are less items in vect, the remainder is filled with zeros.

Definition at line 135 of file MultiVector.hpp.

References RTT::extras::MultiVector< S, T >::data.

Member Function Documentation

template<unsigned S = 6, class T = double>
bool RTT::extras::MultiVector< S, T >::operator!= ( const MultiVector< S, T > &  d) [inline]

Compares elements of this MultiVector are different from elements of another MultiVector.

Parameters:
dThe other MultiVector to be used.

Definition at line 307 of file MultiVector.hpp.

References RTT::extras::MultiVector< S, T >::data.

template<unsigned S = 6, class T = double>
MultiVector RTT::extras::MultiVector< S, T >::operator* ( const MultiVector< S, T > &  d) const [inline]

Returns the vector product of this and another MultiVector.

Parameters:
dThe other MultiVector to be used.

Definition at line 234 of file MultiVector.hpp.

References RTT::extras::MultiVector< S, T >::data.

template<unsigned S = 6, class T = double>
MultiVector RTT::extras::MultiVector< S, T >::operator* ( const T  d) const [inline]

Returns the scalar product of this and a scalar value.

Parameters:
dThe scalar

Definition at line 260 of file MultiVector.hpp.

References RTT::extras::MultiVector< S, T >::data.

template<unsigned S = 6, class T = double>
MultiVector& RTT::extras::MultiVector< S, T >::operator*= ( const MultiVector< S, T > &  d) [inline]

Vector product of another MultiVector with this MultiVector.

Parameters:
dThe other MultiVector to be used.

Definition at line 164 of file MultiVector.hpp.

References RTT::extras::MultiVector< S, T >::data.

template<unsigned S = 6, class T = double>
MultiVector& RTT::extras::MultiVector< S, T >::operator*= ( const T  d) [inline]

Scalar product of a scalar with this MultiVector.

Parameters:
dThe scalar

Definition at line 178 of file MultiVector.hpp.

References RTT::extras::MultiVector< S, T >::data.

template<unsigned S = 6, class T = double>
MultiVector RTT::extras::MultiVector< S, T >::operator+ ( const MultiVector< S, T > &  d) const [inline]

Returns the addition of this and another MultiVector.

Parameters:
dThe other MultiVector to be used.

Definition at line 218 of file MultiVector.hpp.

References RTT::extras::MultiVector< S, T >::data.

template<unsigned S = 6, class T = double>
MultiVector& RTT::extras::MultiVector< S, T >::operator+= ( const MultiVector< S, T > &  d) [inline]

Adds another MultiVector to this MultiVector.

Parameters:
dThe other MultiVector to be used.

Definition at line 150 of file MultiVector.hpp.

References RTT::extras::MultiVector< S, T >::data.

template<unsigned S = 6, class T = double>
MultiVector RTT::extras::MultiVector< S, T >::operator- ( const MultiVector< S, T > &  d) const [inline]

Returns the difference between this and another MultiVector.

Parameters:
dThe other MultiVector to be used.

Definition at line 192 of file MultiVector.hpp.

References RTT::extras::MultiVector< S, T >::data.

template<unsigned S = 6, class T = double>
MultiVector& RTT::extras::MultiVector< S, T >::operator= ( const MultiVector< S, T > &  d) [inline]

Assigns all elements of this MultiVector to all elements of another MultiVector.

Parameters:
dThe other MultiVector to be used.

Definition at line 277 of file MultiVector.hpp.

References RTT::extras::MultiVector< S, T >::data.

template<unsigned S = 6, class T = double>
MultiVector& RTT::extras::MultiVector< S, T >::operator= ( const T  d) [inline]

Assigns a scalar value to all elements of this Multivector and returns a reference of the result.

Parameters:
dThe scalar

Definition at line 364 of file MultiVector.hpp.

References RTT::extras::MultiVector< S, T >::data.

template<unsigned S = 6, class T = double>
bool RTT::extras::MultiVector< S, T >::operator== ( const MultiVector< S, T > &  d) [inline]

Compares all elements of this MultiVector to all elements of another MultiVector.

Parameters:
dThe other MultiVector to be used.

Definition at line 292 of file MultiVector.hpp.

References RTT::extras::MultiVector< S, T >::data.

template<unsigned S = 6, class T = double>
T& RTT::extras::MultiVector< S, T >::operator[] ( unsigned int  i) [inline]

Not checked index operator to the internal data.

Parameters:
iThe element to be accessed starting from zero.

Definition at line 379 of file MultiVector.hpp.

References RTT::extras::MultiVector< S, T >::data.

template<unsigned S = 6, class T = double>
template<class Alloc >
bool RTT::extras::MultiVector< S, T >::setVector ( const std::vector< T, Alloc > &  vect) [inline]

Set the contents of this MultiVector from an std::vector.

Returns:
false if vect has wrong size.

Definition at line 332 of file MultiVector.hpp.

References RTT::extras::MultiVector< S, T >::data.

Member Data Documentation

template<unsigned S = 6, class T = double>
DataType RTT::extras::MultiVector< S, T >::data

The data contained in the MultiVector.

You can access it freely.

Definition at line 89 of file MultiVector.hpp.

Referenced by RTT::extras::MultiVector< S, T >::getVector(), RTT::extras::MultiVector< S, T >::MultiVector(), RTT::extras::MultiVector< S, T >::operator const T *(), RTT::extras::MultiVector< S, T >::operator T &(), RTT::extras::MultiVector< S, T >::operator!=(), RTT::extras::MultiVector< S, T >::operator*(), RTT::extras::MultiVector< S, T >::operator*=(), RTT::extras::MultiVector< S, T >::operator+(), RTT::extras::MultiVector< S, T >::operator+=(), RTT::extras::MultiVector< S, T >::operator-(), RTT::extras::MultiVector< S, T >::operator=(), RTT::extras::MultiVector< S, T >::operator==(), RTT::extras::MultiVector< S, T >::operator[](), and RTT::extras::MultiVector< S, T >::setVector().

The documentation for this struct was generated from the following file:
Generated on Sat Feb 16 2013 01:31:19 for Orocos Real-Time Toolkit by   doxygen 1.7.6.1