#include <vctDynamicVector.h>

Inheritance diagram for vctReturnDynamicVector< _elementType >:

Public Types
typedef vctDynamicVector < _elementType >	BaseType

Public Types inherited from vctDynamicVector< _elementType >
typedef vctDynamicVector < _elementType >	ThisType

typedef vctDynamicVectorBase < vctDynamicVectorOwner < _elementType >, _elementType >	BaseType

typedef BaseType::CopyType	CopyType

typedef BaseType::TypeTraits	TypeTraits

typedef BaseType::ElementVaArgPromotion	ElementVaArgPromotion

Public Types inherited from vctDynamicVectorBase< vctDynamicVectorOwner< _elementType >, _elementType >
typedef vctDynamicVectorBase	ThisType

typedef vctDynamicConstVectorBase < vctDynamicVectorOwner < _elementType >, _elementType >	BaseType

typedef vctDynamicVectorOwner < _elementType >	VectorOwnerType

typedef BaseType::iterator	iterator

typedef BaseType::reverse_iterator	reverse_iterator

typedef BaseType::const_iterator	const_iterator

typedef BaseType::const_reverse_iterator	const_reverse_iterator

typedef BaseType::CopyType	CopyType

typedef BaseType::VectorValueType	VectorValueType

typedef class cmnTypeTraits < value_type >	TypeTraits

typedef TypeTraits::VaArgPromotion	ElementVaArgPromotion

Public Types inherited from vctDynamicConstVectorBase< _vectorOwnerType, _elementType >
typedef vctDynamicConstVectorBase < _vectorOwnerType, _elementType >	ThisType

typedef _vectorOwnerType	OwnerType

typedef OwnerType::iterator	iterator

typedef OwnerType::const_iterator	const_iterator

typedef OwnerType::reverse_iterator	reverse_iterator

typedef OwnerType::const_reverse_iterator	const_reverse_iterator

typedef vctDynamicVector < _elementType >	CopyType

typedef vctDynamicVector < _elementType >	VectorValueType

typedef vctDynamicVector < _elementType >	VectorReturnType

typedef cmnTypeTraits< value_type >	TypeTraits

typedef TypeTraits::BoolType	BoolType

typedef vctReturnDynamicVector < BoolType >	BoolVectorReturnType

Public Member Functions
	vctReturnDynamicVector (const BaseType &other)

Public Member Functions inherited from vctDynamicVector< _elementType >
	VCT_CONTAINER_TRAITS_TYPEDEFS (_elementType)

	vctDynamicVector ()

	vctDynamicVector (size_type size)

	vctDynamicVector (size_type size, value_type value)

	vctDynamicVector (size_type size, value_type element0, value_type element1,...) throw (std::runtime_error)

	vctDynamicVector (size_type size, const value_type *values)

	vctDynamicVector (const vctReturnDynamicVector< value_type > &otherVector)

	vctDynamicVector (const ThisType &otherVector)

template<class _otherVectorOwnerType >
	vctDynamicVector (const vctDynamicConstVectorBase< _otherVectorOwnerType, value_type > &otherVector)

template<class _otherVectorOwnerType , typename _otherVectorElementType >
	vctDynamicVector (const vctDynamicConstVectorBase< _otherVectorOwnerType, _otherVectorElementType > &otherVector)

template<size_type __size, stride_type __stride, class __elementType , class __dataPtrType >
	vctDynamicVector (const vctFixedSizeConstVectorBase< __size, __stride, __elementType, __dataPtrType > &fixedVector)

template<class __vectorOwnerType , typename __elementType >
ThisType &	operator= (const vctDynamicConstVectorBase< __vectorOwnerType, __elementType > &otherVector)

ThisType &	operator= (const ThisType &other)

ThisType &	operator= (const vctReturnDynamicVector< value_type > &other)

ThisType &	operator= (const value_type &value)

template<class __vectorOwnerType , typename __elementType >
ThisType &	ForceAssign (const vctDynamicConstVectorBase< __vectorOwnerType, __elementType > &other)

template<size_type __size, stride_type __stride, class __elementType , class __dataPtrType >
ThisType &	ForceAssign (const vctFixedSizeConstVectorBase< __size, __stride, __elementType, __dataPtrType > &other)

