#include <simulated2DConstraints.h>

Inheritance diagram for simulated2D::inequality_constraints::MaxDistanceConstraint< VALUE >:

[legend]

Public Types
typedef BoundingConstraint2< VALUE, VALUE >	Base
	Base class for factor. More...

typedef VALUE	Point
	Type of variable constrained. More...

typedef MaxDistanceConstraint< VALUE >	This
	This class for factor. More...

Public Types inherited from gtsam::BoundingConstraint2< VALUE, VALUE >
typedef NonlinearInequalityConstraint	Base

typedef std::shared_ptr< BoundingConstraint2< VALUE, VALUE > >	shared_ptr

typedef VALUE	X1

typedef VALUE	X2

Public Types inherited from gtsam::NonlinearInequalityConstraint
typedef NonlinearConstraint	Base

typedef NonlinearFactor	Base

typedef std::shared_ptr< This >	shared_ptr

typedef NonlinearInequalityConstraint	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

	MaxDistanceConstraint (Key key1, Key key2, double range_bound, double mu=1000.0)

double	value (const Point &x1, const Point &x2, OptionalMatrixType H1=OptionalNone, OptionalMatrixType H2=OptionalNone) const override

	~MaxDistanceConstraint () override

Public Member Functions inherited from gtsam::BoundingConstraint2< VALUE, VALUE >
	BoundingConstraint2 (Key key1, Key key2, double threshold, bool isGreaterThan, double mu=1000.0)
	flag for greater/less than More...

Vector	evaluateError (const X1 &x1, const X2 &x2, OptionalMatrixType H1={}, OptionalMatrixType H2={}) const
	TODO: This should be deprecated. More...

bool	isGreaterThan () const

double	threshold () const

Vector	unwhitenedExpr (const Values &x, OptionalMatrixVecType H={}) const override

	~BoundingConstraint2 () override

Public Member Functions inherited from gtsam::NonlinearInequalityConstraint
virtual bool	active (const Values &x) const override

virtual NonlinearEqualityConstraint::shared_ptr	createEqualityConstraint () const

virtual NoiseModelFactor::shared_ptr	penaltyFactorCustom (InequalityPenaltyFunction::shared_ptr func, const double mu=1.0) const

virtual NoiseModelFactor::shared_ptr	penaltyFactorEquality (const double mu=1.0) const

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

virtual Vector	whitenedExpr (const Values &x) const

virtual	~NonlinearInequalityConstraint ()

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

virtual NoiseModelFactor::shared_ptr	penaltyFactor (const double mu=1.0) 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 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 ()

Additional Inherited Members
Public Attributes inherited from gtsam::BoundingConstraint2< VALUE, VALUE >
bool	isGreaterThan_

double	threshold_

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)

Protected Attributes inherited from gtsam::NoiseModelFactor
SharedNoiseModel	noiseModel_

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

Detailed Description

template<class VALUE>
struct simulated2D::inequality_constraints::MaxDistanceConstraint< VALUE >

Binary inequality constraint forcing the range between points to be less than or equal to a bound

Template Parameters

VALUES	is the variable set for the graph
KEY	is the type of the keys for the variables constrained

Definition at line 124 of file simulated2DConstraints.h.

Member Typedef Documentation

◆ Base

template<class VALUE >

typedef BoundingConstraint2<VALUE, VALUE> simulated2D::inequality_constraints::MaxDistanceConstraint< VALUE >::Base

Base class for factor.

Definition at line 125 of file simulated2DConstraints.h.

◆ Point

template<class VALUE >

typedef VALUE simulated2D::inequality_constraints::MaxDistanceConstraint< VALUE >::Point

Type of variable constrained.

Definition at line 127 of file simulated2DConstraints.h.

◆ This

template<class VALUE >

typedef MaxDistanceConstraint<VALUE> simulated2D::inequality_constraints::MaxDistanceConstraint< VALUE >::This

This class for factor.

Definition at line 126 of file simulated2DConstraints.h.

Constructor & Destructor Documentation

◆ ~MaxDistanceConstraint()

template<class VALUE >

simulated2D::inequality_constraints::MaxDistanceConstraint< VALUE >::~MaxDistanceConstraint ( )

inlineoverride

Definition at line 129 of file simulated2DConstraints.h.

◆ MaxDistanceConstraint()

template<class VALUE >

simulated2D::inequality_constraints::MaxDistanceConstraint< VALUE >::MaxDistanceConstraint	(	Key	key1,
		Key	key2,
		double	range_bound,
		double	mu = `1000.0`
	)

inline

Primary constructor for factor

Parameters

key1	is the first variable key
key2	is the second variable key
range_bound	is the maximum range allowed between the variables
mu	is the gain for the penalty function

Definition at line 143 of file simulated2DConstraints.h.

Member Function Documentation

◆ clone()

template<class VALUE >

gtsam::NonlinearFactor::shared_ptr simulated2D::inequality_constraints::MaxDistanceConstraint< VALUE >::clone ( ) const

inlineoverridevirtual

Returns: a deep copy of this factor

Reimplemented from gtsam::NonlinearFactor.

Definition at line 132 of file simulated2DConstraints.h.

◆ value()

template<class VALUE >

double simulated2D::inequality_constraints::MaxDistanceConstraint< VALUE >::value	(	const Point &	x1,
		const Point &	x2,
		OptionalMatrixType	H1 = `OptionalNone`,
		OptionalMatrixType	H2 = `OptionalNone`
	)		const

inlineoverridevirtual

computes the range with derivatives

Parameters

x1	is the first variable value
x2	is the second variable value
H1	is an optional Jacobian in x1
H2	is an optional Jacobian in x2

Returns: the distance between the variables

Implements gtsam::BoundingConstraint2< VALUE, VALUE >.

Definition at line 154 of file simulated2DConstraints.h.

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

simulated2DConstraints.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

template<class VALUE> struct simulated2D::inequality_constraints::MaxDistanceConstraint< VALUE >

Member Typedef Documentation

◆ Base

◆ Point

◆ This

Constructor & Destructor Documentation

◆ ~MaxDistanceConstraint()

◆ MaxDistanceConstraint()

Member Function Documentation

◆ clone()

◆ value()

template<class VALUE>
struct simulated2D::inequality_constraints::MaxDistanceConstraint< VALUE >