#include <VectorValues.h>

Public Types
typedef Values::const_iterator	const_iterator
	Const iterator over vector values. More...

typedef std::map< Key, size_t >	Dims
	Keyed vector dimensions. More...

typedef Values::iterator	iterator
	Iterator over vector values. More...

typedef value_type	KeyValuePair
	Typedef to pair<Key, Vector> More...

typedef std::shared_ptr< This >	shared_ptr
	shared_ptr to this class More...

typedef Values::value_type	value_type
	Typedef to pair<Key, Vector> More...

Public Member Functions
Advanced Interface
Vector	vector () const

template<typename CONTAINER >
Vector	vector (const CONTAINER &keys) const

Vector	vector (const Dims &dims) const

void	swap (VectorValues &other)

bool	hasSameStructure (const VectorValues other) const

Wrapper support
std::string	html (const KeyFormatter &keyFormatter=DefaultKeyFormatter) const
	Output as a html table. More...

Protected Types
typedef VectorValues	This

typedef ConcurrentMap< Key, Vector >	Values
	Collection of Vectors making up a VectorValues. More...

Protected Attributes
Values	values_
	Vectors making up this VectorValues. More...

Standard Constructors
	VectorValues ()
	Default constructor creates an empty VectorValues. More...

	VectorValues (std::initializer_list< std::pair< Key, Vector >> init)
	Construct from initializer list. More...

	VectorValues (const VectorValues &first, const VectorValues &second)

template<class CONTAINER >
	VectorValues (const CONTAINER &c)

	VectorValues (const VectorValues &c)

template<typename ITERATOR >
	VectorValues (ITERATOR first, ITERATOR last)

	VectorValues (const Vector &c, const Dims &dims)
	Constructor from Vector, with Dims. More...

	VectorValues (const Vector &c, const Scatter &scatter)
	Constructor from Vector, with Scatter. More...

static VectorValues	Zero (const VectorValues &other)

Standard Interface
size_t	size () const

size_t	dim (Key j) const

bool	exists (Key j) const

Vector &	at (Key j)

const Vector &	at (Key j) const

Vector &	operator[] (Key j)

const Vector &	operator[] (Key j) const

VectorValues &	update (const VectorValues &values)

iterator	insert (const std::pair< Key, Vector > &key_value)

template<class... Args>
std::pair< VectorValues::iterator, bool >	emplace (Key j, Args &&... args)

iterator	insert (Key j, const Vector &value)

VectorValues &	insert (const VectorValues &values)

std::pair< iterator, bool >	tryInsert (Key j, const Vector &value)

void	insert_or_assign (Key j, const Vector &value)

void	erase (Key var)

void	setZero ()

iterator	begin ()
	Iterator over variables. More...

const_iterator	begin () const
	Iterator over variables. More...

iterator	end ()
	Iterator over variables. More...

const_iterator	end () const
	Iterator over variables. More...

iterator	find (Key j)

const_iterator	find (Key j) const

void	print (const std::string &str="VectorValues", const KeyFormatter &formatter=DefaultKeyFormatter) const

bool	equals (const VectorValues &x, double tol=1e-9) const

GTSAM_EXPORT friend std::ostream &	operator<< (std::ostream &, const VectorValues &)
	overload operator << to print to stringstream More...

Linear algebra operations
double	dot (const VectorValues &v) const

double	norm () const

double	squaredNorm () const

VectorValues	operator+ (const VectorValues &c) const

VectorValues	add (const VectorValues &c) const

VectorValues &	operator+= (const VectorValues &c)

VectorValues &	addInPlace (const VectorValues &c)

VectorValues &	addInPlace_ (const VectorValues &c)

VectorValues	operator- (const VectorValues &c) const

VectorValues	subtract (const VectorValues &c) const

VectorValues	scale (const double a) const

VectorValues &	operator*= (double alpha)

VectorValues &	scaleInPlace (double alpha)

GTSAM_EXPORT VectorValues	operator* (const double a, const VectorValues &v)

Detailed Description

VectorValues represents a collection of vector-valued variables associated each with a unique integer index. It is typically used to store the variables of a GaussianFactorGraph. Optimizing a GaussianFactorGraph or GaussianBayesNet returns this class.

