Vector<ScalarType> Concept

Describes a (potentially structured) data which can be operated on as a (finite-dimensional) column vector. More...

Collaboration diagram for Vector<ScalarType> Concept:

Modules
	LCMVector<ScalarType> Concept
	A specialization of the Vector concept adding the ability to read and publish LCM messages.

Classes
struct	EigenVector< Rows >
	EigenVector<Rows>::type<ScalarType> More...
class	CombinedVector< ScalarType, Vector1, Vector2 >
	operator<<() More...

Typedefs
template<typename ScalarType >
using	NullVector = Eigen::Matrix< ScalarType, 0, 1 >
	NullVector<ScalarType> More...

Functions
template<template< typename > class VecType>
VecType< double >	getRandomVector (void)
	getRandomVector() More...
template<typename VecType >
std::size_t	size (const VecType &vec)
	size() More...
template<typename Vector >
std::string	getCoordinateName (const Vector &vec, unsigned int index)
	getCoordinateName() More...

Detailed Description

Describes a (potentially structured) data which can be operated on as a (finite-dimensional) column vector.

Valid Expressions (which must be implemented)
RowsAtCompileTime	defined as a static constant int (or enum). Can be Eigen::Dynamic.
size_t size()	only required if RowsAtCompileTime==Eigen::Dynamic
template<Derived> Vector(const Eigen::MatrixBase<Derived>&)	constructor taking an Eigen object
template<Derived> Vector& operator=(const Eigen::MatrixBase<Derived>&)	assignment operator from an Eigen object
Eigen::Matrix<ScalarType, RowsAtCompileTime, 1> toEigen(const Vector<ScalarType>&)	non-member namespace method which converts to the Eigen type

Typedef Documentation

using NullVector = Eigen::Matrix<ScalarType, 0, 1>

NullVector<ScalarType>

provides the empty vector (templated by ScalarType)

Implemented concepts:

Vector<ScalarType> Concept

Function Documentation

std::string Drake::getCoordinateName	(	const Vector &	vec,
		unsigned int	index
	)

getCoordinateName()

Implements default coordinate names for a generic vector. Overload this to name your coordinates.

Implemented concepts:

Vector<ScalarType> Concept

Here is the call graph for this function:

Here is the caller graph for this function:

VecType<double> Drake::getRandomVector

(

void

)

getRandomVector()

Returns a random vector of the desired type using Eigen::Random()

Implemented concepts:

Vector<ScalarType> Concept

std::size_t Drake::size

(

const VecType &

vec

)

size()

Evaluate the size of a Vector

Implemented concepts:

Vector<ScalarType> Concept

Return values

RowsAtCompileTime

or the result of size() for dynamically sized vectors

Here is the call graph for this function:

Here is the caller graph for this function: