#include <LinearCost.h>

Inheritance diagram for gtsam::LinearCost:

Collaboration diagram for gtsam::LinearCost:

[legend]

Public Types
typedef LinearCost	This
	Typedef to this class.

typedef JacobianFactor	Base
	Typedef to base class.

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

typedef VerticalBlockMatrix::Block	ABlock

typedef VerticalBlockMatrix::constBlock	constABlock

typedef ABlock::ColXpr	BVector

typedef constABlock::ConstColXpr	constBVector

typedef KeyVector::iterator	iterator
	Iterator over keys.

typedef KeyVector::const_iterator	const_iterator
	Const iterator over keys.

Public Member Functions
	LinearCost ()

	LinearCost (const HessianFactor &hf)

	LinearCost (const JacobianFactor &jf)

	LinearCost (Key i1, const RowVector &A1)

	LinearCost (Key i1, const RowVector &A1, Key i2, const RowVector &A2, double b)

	LinearCost (Key i1, const RowVector &A1, Key i2, const RowVector &A2, Key i3, const RowVector &A3)

template<typename TERMS >
	LinearCost (const TERMS &terms)

	~LinearCost () override

bool	equals (const GaussianFactor &lf, double tol=1e-9) const override

void	print (const std::string &s="", const KeyFormatter &formatter=DefaultKeyFormatter) const override

GaussianFactor::shared_ptr	clone () const override

Vector	error_vector (const VectorValues &c) const

double	error (const VectorValues &c) const override

Vector	unweighted_error (const VectorValues &c) const

Matrix	augmentedInformation () const override

Matrix	information () const override

void	hessianDiagonalAdd (VectorValues &d) const override
	Add the current diagonal to a VectorValues instance.

void	hessianDiagonal (double *d) const override
	Raw memory access version of hessianDiagonal.

std::map< Key, Matrix >	hessianBlockDiagonal () const override
	Return the block diagonal of the Hessian for this factor.

std::pair< Matrix, Vector >	jacobian () const override
	Returns (dense) A,b pair associated with factor, bakes in the weights.

std::pair< Matrix, Vector >	jacobianUnweighted () const
	Returns (dense) A,b pair associated with factor, does not bake in weights.

Matrix	augmentedJacobian () const override

Matrix	augmentedJacobianUnweighted () const

const VerticalBlockMatrix &	matrixObject () const

VerticalBlockMatrix &	matrixObject ()

GaussianFactor::shared_ptr	negate () const override

bool	isConstrained () const

DenseIndex	getDim (const_iterator variable) const override

size_t	rows () const

size_t	cols () const

const SharedDiagonal &	get_model () const

SharedDiagonal &	get_model ()

const constBVector	getb () const

BVector	getb ()

constABlock	getA (const_iterator variable) const

constABlock	getA () const

ABlock	getA (iterator variable)

ABlock	getA ()

void	updateHessian (const KeyVector &keys, SymmetricBlockMatrix *info) const override

Vector	operator* (const VectorValues &x) const

void	transposeMultiplyAdd (double alpha, const Vector &e, VectorValues &x) const

void	multiplyHessianAdd (double alpha, const VectorValues &x, VectorValues &y) const override

void	multiplyHessianAdd (double alpha, const double x, double y, const std::vector< size_t > &accumulatedDims) const

VectorValues	gradientAtZero () const override
	A'*b for Jacobian.

void	gradientAtZero (double *d) const override
	A'*b for Jacobian (raw memory version)

Vector	gradient (Key key, const VectorValues &x) const override
	Compute the gradient wrt a key at any values.

JacobianFactor	whiten () const

std::pair< std::shared_ptr< GaussianConditional >, shared_ptr >	eliminate (const Ordering &keys)

void	setModel (bool anyConstrained, const Vector &sigmas)

std::shared_ptr< GaussianConditional >	splitConditional (size_t nrFrontals)

Testable
bool	equals (const This &other, double tol=1e-9) const
	check equality

virtual void	printKeys (const std::string &s="Factor", const KeyFormatter &formatter=DefaultKeyFormatter) const
	print only keys

Standard Interface
double	error (const HybridValues &c) const override

VectorValues	hessianDiagonal () const
	Return the diagonal of the Hessian for this factor.

Standard Interface
bool	empty () const
	Whether the factor is empty (involves zero variables).

Key	front () const
	First key.

Key	back () const
	Last key.

const_iterator	find (Key key) const
	find

const KeyVector &	keys () const
	Access the factor's involved variable keys.

const_iterator	begin () const

const_iterator	end () const

size_t	size () const