For basic usage, such as receiving a linear solution from gtsam solving functions, or creating this class in unit tests and examples where speed is not important, you can use a simple interface:

The default constructor VectorValues() to create this class
insert(Key, const Vector&) to add vector variables
operator[](Key) for read and write access to stored variables
exists (Key) to check if a variable is present
Other facilities like iterators, size(), dim(), etc.

Example:

VectorValues values;
values.emplace(3, Vector3(1.0, 2.0, 3.0));
values.emplace(4, Vector2(4.0, 5.0));
values.emplace(0, (Vector(4) << 6.0, 7.0, 8.0, 9.0).finished());
// Prints [ 3.0 4.0 ]
gtsam::print(values[1]);
// Prints [ 8.0 9.0 ]
values[1] = Vector2(8.0, 9.0);
gtsam::print(values[1]);

Advanced Interface and Performance Information

Access is through the variable Key j, and returns a SubVector, which is a view on the underlying data structure.

This class is additionally used in gradient descent and dog leg to store the gradient.

Definition at line 74 of file VectorValues.h.

Member Typedef Documentation

◆ const_iterator

typedef Values::const_iterator gtsam::VectorValues::const_iterator

Const iterator over vector values.

Definition at line 82 of file VectorValues.h.

◆ Dims

typedef std::map<Key, size_t> gtsam::VectorValues::Dims

Keyed vector dimensions.

Definition at line 86 of file VectorValues.h.

◆ iterator

typedef Values::iterator gtsam::VectorValues::iterator

Iterator over vector values.

Definition at line 81 of file VectorValues.h.

◆ KeyValuePair

typedef value_type gtsam::VectorValues::KeyValuePair

Typedef to pair<Key, Vector>

Definition at line 85 of file VectorValues.h.

◆ shared_ptr

typedef std::shared_ptr<This> gtsam::VectorValues::shared_ptr

shared_ptr to this class

Definition at line 83 of file VectorValues.h.

◆ This

typedef VectorValues gtsam::VectorValues::This

protected

Definition at line 76 of file VectorValues.h.

◆ value_type

typedef Values::value_type gtsam::VectorValues::value_type

Typedef to pair<Key, Vector>

Definition at line 84 of file VectorValues.h.

◆ Values

typedef ConcurrentMap<Key, Vector> gtsam::VectorValues::Values

protected

Collection of Vectors making up a VectorValues.

Definition at line 77 of file VectorValues.h.

Constructor & Destructor Documentation

◆ VectorValues() [1/8]

gtsam::VectorValues::VectorValues ( )

inline

Default constructor creates an empty VectorValues.

Definition at line 92 of file VectorValues.h.

◆ VectorValues() [2/8]

gtsam::VectorValues::VectorValues ( std::initializer_list< std::pair< Key, Vector >> init )

inline

Construct from initializer list.

Definition at line 95 of file VectorValues.h.

◆ VectorValues() [3/8]

VectorValues::VectorValues	(	const VectorValues &	first,
		const VectorValues &	second
	)

Merge two VectorValues into one, this is more efficient than inserting elements one by one.

Definition at line 31 of file VectorValues.cpp.

◆ VectorValues() [4/8]

template<class CONTAINER >

gtsam::VectorValues::VectorValues ( const CONTAINER & c )

inlineexplicit

Create from another container holding pair<Key,Vector>.

Definition at line 104 of file VectorValues.h.

◆ VectorValues() [5/8]

gtsam::VectorValues::VectorValues ( const VectorValues & c )

inline

Implicit copy constructor to specialize the explicit constructor from any container.

Definition at line 107 of file VectorValues.h.

◆ VectorValues() [6/8]

template<typename ITERATOR >

gtsam::VectorValues::VectorValues	(	ITERATOR	first,
		ITERATOR	last
	)

inline

Create from a pair of iterators over pair<Key,Vector>.

Definition at line 111 of file VectorValues.h.

◆ VectorValues() [7/8]

VectorValues::VectorValues	(	const Vector &	c,
		const Dims &	dims
	)

Constructor from Vector, with Dims.

Definition at line 42 of file VectorValues.cpp.

◆ VectorValues() [8/8]

VectorValues::VectorValues	(	const Vector &	c,
		const Scatter &	scatter
	)

Constructor from Vector, with Scatter.

Definition at line 55 of file VectorValues.cpp.

Member Function Documentation

◆ add()

VectorValues VectorValues::add ( const VectorValues & c ) const

Element-wise addition, synonym for operator+(). Both VectorValues must have the same structure (checked when NDEBUG is not defined).

Definition at line 279 of file VectorValues.cpp.

◆ addInPlace()

VectorValues & VectorValues::addInPlace ( const VectorValues & c )

Element-wise addition in-place, synonym for operator+=(). Both VectorValues must have the same structure (checked when NDEBUG is not defined).

Definition at line 302 of file VectorValues.cpp.

◆ addInPlace_()

VectorValues & VectorValues::addInPlace_ ( const VectorValues & c )

Element-wise addition in-place, but allows for empty slots in *this. Slower

Definition at line 308 of file VectorValues.cpp.

◆ at() [1/2]

Vector& gtsam::VectorValues::at ( Key j )

inline

Read/write access to the vector value with key j, throws std::out_of_range if j does not exist, identical to operator[](Key).

Definition at line 139 of file VectorValues.h.

◆ at() [2/2]

const Vector& gtsam::VectorValues::at ( Key j ) const

inline

Access the vector value with key j (const version), throws std::out_of_range if j does not exist, identical to operator[](Key).

Definition at line 152 of file VectorValues.h.

◆ begin() [1/2]

iterator gtsam::VectorValues::begin ( )

inline

Iterator over variables.

Definition at line 236 of file VectorValues.h.

◆ begin() [2/2]

const_iterator gtsam::VectorValues::begin ( ) const

inline

Iterator over variables.

Definition at line 237 of file VectorValues.h.

◆ dim()

size_t gtsam::VectorValues::dim ( Key j ) const

inline

Return the dimension of variable j.

Definition at line 130 of file VectorValues.h.

◆ dot()

double VectorValues::dot ( const VectorValues & v ) const

Dot product with another VectorValues, interpreting both as vectors of their concatenated values. Both VectorValues must have the same structure (checked when NDEBUG is not defined).

Definition at line 227 of file VectorValues.cpp.

◆ emplace()

template<class... Args>

std::pair<VectorValues::iterator, bool> gtsam::VectorValues::emplace	(	Key	j,
		Args &&...	args
	)

inline

Emplace a vector value with key j. Throws an invalid_argument exception if the key j is already used.

Parameters

value	The vector to be inserted.
j	The index with which the value will be associated.

Definition at line 185 of file VectorValues.h.

◆ end() [1/2]

iterator gtsam::VectorValues::end ( )

inline

Iterator over variables.

Definition at line 238 of file VectorValues.h.

◆ end() [2/2]

const_iterator gtsam::VectorValues::end ( ) const

inline

Iterator over variables.

Definition at line 239 of file VectorValues.h.

◆ equals()

bool VectorValues::equals	(	const VectorValues &	x,
		double	tol = `1e-9`
	)		const

equals required by Testable for unit testing

Definition at line 156 of file VectorValues.cpp.

◆ erase()

void gtsam::VectorValues::erase ( Key var )

inline

Erase the vector with the given key, or throw std::out_of_range if it does not exist

Definition at line 226 of file VectorValues.h.

◆ exists()

bool gtsam::VectorValues::exists ( Key j ) const

inline

Check whether a variable with key j exists.

Definition at line 133 of file VectorValues.h.

◆ find() [1/2]

iterator gtsam::VectorValues::find ( Key j )

inline

Return the iterator corresponding to the requested key, or end() if no variable is present with this key.

Definition at line 245 of file VectorValues.h.

◆ find() [2/2]

const_iterator gtsam::VectorValues::find ( Key j ) const

inline

Return the iterator corresponding to the requested key, or end() if no variable is present with this key.

Definition at line 251 of file VectorValues.h.

◆ hasSameStructure()

bool VectorValues::hasSameStructure ( const VectorValues other ) const

Check if this VectorValues has the same structure (keys and dimensions) as another

Definition at line 218 of file VectorValues.cpp.

◆ html()

std::string VectorValues::html ( const KeyFormatter & keyFormatter = DefaultKeyFormatter ) const

