gtsam 4.1.1
gtsam
gtsam::BoundingConstraint2< VALUE1, VALUE2 > Struct Template Referenceabstract

Detailed Description

template<class VALUE1, class VALUE2>
struct gtsam::BoundingConstraint2< VALUE1, VALUE2 >

Binary scalar inequality constraint, with a similar value() function to implement for specific systems.

+ Inheritance diagram for gtsam::BoundingConstraint2< VALUE1, VALUE2 >:

Public Member Functions

 BoundingConstraint2 (Key key1, Key key2, double threshold, bool isGreaterThan, double mu=1000.0)
 flag for greater/less than
 
double threshold () const
 
bool isGreaterThan () const
 
virtual double value (const X1 &x1, const X2 &x2, boost::optional< Matrix & > H1=boost::none, boost::optional< Matrix & > H2=boost::none) const =0
 function producing a scalar value to compare to the threshold Must have optional argument for derivatives)
 
bool active (const Values &c) const override
 active when constraint NOT met More...
 
Vector evaluateError (const X1 &x1, const X2 &x2, boost::optional< Matrix & > H1=boost::none, boost::optional< Matrix & > H2=boost::none) const override
 Override this method to finish implementing a binary factor. More...
 
- Public Member Functions inherited from gtsam::NoiseModelFactor2< VALUE1, VALUE2 >
 NoiseModelFactor2 ()
 Default Constructor for I/O.
 
 NoiseModelFactor2 (const SharedNoiseModel &noiseModel, Key j1, Key j2)
 Constructor. More...
 
Key key1 () const
 methods to retrieve both keys
 
Key key2 () const
 
Vector unwhitenedError (const Values &x, boost::optional< std::vector< Matrix > & > H=boost::none) const override
 Calls the 2-key specific version of evaluateError, which is pure virtual so must be implemented in the derived class. More...
 
virtual Vector evaluateError (const X1 &, const X2 &, boost::optional< Matrix & > H1=boost::none, boost::optional< Matrix & > H2=boost::none) const =0
 Override this method to finish implementing a binary factor. More...
 
- Public Member Functions inherited from gtsam::NoiseModelFactor
 NoiseModelFactor ()
 Default constructor for I/O only.
 
 ~NoiseModelFactor () override
 Destructor.
 
template<typename CONTAINER >
 NoiseModelFactor (const SharedNoiseModel &noiseModel, const CONTAINER &keys)
 Constructor.
 
void print (const std::string &s="", const KeyFormatter &keyFormatter=DefaultKeyFormatter) const override
 Print. More...
 
bool equals (const NonlinearFactor &f, double tol=1e-9) const override
 Check if two factors are equal. More...
 
size_t dim () const override
 get the dimension of the factor (number of rows on linearization) More...
 
const SharedNoiseModelnoiseModel () const
 access to the noise model
 
virtual Vector unwhitenedError (const Values &x, boost::optional< std::vector< Matrix > & > H=boost::none) const =0
 Error function without the NoiseModel, \( z-h(x) \). More...
 
Vector whitenedError (const Values &c) const
 Vector of errors, whitened This is the raw error, i.e., i.e. More...
 
Vector unweightedWhitenedError (const Values &c) const
 Vector of errors, whitened, but unweighted by any loss function.
 
double weight (const Values &c) const
 Compute the effective weight of the factor from the noise model.
 
double error (const Values &c) const override
 Calculate the error of the factor. More...
 
boost::shared_ptr< GaussianFactorlinearize (const Values &x) const override
 Linearize a non-linearFactorN to get a GaussianFactor, \( Ax-b \approx h(x+\delta x)-z = h(x) + A \delta x - z \) Hence \( b = z - h(x) = - \mathtt{error\_vector}(x) \). More...
 
shared_ptr cloneWithNewNoiseModel (const SharedNoiseModel newNoise) const
 Creates a shared_ptr clone of the factor with a new noise model.
 
- Public Member Functions inherited from gtsam::NonlinearFactor
 NonlinearFactor ()
 Default constructor for I/O only.
 
template<typename CONTAINER >
 NonlinearFactor (const CONTAINER &keys)
 Constructor from a collection of the keys involved in this factor.
 
virtual ~NonlinearFactor ()
 Destructor.
 
virtual shared_ptr clone () const
 Creates a shared_ptr clone of the factor - needs to be specialized to allow for subclasses. More...
 
virtual shared_ptr rekey (const std::map< Key, Key > &rekey_mapping) const
 Creates a shared_ptr clone of the factor with different keys using a map from old->new keys. More...
 