Advanced Interface
KeyVector &	keys ()

iterator	begin ()

iterator	end ()

Static Public Member Functions
Advanced Interface
template<typename CONTAINER >
static DenseIndex	Slot (const CONTAINER &keys, Key key)

Protected Member Functions
template<typename TERMS >
void	fillTerms (const TERMS &terms, const Vector &b, const SharedDiagonal &noiseModel)
	Internal function to fill blocks and set dimensions.

Static Protected Member Functions
Standard Constructors
template<typename CONTAINER >
static Factor	FromKeys (const CONTAINER &keys)

template<typename ITERATOR >
static Factor	FromIterators (ITERATOR first, ITERATOR last)

Protected Attributes
VerticalBlockMatrix	Ab_

noiseModel::Diagonal::shared_ptr	model_

KeyVector	keys_
	The keys involved in this factor.

Detailed Description

This class defines a linear cost function c'x which is a JacobianFactor with only one row

Constructor & Destructor Documentation

◆ LinearCost() [1/7]

gtsam::LinearCost::LinearCost ( )

inline

default constructor for I/O

◆ LinearCost() [2/7]

gtsam::LinearCost::LinearCost ( const HessianFactor & hf )

inlineexplicit

Conversion from HessianFactor

◆ LinearCost() [3/7]

gtsam::LinearCost::LinearCost ( const JacobianFactor & jf )

inlineexplicit

Conversion from JacobianFactor

◆ LinearCost() [4/7]

gtsam::LinearCost::LinearCost	(	Key	i1,
		const RowVector &	A1
	)

inline

Construct unary factor

◆ LinearCost() [5/7]

gtsam::LinearCost::LinearCost	(	Key	i1,
		const RowVector &	A1,
		Key	i2,
		const RowVector &	A2,
		double	b
	)

inline

Construct binary factor

◆ LinearCost() [6/7]

gtsam::LinearCost::LinearCost	(	Key	i1,
		const RowVector &	A1,
		Key	i2,
		const RowVector &	A2,
		Key	i3,
		const RowVector &	A3
	)

inline

Construct ternary factor

◆ LinearCost() [7/7]

template<typename TERMS >

gtsam::LinearCost::LinearCost ( const TERMS & terms )

inline

Construct an n-ary factor

Template Parameters

TERMS A container whose value type is std::pair<Key, Matrix>, specifying the collection of keys and matrices making up the factor.

◆ ~LinearCost()

gtsam::LinearCost::~LinearCost ( )

inlineoverride

Virtual destructor

Member Function Documentation

◆ augmentedInformation()

Matrix gtsam::JacobianFactor::augmentedInformation ( ) const

overridevirtualinherited

Return the augmented information matrix represented by this GaussianFactor. The augmented information matrix contains the information matrix with an additional column holding the information vector, and an additional row holding the transpose of the information vector. The lower-right entry contains the constant error term (when \( \delta x = 0 \)). The augmented information matrix is described in more detail in HessianFactor, which in fact stores an augmented information matrix.

Implements gtsam::GaussianFactor.

◆ augmentedJacobian()

Matrix gtsam::JacobianFactor::augmentedJacobian ( ) const

overridevirtualinherited

Return (dense) matrix associated with factor. The returned system is an augmented matrix: [A b] weights are baked in

Implements gtsam::GaussianFactor.

◆ augmentedJacobianUnweighted()

Matrix gtsam::JacobianFactor::augmentedJacobianUnweighted ( ) const

inherited

Return (dense) matrix associated with factor. The returned system is an augmented matrix: [A b] weights are not baked in

◆ begin() [1/2]

const_iterator gtsam::Factor::begin ( ) const

inlineinherited

Iterator at beginning of involved variable keys

◆ begin() [2/2]

iterator gtsam::Factor::begin ( )

inlineinherited

Iterator at beginning of involved variable keys

◆ clone()

GaussianFactor::shared_ptr gtsam::LinearCost::clone ( ) const

inlineoverridevirtual

Clone this LinearCost

Reimplemented from gtsam::JacobianFactor.

◆ cols()

size_t gtsam::JacobianFactor::cols ( ) const

inlineinherited

return the number of columns in the corresponding linear system

◆ eliminate()

std::pair<std::shared_ptr<GaussianConditional>, shared_ptr> gtsam::JacobianFactor::eliminate ( const Ordering & keys )

inherited

Eliminate the requested variables.

◆ end() [1/2]

const_iterator gtsam::Factor::end ( ) const

inlineinherited

Iterator at end of involved variable keys

◆ end() [2/2]