Output as a html table.

Parameters

keyFormatter function that formats keys.

Definition at line 380 of file VectorValues.cpp.

◆ insert() [1/3]

VectorValues::iterator VectorValues::insert ( const std::pair< Key, Vector > & key_value )

Insert a vector value with key j. Throws an invalid_argument exception if the key j is already used.

Parameters

value	The vector to be inserted.
j	The index with which the value will be associated.

Definition at line 81 of file VectorValues.cpp.

◆ insert() [2/3]

iterator gtsam::VectorValues::insert	(	Key	j,
		const Vector &	value
	)

inline

Insert a vector value with key j. Throws an invalid_argument exception if the key j is already used.

Parameters

value	The vector to be inserted.
j	The index with which the value will be associated.

Definition at line 197 of file VectorValues.h.

◆ insert() [3/3]

VectorValues & VectorValues::insert ( const VectorValues & values )

Insert all values from values. Throws an invalid_argument exception if any keys to be inserted are already used.

Definition at line 111 of file VectorValues.cpp.

◆ insert_or_assign()

void gtsam::VectorValues::insert_or_assign	(	Key	j,
		const Vector &	value
	)

inline

insert_or_assign that mimics the STL map insert_or_assign - if the value already exists, the map is updated, otherwise a new value is inserted at j.

Definition at line 219 of file VectorValues.h.

◆ norm()

double VectorValues::norm ( ) const

Vector L2 norm

Definition at line 245 of file VectorValues.cpp.

◆ operator*=()

VectorValues & VectorValues::operator*= ( double alpha )

Element-wise scaling by a constant in-place.

Definition at line 365 of file VectorValues.cpp.

◆ operator+()

VectorValues VectorValues::operator+ ( const VectorValues & c ) const

Element-wise addition, synonym for add(). Both VectorValues must have the same structure (checked when NDEBUG is not defined).

Definition at line 259 of file VectorValues.cpp.

◆ operator+=()

VectorValues & VectorValues::operator+= ( const VectorValues & c )

Element-wise addition in-place, synonym for operator+=(). Both VectorValues must have the same structure (checked when NDEBUG is not defined).

Definition at line 285 of file VectorValues.cpp.

◆ operator-()

VectorValues VectorValues::operator- ( const VectorValues & c ) const

Element-wise subtraction, synonym for subtract(). Both VectorValues must have the same structure (checked when NDEBUG is not defined).

Definition at line 321 of file VectorValues.cpp.

◆ operator[]() [1/2]

Vector& gtsam::VectorValues::operator[] ( Key j )

inline

Read/write access to the vector value with key j, throws std::out_of_range if j does not exist, identical to at(Key).

Definition at line 163 of file VectorValues.h.

◆ operator[]() [2/2]

const Vector& gtsam::VectorValues::operator[] ( Key j ) const

inline

Access the vector value with key j (const version), throws std::out_of_range if j does not exist, identical to at(Key).

Definition at line 167 of file VectorValues.h.

◆ print()

void VectorValues::print	(	const std::string &	str = `"VectorValues"`,
		const KeyFormatter &	formatter = `DefaultKeyFormatter`
	)		const

print required by Testable for unit testing

Definition at line 148 of file VectorValues.cpp.

◆ scale()

VectorValues VectorValues::scale ( const double a ) const

Element-wise scaling by a constant.

Definition at line 359 of file VectorValues.cpp.

◆ scaleInPlace()

VectorValues & VectorValues::scaleInPlace ( double alpha )

Element-wise scaling by a constant in-place.

Definition at line 374 of file VectorValues.cpp.

◆ setZero()

void VectorValues::setZero ( )

Set all values to zero vectors.

Definition at line 122 of file VectorValues.cpp.

◆ size()

size_t gtsam::VectorValues::size ( ) const

inline

Number of variables stored.

Definition at line 127 of file VectorValues.h.

◆ squaredNorm()

double VectorValues::squaredNorm ( ) const

Squared vector L2 norm

Definition at line 250 of file VectorValues.cpp.

◆ subtract()

VectorValues VectorValues::subtract ( const VectorValues & c ) const

Element-wise subtraction, synonym for operator-(). Both VectorValues must have the same structure (checked when NDEBUG is not defined).

