VectorEigen Class Reference

#include <VectorEigen.hpp>

Detailed Description

Eigen vector wrapper class

Public Member Functions
	VectorEigen (int size=0)
	VectorEigen (const VectorEigen &v)
	VectorEigen (const VectorDouble &v)
	VectorEigen (const Eigen::VectorXd &v)
VectorEigen &	operator= (const VectorEigen &r)
virtual	~VectorEigen ()
void	setValue (int i, double value, bool flagCheck=false)
	Set the value at a given position in the vector. More...
double	getValue (int i, bool flagCheck=false) const
	Get the value at a given position. More...
VectorDouble	getValues () const
	Get all values in a VectorDouble. More...
void	fill (double value)
	Set all the values of the Vector at once. More...
int	size () const
void	resize (int n)
bool	empty () const
const Eigen::VectorXd &	getVector () const
Eigen::VectorXd &	getVector ()
Eigen::Map< const Eigen::VectorXd >	getMap () const
Eigen::Map< Eigen::VectorXd >	getMap ()

Static Public Member Functions
static double	maximum (const std::vector< Eigen::VectorXd > &vect)
static void	simulateGaussianInPlace (Eigen::VectorXd &vect, double mean=0, double var=1)
static void	fill (Eigen::VectorXd &vect, double val=0.)
static void	addMultiplyConstantInPlace (double val, const Eigen::VectorXd &in, Eigen::VectorXd &res, int iad)
static void	addMultiplyVectVectInPlace (const Eigen::VectorXd &in1, const Eigen::VectorXd &in2, Eigen::VectorXd &res, int iad)
static void	addInPlace (const Eigen::VectorXd &in, Eigen::VectorXd &res, int iad)
static VectorDouble	copyIntoVD (const Eigen::VectorXd &in)
static double	innerProduct (const std::vector< Eigen::VectorXd > &in1, const std::vector< Eigen::VectorXd > &in2)
static void	fill (std::vector< Eigen::VectorXd > &vect, double val=0.)
static void	copy (const Eigen::VectorXd &in, Eigen::VectorXd &dest)
static void	copy (const Eigen::VectorXd &in, Eigen::Map< Eigen::VectorXd > &dest)
static void	copy (const Eigen::VectorXd &in, VectorDouble &dest)
static void	linearCombinationVVDInPlace (double coeff1, const std::vector< Eigen::VectorXd > &in1, double coeff2, const std::vector< Eigen::VectorXd > &in2, std::vector< Eigen::VectorXd > &res)
static void	substractInPlace (const std::vector< Eigen::VectorXd > &in1, const std::vector< Eigen::VectorXd > &in2, std::vector< Eigen::VectorXd > &res)
static void	copy (const std::vector< Eigen::VectorXd > &in, std::vector< Eigen::VectorXd > &dest)
static void	addInPlace (const Eigen::VectorXd &in, Eigen::VectorXd &out)
static void	divideInPlace (const Eigen::VectorXd &in, Eigen::VectorXd &out)
static void	addInPlace (const Eigen::VectorXd &t1, const Eigen::VectorXd &t2, Eigen::VectorXd &res)
static void	addInPlace (const std::vector< Eigen::VectorXd > &t1, const std::vector< Eigen::VectorXd > &t2, std::vector< Eigen::VectorXd > &res)
static void	multiplyConstant (Eigen::VectorXd vect, double val=1.)
static Eigen::VectorXd	flatten (const std::vector< Eigen::VectorXd > &vvd)
static void	flattenInPlace (const std::vector< Eigen::VectorXd > &vvd, Eigen::VectorXd &vd)
static std::vector< Eigen::VectorXd >	unflatten (const Eigen::VectorXd &vd, const VectorInt &sizes)
static void	unflattenInPlace (const Eigen::VectorXd &vd, std::vector< Eigen::VectorXd > &vvd)

Constructor & Destructor Documentation

VectorEigen() [1/4]

VectorEigen::VectorEigen

(

int

size = 0

)

VectorEigen() [2/4]

VectorEigen::VectorEigen

(

const VectorEigen &

v

)

VectorEigen() [3/4]

VectorEigen::VectorEigen

(

const VectorDouble &

v

)

VectorEigen() [4/4]

VectorEigen::VectorEigen

(

const Eigen::VectorXd &

v

)

~VectorEigen()

VectorEigen::~VectorEigen ( )

virtual

Member Function Documentation

addInPlace() [1/4]

void VectorEigen::addInPlace ( const Eigen::VectorXd &  in, Eigen::VectorXd &  out  )

static

addInPlace() [2/4]

void VectorEigen::addInPlace ( const Eigen::VectorXd &  in, Eigen::VectorXd &  res, int  iad  )

static

addInPlace() [3/4]

void VectorEigen::addInPlace ( const Eigen::VectorXd &  t1, const Eigen::VectorXd &  t2, Eigen::VectorXd &  res  )

static

Get underlying Eigen vector

addInPlace() [4/4]

void VectorEigen::addInPlace ( const std::vector< Eigen::VectorXd > &  t1, const std::vector< Eigen::VectorXd > &  t2, std::vector< Eigen::VectorXd > &  res  )

static

addMultiplyConstantInPlace()