iterator gtsam::Factor::end ( )

inlineinherited

Iterator at end of involved variable keys

◆ equals()

bool gtsam::LinearCost::equals	(	const GaussianFactor &	lf,
		double	tol = `1e-9`
	)		const

inlineoverridevirtual

equals

Reimplemented from gtsam::JacobianFactor.

◆ error() [1/2]

double gtsam::GaussianFactor::error ( const HybridValues & c ) const

overridevirtualinherited

All factor types need to implement an error function. In factor graphs, this is the negative log-likelihood.

Reimplemented from gtsam::Factor.

◆ error() [2/2]

double gtsam::LinearCost::error ( const VectorValues & c ) const

inlineoverridevirtual

Special error for single-valued inequality constraints.

Reimplemented from gtsam::JacobianFactor.

◆ error_vector()

Vector gtsam::LinearCost::error_vector ( const VectorValues & c ) const

inline

Special error_vector for constraints (A*x-b)

◆ FromIterators()

template<typename ITERATOR >

static Factor gtsam::Factor::FromIterators	(	ITERATOR	first,
		ITERATOR	last
	)

inlinestaticprotectedinherited

Construct factor from iterator keys. This is called internally from derived factor static factor methods, as a workaround for not being able to call the protected constructors above.

◆ FromKeys()

template<typename CONTAINER >

static Factor gtsam::Factor::FromKeys ( const CONTAINER & keys )

inlinestaticprotectedinherited

Construct factor from container of keys. This is called internally from derived factor static factor methods, as a workaround for not being able to call the protected constructors above.

◆ get_model() [1/2]

const SharedDiagonal& gtsam::JacobianFactor::get_model ( ) const

inlineinherited

get a copy of model

◆ get_model() [2/2]

SharedDiagonal& gtsam::JacobianFactor::get_model ( )

inlineinherited

get a copy of model (non-const version)

◆ getA() [1/4]

constABlock gtsam::JacobianFactor::getA ( const_iterator variable ) const

inlineinherited

Get a view of the A matrix for the variable pointed to by the given key iterator

◆ getA() [2/4]

constABlock gtsam::JacobianFactor::getA ( ) const

inlineinherited

Get a view of the A matrix, not weighted by noise

◆ getA() [3/4]

ABlock gtsam::JacobianFactor::getA ( iterator variable )

inlineinherited

Get a view of the A matrix for the variable pointed to by the given key iterator (non-const version)

◆ getA() [4/4]

ABlock gtsam::JacobianFactor::getA ( )

inlineinherited

Get a view of the A matrix

◆ getb() [1/2]

const constBVector gtsam::JacobianFactor::getb ( ) const

inlineinherited

Get a view of the r.h.s. vector b, not weighted by noise

◆ getb() [2/2]

BVector gtsam::JacobianFactor::getb ( )

inlineinherited

Get a view of the r.h.s. vector b (non-const version)

◆ getDim()

DenseIndex gtsam::JacobianFactor::getDim ( const_iterator variable ) const

inlineoverridevirtualinherited

Return the dimension of the variable pointed to by the given key iterator todo: Remove this in favor of keeping track of dimensions with variables?

Implements gtsam::GaussianFactor.

◆ information()

Matrix gtsam::JacobianFactor::information ( ) const

overridevirtualinherited

Return the non-augmented information matrix represented by this GaussianFactor.

Implements gtsam::GaussianFactor.

◆ isConstrained()

bool gtsam::JacobianFactor::isConstrained ( ) const

inlineinherited

is noise model constrained ?

◆ keys()

KeyVector& gtsam::Factor::keys ( )

inlineinherited

Returns: keys involved in this factor

◆ matrixObject() [1/2]

const VerticalBlockMatrix& gtsam::JacobianFactor::matrixObject ( ) const

inlineinherited

Return the full augmented Jacobian matrix of this factor as a VerticalBlockMatrix object.

◆ matrixObject() [2/2]

VerticalBlockMatrix& gtsam::JacobianFactor::matrixObject ( )

inlineinherited

Mutable access to the full augmented Jacobian matrix of this factor as a VerticalBlockMatrix object.

◆ multiplyHessianAdd() [1/2]

void gtsam::JacobianFactor::multiplyHessianAdd	(	double	alpha,
		const VectorValues &	x,
		VectorValues &	y
	)		const

overridevirtualinherited

y += alpha * A'*A*x

Implements gtsam::GaussianFactor.

Reimplemented in gtsam::RegularJacobianFactor< D >.

◆ multiplyHessianAdd() [2/2]