void	resize (size_type size)

void	SetSize (size_type size)

bool	FromStreamRaw (std::istream &inputStream, const char delimiter= ' ')

void	DeSerializeRaw (std::istream &inputStream)

template<class _elementType >
	vctDynamicVector (const vctReturnDynamicVector< _elementType > &other)

template<class _elementType >
vctDynamicVector< _elementType > &	operator= (const vctReturnDynamicVector< _elementType > &other)

Public Member Functions inherited from vctDynamicVectorBase< vctDynamicVectorOwner< _elementType >, _elementType >
	VCT_CONTAINER_TRAITS_TYPEDEFS (_elementType)

iterator	begin (void)

const_iterator	begin (void) const

iterator	end (void)

const_iterator	end (void) const

reverse_iterator	rbegin (void)

const_reverse_iterator	rbegin (void) const

reverse_iterator	rend (void)

const_reverse_iterator	rend (void) const

reference	operator[] (index_type index)

const_reference	operator[] (index_type index) const

const VectorOwnerType &	Owner (void) const

VectorOwnerType &	Owner (void)

pointer	Pointer (index_type index=0)

const_pointer	Pointer (index_type index=0) const

reference	at (index_type index) throw (std::out_of_range)

const_reference	at (index_type index) const throw (std::out_of_range)

reference	operator() (index_type index) throw (std::out_of_range)

const_reference	operator() (index_type index) const throw (std::out_of_range)

reference	Element (index_type index)

const_reference	Element (index_type index) const

value_type	SetAll (const value_type value)

bool	Zeros (void)

ThisType &	Assign (const value_type *elements)

ThisType &	Assign (value_type element0, value_type element1,...) throw (std::runtime_error)

ThisType &	ConcatenationOf (const vctDynamicConstVectorBase< __vectorOwnerType, __elementType > &otherVector, __elementType lastElement)

void	SelectFrom (const vctDynamicConstVectorBase< __inputVectorOwner, _elementType > &input, const vctDynamicConstVectorBase< __indexVectorOwner, index_type > &index)

void	CrossProductOf (const vctDynamicConstVectorBase< __vectorOwnerType1, _elementType > &inputVector1, const vctDynamicConstVectorBase< __vectorOwnerType2, _elementType > &inputVector2)

ThisType &	AddProductOf (const value_type scalar, const vctDynamicConstVectorBase< __vectorOwnerType, _elementType > &otherVector)

ThisType &	AddElementwiseProductOf (const vctDynamicConstVectorBase< __vectorOwnerType1, _elementType > &vector1, const vctDynamicConstVectorBase< __vectorOwnerType2, _elementType > &vector2)

ThisType &	Assign (const vctDynamicConstVectorBase< __vectorOwnerType, value_type > &other)

ThisType &	Assign (const vctDynamicConstVectorBase< __vectorOwnerType, value_type > &other, size_type length, size_type startPositionThis=0, size_type startPositionOther=0)

ThisType &	Assign (const vctDynamicConstVectorBase< __vectorOwnerType, __elementType > &other)

ThisType &	Assign (const vctFixedSizeConstVectorBase< __size, __stride, __elementType, __dataPtrType > &other)

ThisType &	operator= (const vctDynamicConstVectorBase< __vectorOwnerType, __elementType > &other)

ThisType &	ForceAssign (const vctDynamicConstVectorBase< __vectorOwnerType, __elementType > &other)

ThisType &	ForceAssign (const vctFixedSizeConstVectorBase< __size, __stride, __elementType, __dataPtrType > &other)

bool	FastCopyOf (const vctDynamicConstVectorBase< __vectorOwnerType, value_type > &source, bool performSafetyChecks=true) throw (std::runtime_error)

bool	FastCopyOf (const vctFixedSizeConstVectorBase< __size, __stride, value_type, __dataPtrType > &source, bool performSafetyChecks=true) throw (std::runtime_error)

value_type &	X (void)

const value_type &	X (void) const

value_type &	Y (void)

const value_type &	Y (void) const

value_type &	Z (void)

const value_type &	Z (void) const

value_type &	W (void)

const value_type &	W (void) const

vctDynamicVectorRef< _elementType >	XY (void)

vctDynamicConstVectorRef < _elementType >	XY (void) const