Definition at line 341 of file VectorValues.cpp.

◆ swap()

void VectorValues::swap ( VectorValues & other )

Swap the data in this VectorValues with another.

Definition at line 204 of file VectorValues.cpp.

◆ tryInsert()

std::pair<iterator, bool> gtsam::VectorValues::tryInsert	(	Key	j,
		const Vector &	value
	)

inline

insert that mimics the STL map insert - if the value already exists, the map is not modified and an iterator to the existing value is returned, along with 'false'. If the value did not exist, it is inserted and an iterator pointing to the new element, along with 'true', is returned.

Definition at line 209 of file VectorValues.h.

◆ update()

VectorValues & VectorValues::update ( const VectorValues & values )

For all key/value pairs in values, replace values with corresponding keys in this class with those in values. Throws std::out_of_range if any keys in values are not present in this class.

Definition at line 91 of file VectorValues.cpp.

◆ vector() [1/3]

Vector VectorValues::vector ( ) const

Retrieve the entire solution as a single vector

Definition at line 170 of file VectorValues.cpp.

◆ vector() [2/3]

template<typename CONTAINER >

Vector gtsam::VectorValues::vector ( const CONTAINER & keys ) const

inline

Access a vector that is a subset of relevant keys.

Definition at line 272 of file VectorValues.h.

◆ vector() [3/3]

Vector VectorValues::vector ( const Dims & dims ) const

Access a vector that is a subset of relevant keys, dims version.

Definition at line 188 of file VectorValues.cpp.

◆ Zero()

VectorValues VectorValues::Zero ( const VectorValues & other )

static

Create a VectorValues with the same structure as other, but filled with zeros.

Definition at line 68 of file VectorValues.cpp.

Friends And Related Function Documentation

◆ operator*

GTSAM_EXPORT VectorValues operator*	(	const double	a,
		const VectorValues &	v
	)

friend

Element-wise scaling by a constant.

Definition at line 347 of file VectorValues.cpp.

◆ operator<<

GTSAM_EXPORT friend std::ostream& operator<<	(	std::ostream &	os,
		const VectorValues &	v
	)

friend

overload operator << to print to stringstream

Definition at line 130 of file VectorValues.cpp.

Member Data Documentation

◆ values_

Values gtsam::VectorValues::values_

protected

Vectors making up this VectorValues.

Definition at line 78 of file VectorValues.h.

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

Public Types

Public Member Functions

Protected Types

Protected Attributes

Standard Constructors

Standard Interface

Linear algebra operations

Detailed Description

Advanced Interface and Performance Information

Member Typedef Documentation

◆ const_iterator

◆ Dims

◆ iterator

◆ KeyValuePair

◆ shared_ptr

◆ This

◆ value_type

◆ Values

Constructor & Destructor Documentation

◆ VectorValues() [1/8]

◆ VectorValues() [2/8]

◆ VectorValues() [3/8]

◆ VectorValues() [4/8]

◆ VectorValues() [5/8]

◆ VectorValues() [6/8]

◆ VectorValues() [7/8]

◆ VectorValues() [8/8]

Member Function Documentation

◆ add()

◆ addInPlace()

◆ addInPlace_()

◆ at() [1/2]

◆ at() [2/2]

◆ begin() [1/2]

◆ begin() [2/2]

◆ dim()

◆ dot()

◆ emplace()

◆ end() [1/2]

◆ end() [2/2]

◆ equals()

◆ erase()

◆ exists()

◆ find() [1/2]

◆ find() [2/2]

◆ hasSameStructure()

◆ html()

◆ insert() [1/3]

◆ insert() [2/3]

◆ insert() [3/3]

◆ insert_or_assign()

◆ norm()

◆ operator*=()

◆ operator+()

◆ operator+=()

◆ operator-()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ print()

◆ scale()

◆ scaleInPlace()

◆ setZero()

◆ size()

◆ squaredNorm()

◆ subtract()

◆ swap()

◆ tryInsert()

◆ update()

◆ vector() [1/3]

◆ vector() [2/3]

◆ vector() [3/3]

◆ Zero()

Friends And Related Function Documentation

◆ operator*

◆ operator<<

Member Data Documentation

◆ values_