#include <NonlinearEqualityConstraint.h>

Inheritance diagram for gtsam::ZeroCostConstraint:

[legend]

Public Types
typedef NonlinearEqualityConstraint	Base

typedef std::shared_ptr< This >	shared_ptr

typedef ZeroCostConstraint	This

Public Types inherited from gtsam::NonlinearEqualityConstraint
typedef NonlinearConstraint	Base

typedef NonlinearFactor	Base

typedef std::shared_ptr< This >	shared_ptr

typedef NonlinearEqualityConstraint	This

Public Types inherited from gtsam::NonlinearConstraint
typedef NoiseModelFactor	Base

typedef NonlinearFactor	Base

Public Types inherited from gtsam::NoiseModelFactor
typedef std::shared_ptr< This >	shared_ptr

Public Types inherited from gtsam::NonlinearFactor
typedef std::shared_ptr< This >	shared_ptr

Public Types inherited from gtsam::Factor
typedef KeyVector::const_iterator	const_iterator
	Const iterator over keys. More...

typedef KeyVector::iterator	iterator
	Iterator over keys. More...

Public Member Functions
gtsam::NonlinearFactor::shared_ptr	clone () const override

virtual NoiseModelFactor::shared_ptr	penaltyFactor (const double mu=1.0) const override

virtual Vector	unwhitenedError (const Values &x, OptionalMatrixVecType H=nullptr) const override

	ZeroCostConstraint (const NoiseModelFactor::shared_ptr &factor)
	Constructor. More...

Public Member Functions inherited from gtsam::NonlinearEqualityConstraint
virtual	~NonlinearEqualityConstraint ()

Public Member Functions inherited from gtsam::NonlinearConstraint
double	error (const HybridValues &c) const override

virtual double	error (const Values &c) const

virtual bool	feasible (const Values &x, const double tolerance=1e-5) const

const Vector	sigmas () const

virtual std::vector< Matrix >	unwhitenedHessian (const Values &x) const

virtual double	violation (const Values &x) const

virtual	~NonlinearConstraint ()

Public Member Functions inherited from gtsam::NoiseModelFactor
shared_ptr	cloneWithNewNoiseModel (const SharedNoiseModel newNoise) const

size_t	dim () const override

bool	equals (const NonlinearFactor &f, double tol=1e-9) const override

double	error (const HybridValues &c) const override

virtual double	error (const Values &c) const

double	error (const Values &c) const override

std::shared_ptr< GaussianFactor >	linearize (const Values &x) const override

const SharedNoiseModel &	noiseModel () const
	access to the noise model More...

	NoiseModelFactor ()

template<typename CONTAINER >
	NoiseModelFactor (const SharedNoiseModel &noiseModel, const CONTAINER &keys)

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

Vector	unweightedWhitenedError (const Values &c) const

Vector	unwhitenedError (const Values &x, std::vector< Matrix > &H) const

double	weight (const Values &c) const

Vector	whitenedError (const Values &c) const

	~NoiseModelFactor () override

Public Member Functions inherited from gtsam::NonlinearFactor
	NonlinearFactor ()

template<typename CONTAINER >
	NonlinearFactor (const CONTAINER &keys)

double	error (const HybridValues &c) const override

virtual bool	active (const Values &c) const

virtual shared_ptr	rekey (const std::map< Key, Key > &rekey_mapping) const

virtual shared_ptr	rekey (const KeyVector &new_keys) const

virtual bool	sendable () const

Public Member Functions inherited from gtsam::Factor
virtual	~Factor ()=default
	Default destructor. More...

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

Key	front () const
	First key. More...

Key	back () const
	Last key. More...

const_iterator	find (Key key) const
	find More...

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

const_iterator	begin () const

const_iterator	end () const

size_t	size () const

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

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

KeyVector &	keys ()

iterator	begin ()

iterator	end ()

Protected Attributes
NoiseModelFactor::shared_ptr	factor_

Protected Attributes inherited from gtsam::NoiseModelFactor
SharedNoiseModel	noiseModel_

Protected Attributes inherited from gtsam::Factor
KeyVector	keys_
	The keys involved in this factor. More...

Additional Inherited Members
Protected Types inherited from gtsam::NoiseModelFactor
typedef NonlinearFactor	Base

typedef NoiseModelFactor	This

Protected Types inherited from gtsam::NonlinearFactor
typedef Factor	Base

typedef NonlinearFactor	This

Protected Member Functions inherited from gtsam::NonlinearConstraint
SharedDiagonal	penaltyNoise (const double mu) const

Protected Member Functions inherited from gtsam::NoiseModelFactor
	NoiseModelFactor (const SharedNoiseModel &noiseModel)

Protected Member Functions inherited from gtsam::Factor
	Factor ()

template<typename CONTAINER >
	Factor (const CONTAINER &keys)

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

Static Protected Member Functions inherited from gtsam::NonlinearConstraint
static SharedNoiseModel	constrainedNoise (const Vector &sigmas)

Static Protected Member Functions inherited from gtsam::Factor
template<typename CONTAINER >
static Factor	FromKeys (const CONTAINER &keys)

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

Detailed Description

Equality constraint that enforce the cost factor with zero error. e.g., for a factor with unwhitened cost 2x-1, the constraint enforces the equlity 2x-1=0.

Definition at line 106 of file NonlinearEqualityConstraint.h.

Member Typedef Documentation

◆ Base

typedef NonlinearEqualityConstraint gtsam::ZeroCostConstraint::Base

Definition at line 108 of file NonlinearEqualityConstraint.h.

◆ shared_ptr

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

Definition at line 110 of file NonlinearEqualityConstraint.h.

◆ This

typedef ZeroCostConstraint gtsam::ZeroCostConstraint::This

Definition at line 109 of file NonlinearEqualityConstraint.h.

Constructor & Destructor Documentation

◆ ZeroCostConstraint()

gtsam::ZeroCostConstraint::ZeroCostConstraint ( const NoiseModelFactor::shared_ptr & factor )

Constructor.

Parameters

factor NoiseModel factor.

Definition at line 24 of file NonlinearEqualityConstraint.cpp.

Member Function Documentation

◆ clone()

gtsam::NonlinearFactor::shared_ptr gtsam::ZeroCostConstraint::clone ( ) const

inlineoverridevirtual

Returns: a deep copy of this factor

Reimplemented from gtsam::NonlinearFactor.

Definition at line 128 of file NonlinearEqualityConstraint.h.

◆ penaltyFactor()

NoiseModelFactor::shared_ptr gtsam::ZeroCostConstraint::penaltyFactor ( const double mu = 1.0 ) const

overridevirtual

Create a cost factor representing the L2 penalty function with scaling coefficient mu.

Reimplemented from gtsam::NonlinearConstraint.

Definition at line 33 of file NonlinearEqualityConstraint.cpp.

◆ unwhitenedError()

Vector gtsam::ZeroCostConstraint::unwhitenedError	(	const Values &	x,
		OptionalMatrixVecType	H = `nullptr`
	)		const

overridevirtual

Error function without the NoiseModel, $ z-h(x) $ . Override this method to finish implementing an N-way factor. If the optional arguments is specified, it should compute both the function evaluation and its derivative(s) in H.