vctDynamicVectorRef< _elementType >	XZ (void)

vctDynamicConstVectorRef < _elementType >	XZ (void) const

vctDynamicVectorRef< _elementType >	XW (void)

vctDynamicConstVectorRef < _elementType >	XW (void) const

vctDynamicVectorRef< _elementType >	YZ (void)

vctDynamicConstVectorRef < _elementType >	YZ (void) const

vctDynamicVectorRef< _elementType >	YW (void)

vctDynamicConstVectorRef < _elementType >	YW (void) const

vctDynamicVectorRef< _elementType >	ZW (void)

vctDynamicConstVectorRef < _elementType >	ZW (void) const

vctDynamicVectorRef< _elementType >	XYZ (void)

vctDynamicConstVectorRef < _elementType >	XYZ (void) const

vctDynamicVectorRef< _elementType >	YZW (void)

vctDynamicConstVectorRef < _elementType >	YZW (void) const

vctDynamicVectorRef< _elementType >	XYZW (void)

vctDynamicConstVectorRef < _elementType >	XYZW (void) const

vctDynamicVectorRef< _elementType >	Ref (const size_type size, const size_type startPosition=0) throw (std::out_of_range)

vctDynamicConstVectorRef < _elementType >	Ref (const size_type size, const size_type startPosition=0) const throw (std::out_of_range)

ThisType &	SumOf (const vctDynamicConstVectorBase< __vectorOwnerType1, _elementType > &vector1, const vctDynamicConstVectorBase< __vectorOwnerType2, _elementType > &vector2)

ThisType &	DifferenceOf (const vctDynamicConstVectorBase< __vectorOwnerType1, _elementType > &vector1, const vctDynamicConstVectorBase< __vectorOwnerType2, _elementType > &vector2)

ThisType &	ElementwiseProductOf (const vctDynamicConstVectorBase< __vectorOwnerType1, _elementType > &vector1, const vctDynamicConstVectorBase< __vectorOwnerType2, _elementType > &vector2)

ThisType &	ElementwiseRatioOf (const vctDynamicConstVectorBase< __vectorOwnerType1, _elementType > &vector1, const vctDynamicConstVectorBase< __vectorOwnerType2, _elementType > &vector2)

ThisType &	ElementwiseMinOf (const vctDynamicConstVectorBase< __vectorOwnerType1, _elementType > &vector1, const vctDynamicConstVectorBase< __vectorOwnerType2, _elementType > &vector2)

ThisType &	ElementwiseMaxOf (const vctDynamicConstVectorBase< __vectorOwnerType1, _elementType > &vector1, const vctDynamicConstVectorBase< __vectorOwnerType2, _elementType > &vector2)

ThisType &	ElementwiseClippedInOf (const vctDynamicConstVectorBase< __vectorOwnerType1, _elementType > &boundVector, const vctDynamicConstVectorBase< __vectorOwnerType2, _elementType > &vector)

ThisType &	Add (const vctDynamicConstVectorBase< __vectorOwnerType, _elementType > &otherVector)

ThisType &	Subtract (const vctDynamicConstVectorBase< __vectorOwnerType, _elementType > &otherVector)

ThisType &	ElementwiseMultiply (const vctDynamicConstVectorBase< __vectorOwnerType, _elementType > &otherVector)

ThisType &	ElementwiseDivide (const vctDynamicConstVectorBase< __vectorOwnerType, _elementType > &otherVector)

ThisType &	ElementwiseMin (const vctDynamicConstVectorBase< __vectorOwnerType, _elementType > &otherVector)

ThisType &	ElementwiseMax (const vctDynamicConstVectorBase< __vectorOwnerType, _elementType > &otherVector)

ThisType &	ElementwiseClipIn (const vctDynamicConstVectorBase< __vectorOwnerType, _elementType > &boundVector)

ThisType &	operator+= (const vctDynamicConstVectorBase< __vectorOwnerType, _elementType > &otherVector)

ThisType &	operator-= (const vctDynamicConstVectorBase< __vectorOwnerType, _elementType > &otherVector)

ThisType &	SwapElementsWith (vctDynamicVectorBase< __vectorOwnerType, _elementType > &otherVector)

ThisType &	SumOf (const vctDynamicConstVectorBase< __vectorOwnerType, _elementType > &vector, const value_type scalar)

ThisType &	DifferenceOf (const vctDynamicConstVectorBase< __vectorOwnerType, _elementType > &vector, const value_type scalar)

ThisType &	ProductOf (const vctDynamicConstVectorBase< __vectorOwnerType, _elementType > &vector, const value_type scalar)

ThisType &	RatioOf (const vctDynamicConstVectorBase< __vectorOwnerType, _elementType > &vector, const value_type scalar)

ThisType &	ClippedAboveOf (const vctDynamicConstVectorBase< __vectorOwnerType, _elementType > &vector, const value_type upperBound)

ThisType &	ClippedBelowOf (const vctDynamicConstVectorBase< __vectorOwnerType, _elementType > &vector, const value_type lowerBound)

ThisType &	ClippedInOf (const vctDynamicConstVectorBase< __vectorOwnerType, _elementType > &vector, const value_type bound)

ThisType &	SumOf (const value_type scalar, const vctDynamicConstVectorBase< __vectorOwnerType, _elementType > &vector)

ThisType &	DifferenceOf (const value_type scalar, const vctDynamicConstVectorBase< __vectorOwnerType, _elementType > &vector)

ThisType &	ProductOf (const value_type scalar, const vctDynamicConstVectorBase< __vectorOwnerType, _elementType > &vector)

ThisType &	RatioOf (const value_type scalar, const vctDynamicConstVectorBase< __vectorOwnerType, _elementType > &vector)

ThisType &	ClippedAboveOf (const value_type upperBound, const vctDynamicConstVectorBase< __vectorOwnerType, _elementType > &vector)

ThisType &	ClippedBelowOf (const value_type lowerBound, const vctDynamicConstVectorBase< __vectorOwnerType, _elementType > &vector)

ThisType &	ClippedInOf (const value_type bound, const vctDynamicConstVectorBase< __vectorOwnerType, _elementType > &vector)

ThisType &	Add (const value_type scalar)

ThisType &	Subtract (const value_type scalar)

ThisType &	operator+= (const value_type scalar)

ThisType &	operator-= (const value_type scalar)

ThisType &	Multiply (const value_type scalar)

ThisType &	Divide (const value_type scalar)

ThisType &	ClipAbove (const value_type upperBound)

ThisType &	ClipBelow (const value_type lowerBound)

ThisType &	ClipIn (const value_type bound)

ThisType &	operator*= (const value_type scalar)

ThisType &	operator/= (const value_type scalar)

ThisType &	ProductOf (const vctDynamicConstMatrixBase< __matrixOwnerType, _elementType > &inputMatrix, const vctDynamicConstVectorBase< __vectorOwnerType, _elementType > &inputVector)

ThisType &	ProductOf (const vctDynamicConstVectorBase< __vectorOwnerType, _elementType > &inputVector, const vctDynamicConstMatrixBase< __matrixOwnerType, _elementType > &inputMatrix)

ThisType &	AbsOf (const vctDynamicConstVectorBase< __vectorOwnerType, _elementType > &otherVector)

ThisType &	NegationOf (const vctDynamicConstVectorBase< __vectorOwnerType, _elementType > &otherVector)

ThisType &	FloorOf (const vctDynamicConstVectorBase< __vectorOwnerType, _elementType > &otherVector)

ThisType &	CeilOf (const vctDynamicConstVectorBase< __vectorOwnerType, _elementType > &otherVector)

ThisType &	NormalizedOf (const vctDynamicConstVectorBase< __vectorOwnerType, _elementType > &otherVector) throw (std::runtime_error)

ThisType &	AbsSelf (void)

ThisType &	NegationSelf (void)

ThisType &	FloorSelf (void)

ThisType &	CeilSelf (void)

ThisType &	NormalizedSelf (void) throw (std::runtime_error)

Public Member Functions inherited from vctDynamicConstVectorBase< _vectorOwnerType, _elementType >
	VCT_CONTAINER_TRAITS_TYPEDEFS (_elementType)

const_iterator	begin (void) const

const_iterator	end (void) const

const_reverse_iterator	rbegin (void) const

const_reverse_iterator	rend (void) const

size_type	size (void) const

difference_type	stride () const

bool	empty () const