void VectorEigen::addMultiplyConstantInPlace ( double  val, const Eigen::VectorXd &  in, Eigen::VectorXd &  res, int  iad  )

static

addMultiplyVectVectInPlace()

void VectorEigen::addMultiplyVectVectInPlace ( const Eigen::VectorXd &  in1, const Eigen::VectorXd &  in2, Eigen::VectorXd &  res, int  iad  )

static

copy() [1/4]

void VectorEigen::copy ( const Eigen::VectorXd &  in, Eigen::Map< Eigen::VectorXd > &  dest  )

static

copy() [2/4]

void VectorEigen::copy ( const Eigen::VectorXd &  in, Eigen::VectorXd &  dest  )

static

copy() [3/4]

void VectorEigen::copy ( const Eigen::VectorXd &  in, VectorDouble &  dest  )

static

copy() [4/4]

void VectorEigen::copy ( const std::vector< Eigen::VectorXd > &  in, std::vector< Eigen::VectorXd > &  dest  )

static

copyIntoVD()

VectorDouble VectorEigen::copyIntoVD ( const Eigen::VectorXd &  in )

static

divideInPlace()

void VectorEigen::divideInPlace ( const Eigen::VectorXd &  in, Eigen::VectorXd &  out  )

static

empty()

bool VectorEigen::empty ( ) const

inline

fill() [1/3]

void VectorEigen::fill

(

double

value

)

Set all the values of the Vector at once.

Set all the values of the Vector at once

Parameters

value

value to be filled

fill() [2/3]

void VectorEigen::fill ( Eigen::VectorXd &  vect, double  val = 0.  )

static

fill() [3/3]

void VectorEigen::fill ( std::vector< Eigen::VectorXd > &  vect, double  val = 0.  )

static

flatten()

Eigen::VectorXd VectorEigen::flatten ( const std::vector< Eigen::VectorXd > &  vvd )

static

Method which flattens a std::vector<Eigen::VectorXd> into an Eigen::VectorXd

Parameters

vvd	Input std::vector<Eigen::VectorXd>

Returns

Returned Eigen::VectorXd

flattenInPlace()

void VectorEigen::flattenInPlace ( const std::vector< Eigen::VectorXd > &  vvd, Eigen::VectorXd &  vd  )

static

getMap() [1/2]

Eigen::Map<Eigen::VectorXd> VectorEigen::getMap ( )

inline

Get map to underlying Eigen vector

getMap() [2/2]

Eigen::Map<const Eigen::VectorXd> VectorEigen::getMap ( ) const

inline

Get map to underlying Eigen vector

getValue()

double VectorEigen::getValue	(	int	i,
		bool	flagCheck = false
	)		const

Get the value at a given position.

Get the value at a given position

Parameters

i	index position
flagCheck	true to check index position consistency

Returns

the value

getValues()

VectorDouble VectorEigen::getValues

(

)

const

Get all values in a VectorDouble.

Get all values in a VectorDouble

Returns

VectorDouble

getVector() [1/2]

Eigen::VectorXd& VectorEigen::getVector ( )

inline

Get underlying Eigen vector

getVector() [2/2]

const Eigen::VectorXd& VectorEigen::getVector ( ) const

inline

innerProduct()

double VectorEigen::innerProduct ( const std::vector< Eigen::VectorXd > &  in1, const std::vector< Eigen::VectorXd > &  in2  )

static

linearCombinationVVDInPlace()

void VectorEigen::linearCombinationVVDInPlace ( double  coeff1, const std::vector< Eigen::VectorXd > &  in1, double  coeff2, const std::vector< Eigen::VectorXd > &  in2, std::vector< Eigen::VectorXd > &  res  )

static

maximum()

double VectorEigen::maximum ( const std::vector< Eigen::VectorXd > &  vect )

static

multiplyConstant()

void VectorEigen::multiplyConstant ( Eigen::VectorXd  vect, double  val = 1.  )

static

operator=()

VectorEigen & VectorEigen::operator=

(

const VectorEigen &

r

)

resize()

void VectorEigen::resize ( int  n )

inline

setValue()

void VectorEigen::setValue	(	int	i,
		double	value,
		bool	flagCheck = false
	)

Set the value at a given position in the vector.

Set the value at a given position in the vector

Parameters

i	index position
value	new value
flagCheck	true to check index position consistency

simulateGaussianInPlace()

void VectorEigen::simulateGaussianInPlace ( Eigen::VectorXd &  vect, double  mean = 0, double  var = 1  )

static

size()

int VectorEigen::size ( ) const

inline

substractInPlace()

void VectorEigen::substractInPlace ( const std::vector< Eigen::VectorXd > &  in1, const std::vector< Eigen::VectorXd > &  in2, std::vector< Eigen::VectorXd > &  res  )

static

unflatten()

std::vector< Eigen::VectorXd > VectorEigen::unflatten ( const Eigen::VectorXd &  vd, const VectorInt &  sizes  )

static

unflattenInPlace()

void VectorEigen::unflattenInPlace ( const Eigen::VectorXd &  vd, std::vector< Eigen::VectorXd > &  vvd  )

static

---

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

• include/Matrix/VectorEigen.hpp
• src/Matrix/VectorEigen.cpp