virtual shared_ptr rekey (const KeyVector &new_keys) const
 Clones a factor and fully replaces its keys. More...
 
virtual bool sendable () const
 Should the factor be evaluated in the same thread as the caller This is to enable factors that has shared states (like the Python GIL lock) More...
 
- Public Member Functions inherited from gtsam::Factor
virtual ~Factor ()=default
 Default destructor.
 
KeyVectorkeys ()
 
iterator begin ()
 Iterator at beginning of involved variable keys.
 
iterator end ()
 Iterator at end of involved variable keys.
 
virtual void printKeys (const std::string &s="Factor", const KeyFormatter &formatter=DefaultKeyFormatter) const
 print only keys More...
 
Key front () const
 First key.
 
Key back () const
 Last key.
 
const_iterator find (Key key) const
 find
 
const KeyVectorkeys () const
 Access the factor's involved variable keys.
 
const_iterator begin () const
 Iterator at beginning of involved variable keys.
 
const_iterator end () const
 Iterator at end of involved variable keys.
 
size_t size () const
 

Public Attributes

double threshold_
 
bool isGreaterThan_
 

Public Types

typedef VALUE1 X1
 
typedef VALUE2 X2
 
typedef NoiseModelFactor2< VALUE1, VALUE2 > Base
 
typedef boost::shared_ptr< BoundingConstraint2< VALUE1, VALUE2 > > shared_ptr
 
- Public Types inherited from gtsam::NoiseModelFactor2< VALUE1, VALUE2 >
typedef VALUE1 X1
 
typedef VALUE2 X2
 
- Public Types inherited from gtsam::NoiseModelFactor
typedef boost::shared_ptr< Thisshared_ptr
 Noise model.
 
- Public Types inherited from gtsam::NonlinearFactor
typedef boost::shared_ptr< Thisshared_ptr
 
- Public Types inherited from gtsam::Factor
typedef KeyVector::iterator iterator
 Iterator over keys.
 
typedef KeyVector::const_iterator const_iterator
 Const iterator over keys.
 

Friends

class boost::serialization::access
 Serialization function.
 

Additional Inherited Members

- Protected Types inherited from gtsam::NoiseModelFactor2< VALUE1, VALUE2 >
typedef NoiseModelFactor Base
 
typedef NoiseModelFactor2< VALUE1, VALUE2 > This
 
- 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::NoiseModelFactor
 NoiseModelFactor (const SharedNoiseModel &noiseModel)
 Constructor - only for subclasses, as this does not set keys.
 
- Protected Member Functions inherited from gtsam::Factor
 Factor ()
 Default constructor for I/O.
 
template<typename CONTAINER >
 Factor (const CONTAINER &keys)
 Construct factor from container of keys. More...
 
template<typename ITERATOR >
 Factor (ITERATOR first, ITERATOR last)
 Construct factor from iterator keys. More...
 
bool equals (const This &other, double tol=1e-9) const
 check equality
 
- Static Protected Member Functions inherited from gtsam::Factor
template<typename CONTAINER >
static Factor FromKeys (const CONTAINER &keys)
 Construct factor from container of keys. More...
 
template<typename ITERATOR >
static Factor FromIterators (ITERATOR first, ITERATOR last)
 Construct factor from iterator keys. More...
 
- Protected Attributes inherited from gtsam::NoiseModelFactor
SharedNoiseModel noiseModel_
 
- Protected Attributes inherited from gtsam::Factor
KeyVector keys_
 The keys involved in this factor.
 

Member Function Documentation

◆ active()

template<class VALUE1 , class VALUE2 >
bool gtsam::BoundingConstraint2< VALUE1, VALUE2 >::active ( const Values c) const
inlineoverridevirtual

active when constraint NOT met

Reimplemented from gtsam::NonlinearFactor.

◆ evaluateError()

template<class VALUE1 , class VALUE2 >
Vector gtsam::BoundingConstraint2< VALUE1, VALUE2 >::evaluateError ( const X1 &  ,
const X2 &  ,
boost::optional< Matrix & >  H1 = boost::none,
boost::optional< Matrix & >  H2 = boost::none 
) const
inlineoverridevirtual

Override this method to finish implementing a binary factor.

If any of the optional Matrix reference arguments are specified, it should compute both the function evaluation and its derivative(s) in X1 (and/or X2).

Implements gtsam::NoiseModelFactor2< VALUE1, VALUE2 >.


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