const_reference	operator[] (index_type index) const

const_reference	at (size_type index) const throw (std::out_of_range)

const_reference	operator() (size_type index) const throw (std::out_of_range)

const_reference	Element (size_type index) const

const OwnerType &	Owner (void) const

const_pointer	Pointer (index_type index=0) const

bool	ValidIndex (size_type index) const

vctDynamicConstVectorRef < _elementType >	Ref (const size_type size, const size_type startPosition=0) const throw (std::out_of_range)

template<class __vectorOwnerType >
value_type	DotProduct (const vctDynamicConstVectorBase< __vectorOwnerType, _elementType > &otherVector) const

std::string	ToString (void) const

void	ToStream (std::ostream &outputStream) const

void	ToStreamRaw (std::ostream &outputStream, const char delimiter= ' ', bool headerOnly=false, const std::string &headerPrefix="") const

void	SerializeRaw (std::ostream &outputStream) const

const value_type &	X (void) const

const value_type &	Y (void) const

const value_type &	Z (void) const

const value_type &	W (void) const

vctDynamicConstVectorRef < _elementType >	XY (void) const

vctDynamicConstVectorRef < _elementType >	XZ (void) const

vctDynamicConstVectorRef < _elementType >	XW (void) const

vctDynamicConstVectorRef < _elementType >	YZ (void) const

vctDynamicConstVectorRef < _elementType >	YW (void) const

vctDynamicConstVectorRef < _elementType >	ZW (void) const

vctDynamicConstVectorRef < _elementType >	XYZ (void) const

vctDynamicConstVectorRef < _elementType >	YZW (void) const

vctDynamicConstVectorRef < _elementType >	XYZW (void) const

value_type	SumOfElements (void) const

value_type	ProductOfElements (void) const

value_type	NormSquare (void) const

NormType	Norm (void) const

bool	IsNormalized (void) const

bool	IsNormalized (_elementType tolerance) const

value_type	L1Norm (void) const

value_type	LinfNorm (void) const

value_type	MaxElement (void) const

value_type	MinElement (void) const

value_type	MaxAbsElement (void) const

value_type	MinAbsElement (void) const

void	MinAndMaxElement (value_type &minElement, value_type &maxElement) const

bool	IsPositive (void) const

bool	IsNonNegative (void) const

bool	IsNonPositive (void) const

bool	IsNegative (void) const

bool	All (void) const

bool	Any (void) const

bool	IsFinite (void) const

bool	HasNaN (void) const

bool	IsCompact (void) const

bool	IsFortran (void) const

template<class __vectorOwnerType >
bool	FastCopyCompatible (const vctDynamicConstVectorBase< __vectorOwnerType, value_type > &source) const

template<size_type __size, stride_type __stride, class __dataPtrType >
bool	FastCopyCompatible (const vctFixedSizeConstVectorBase< __size, __stride, value_type, __dataPtrType > &source) const

template<class __vectorOwnerType >
bool	Equal (const vctDynamicConstVectorBase< __vectorOwnerType, _elementType > &otherVector) const

template<class __vectorOwnerType >
bool	operator== (const vctDynamicConstVectorBase< __vectorOwnerType, _elementType > &otherVector) const

template<class __vectorOwnerType >
bool	AlmostEqual (const vctDynamicConstVectorBase< __vectorOwnerType, _elementType > &otherVector, value_type tolerance) const

template<class __vectorOwnerType >
bool	AlmostEqual (const vctDynamicConstVectorBase< __vectorOwnerType, _elementType > &otherVector) const

template<class __vectorOwnerType >
bool	NotEqual (const vctDynamicConstVectorBase< __vectorOwnerType, _elementType > &otherVector) const

template<class __vectorOwnerType >
bool	operator!= (const vctDynamicConstVectorBase< __vectorOwnerType, _elementType > &otherVector) const

template<class __vectorOwnerType >
bool	Lesser (const vctDynamicConstVectorBase< __vectorOwnerType, _elementType > &otherVector) const

template<class __vectorOwnerType >
bool	LesserOrEqual (const vctDynamicConstVectorBase< __vectorOwnerType, _elementType > &otherVector) const

template<class __vectorOwnerType >
bool	Greater (const vctDynamicConstVectorBase< __vectorOwnerType, _elementType > &otherVector) const