void gtsam::JacobianFactor::multiplyHessianAdd	(	double	alpha,
		const double *	x,
		double *	y,
		const std::vector< size_t > &	accumulatedDims
	)		const

inherited

Raw memory access version of multiplyHessianAdd y += alpha * A'*A*x Requires the vector accumulatedDims to tell the dimension of each variable: e.g.: x0 has dim 3, x2 has dim 6, x3 has dim 2, then accumulatedDims is [0 3 9 11 13] NOTE: size of accumulatedDims is size of keys + 1!! TODO(frank): we should probably kill this if no longer needed

◆ negate()

GaussianFactor::shared_ptr gtsam::JacobianFactor::negate ( ) const

overridevirtualinherited

Construct the corresponding anti-factor to negate information stored stored in this factor.

Returns: a HessianFactor with negated Hessian matrices

Implements gtsam::GaussianFactor.

◆ operator*()

Vector gtsam::JacobianFactor::operator* ( const VectorValues & x ) const

inherited

Return A*x

◆ print()

void gtsam::LinearCost::print	(	const std::string &	s = `""`,
		const KeyFormatter &	formatter = `DefaultKeyFormatter`
	)		const

inlineoverridevirtual

print

Reimplemented from gtsam::JacobianFactor.

◆ rows()

size_t gtsam::JacobianFactor::rows ( ) const

inlineinherited

return the number of rows in the corresponding linear system

◆ setModel()

void gtsam::JacobianFactor::setModel	(	bool	anyConstrained,
		const Vector &	sigmas
	)

inherited

set noiseModel correctly

◆ size()

size_t gtsam::Factor::size ( ) const

inlineinherited

Returns: the number of variables involved in this factor

◆ splitConditional()

std::shared_ptr<GaussianConditional> gtsam::JacobianFactor::splitConditional ( size_t nrFrontals )

inherited

splits a pre-factorized factor into a conditional, and changes the current factor to be the remaining component. Performs same operation as eliminate(), but without running QR. NOTE: looks at dimension of noise model to determine how many rows to keep.

Parameters

nrFrontals number of keys to eliminate

◆ transposeMultiplyAdd()

void gtsam::JacobianFactor::transposeMultiplyAdd	(	double	alpha,
		const Vector &	e,
		VectorValues &	x
	)		const

inherited

x += alpha * A'*e. If x is initially missing any values, they are created and assumed to start as zero vectors.

◆ updateHessian()

void gtsam::JacobianFactor::updateHessian	(	const KeyVector &	keys,
		SymmetricBlockMatrix *	info
	)		const

overridevirtualinherited

Update an information matrix by adding the information corresponding to this factor (used internally during elimination).

Parameters

scatter	A mapping from variable index to slot index in this HessianFactor
info	The information matrix to be updated

Implements gtsam::GaussianFactor.

◆ whiten()

JacobianFactor gtsam::JacobianFactor::whiten ( ) const

inherited

Return a whitened version of the factor, i.e. with unit diagonal noise model.

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

/home/docs/checkouts/readthedocs.org/user_builds/gtsam-jlblanco-docs/checkouts/latest/gtsam_unstable/linear/LinearCost.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ LinearCost() [1/7]

◆ LinearCost() [2/7]

◆ LinearCost() [3/7]

◆ LinearCost() [4/7]

◆ LinearCost() [5/7]

◆ LinearCost() [6/7]

◆ LinearCost() [7/7]

◆ ~LinearCost()

Member Function Documentation

◆ augmentedInformation()

◆ augmentedJacobian()

◆ augmentedJacobianUnweighted()

◆ begin() [1/2]

◆ begin() [2/2]

◆ clone()

◆ cols()

◆ eliminate()

◆ end() [1/2]

◆ end() [2/2]

◆ equals()

◆ error() [1/2]

◆ error() [2/2]

◆ error_vector()

◆ FromIterators()

◆ FromKeys()

◆ get_model() [1/2]

◆ get_model() [2/2]

◆ getA() [1/4]

◆ getA() [2/4]

◆ getA() [3/4]

◆ getA() [4/4]

◆ getb() [1/2]

◆ getb() [2/2]

◆ getDim()

◆ information()

◆ isConstrained()

◆ keys()

◆ matrixObject() [1/2]

◆ matrixObject() [2/2]

◆ multiplyHessianAdd() [1/2]

◆ multiplyHessianAdd() [2/2]

◆ negate()

◆ operator*()

◆ print()

◆ rows()

◆ setModel()

◆ size()

◆ splitConditional()

◆ transposeMultiplyAdd()

◆ updateHessian()

◆ whiten()