template<class __vectorOwnerType >
bool	GreaterOrEqual (const vctDynamicConstVectorBase< __vectorOwnerType, _elementType > &otherVector) const

template<class __vectorOwnerType >
BoolVectorReturnType	ElementwiseEqual (const vctDynamicConstVectorBase< __vectorOwnerType, _elementType > &otherVector) const

template<class __vectorOwnerType >
BoolVectorReturnType	ElementwiseNotEqual (const vctDynamicConstVectorBase< __vectorOwnerType, _elementType > &otherVector) const

template<class __vectorOwnerType >
BoolVectorReturnType	ElementwiseLesser (const vctDynamicConstVectorBase< __vectorOwnerType, _elementType > &otherVector) const

template<class __vectorOwnerType >
BoolVectorReturnType	ElementwiseLesserOrEqual (const vctDynamicConstVectorBase< __vectorOwnerType, _elementType > &otherVector) const

template<class __vectorOwnerType >
BoolVectorReturnType	ElementwiseGreater (const vctDynamicConstVectorBase< __vectorOwnerType, _elementType > &otherVector) const

template<class __vectorOwnerType >
BoolVectorReturnType	ElementwiseGreaterOrEqual (const vctDynamicConstVectorBase< __vectorOwnerType, _elementType > &otherVector) const

bool	Equal (const value_type &scalar) const

bool	operator== (const value_type &scalar) const

bool	NotEqual (const value_type &scalar) const

bool	operator!= (const value_type &scalar) const

bool	Lesser (const value_type &scalar) const

bool	LesserOrEqual (const value_type &scalar) const

bool	Greater (const value_type &scalar) const

bool	GreaterOrEqual (const value_type &scalar) const

BoolVectorReturnType	ElementwiseEqual (const value_type &scalar) const

BoolVectorReturnType	ElementwiseNotEqual (const value_type &scalar) const

BoolVectorReturnType	ElementwiseLesser (const value_type &scalar) const

BoolVectorReturnType	ElementwiseLesserOrEqual (const value_type &scalar) const

BoolVectorReturnType	ElementwiseGreater (const value_type &scalar) const

BoolVectorReturnType	ElementwiseGreaterOrEqual (const value_type &scalar) const

VectorReturnType	Abs (void) const

VectorReturnType	Negation (void) const

VectorReturnType	Floor (void) const

VectorReturnType	Ceil (void) const

VectorReturnType	Normalized (void) const throw (std::runtime_error)

Additional Inherited Members
Protected Member Functions inherited from vctDynamicConstVectorBase< _vectorOwnerType, _elementType >
void	ThrowUnlessValidIndex (size_type index) const throw (std::out_of_range)

Protected Attributes inherited from vctDynamicConstVectorBase< _vectorOwnerType, _elementType >
OwnerType	Vector

Detailed Description

template<class _elementType>
class vctReturnDynamicVector< _elementType >

Class vctReturnDynamicVector is specialized to store a temporary vector object by transfering ownership. An object of this class has all the methods inherited from vctDynamicVector, but can only be constructed in one way – taking the ownership from another vctDynamicVector (or vctReturnDynamicVector) object. In turn, when an assignment occurs from a vctReturnDynamicVector to a vctDynamicVector (or likewise construction), the lhs vctDynamicVector strips this object from the ownership of the data.

Use this class only when you want to return a newly created dynamic vector from a function, without going through memory allocation and deallocation. Never use it on an object that is going to remain in scope after constructing the vctReturnDynamicVector.

Member Typedef Documentation

template<class _elementType>

typedef vctDynamicVector<_elementType> vctReturnDynamicVector< _elementType >::BaseType

Base type of vctReturnDynamicVector.

Constructor & Destructor Documentation

template<class _elementType>

vctReturnDynamicVector< _elementType >::vctReturnDynamicVector ( const BaseType & other )

inlineexplicit

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

/home/adeguet1/catkin_ws/src/cisst-saw/cisst/cisstVector/vctDynamicVector.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

template<class _elementType> class vctReturnDynamicVector< _elementType >

Member Typedef Documentation

Constructor & Destructor Documentation

template<class _elementType>
class vctReturnDynamicVector< _elementType >