#include <BoundingConstraint.h>
Inheritance diagram for gtsam::BoundingConstraint2< VALUE1, VALUE2 >:
Public Types | |
| typedef NonlinearInequalityConstraint | Base |
| typedef std::shared_ptr< BoundingConstraint2< VALUE1, VALUE2 > > | shared_ptr |
| typedef VALUE1 | X1 |
| typedef VALUE2 | 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 | |
| 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 |
| virtual double | value (const X1 &x1, const X2 &x2, OptionalMatrixType H1=OptionalNone, OptionalMatrixType H2=OptionalNone) const =0 |
| ~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 | clone () 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 () |
Public Attributes | |
| bool | isGreaterThan_ |
| double | threshold_ |
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) |
| 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 VALUE1, class VALUE2>
struct gtsam::BoundingConstraint2< VALUE1, VALUE2 >
Binary scalar inequality constraint, with a similar value() function to implement for specific systems
Definition at line 113 of file BoundingConstraint.h.
Member Typedef Documentation
◆ Base
template<class VALUE1 , class VALUE2 >
| typedef NonlinearInequalityConstraint gtsam::BoundingConstraint2< VALUE1, VALUE2 >::Base |
Definition at line 117 of file BoundingConstraint.h.
◆ shared_ptr
template<class VALUE1 , class VALUE2 >
| typedef std::shared_ptr<BoundingConstraint2<VALUE1, VALUE2> > gtsam::BoundingConstraint2< VALUE1, VALUE2 >::shared_ptr |
Definition at line 118 of file BoundingConstraint.h.
◆ X1
template<class VALUE1 , class VALUE2 >
| typedef VALUE1 gtsam::BoundingConstraint2< VALUE1, VALUE2 >::X1 |
Definition at line 114 of file BoundingConstraint.h.
◆ X2
template<class VALUE1 , class VALUE2 >
| typedef VALUE2 gtsam::BoundingConstraint2< VALUE1, VALUE2 >::X2 |
Definition at line 115 of file BoundingConstraint.h.
Constructor & Destructor Documentation
◆ BoundingConstraint2()
template<class VALUE1 , class VALUE2 >
|
inline |
flag for greater/less than
Definition at line 123 of file BoundingConstraint.h.
◆ ~BoundingConstraint2()
template<class VALUE1 , class VALUE2 >
|
inlineoverride |
Definition at line 128 of file BoundingConstraint.h.
Member Function Documentation
◆ evaluateError()
template<class VALUE1 , class VALUE2 >
|
inline |
TODO: This should be deprecated.
Definition at line 160 of file BoundingConstraint.h.
◆ isGreaterThan()
template<class VALUE1 , class VALUE2 >
|
inline |
Definition at line 131 of file BoundingConstraint.h.
◆ threshold()
template<class VALUE1 , class VALUE2 >
|
inline |
Definition at line 130 of file BoundingConstraint.h.
◆ unwhitenedExpr()
template<class VALUE1 , class VALUE2 >
|
inlineoverridevirtual |
Return g(x).
Implements gtsam::NonlinearInequalityConstraint.
Definition at line 141 of file BoundingConstraint.h.
◆ value()
template<class VALUE1 , class VALUE2 >
|
pure virtual |
function producing a scalar value to compare to the threshold Must have optional argument for derivatives)
Implemented in simulated2D::inequality_constraints::MinDistanceConstraint< POSE, POINT >, and simulated2D::inequality_constraints::MaxDistanceConstraint< VALUE >.
Member Data Documentation
◆ isGreaterThan_
template<class VALUE1 , class VALUE2 >
| bool gtsam::BoundingConstraint2< VALUE1, VALUE2 >::isGreaterThan_ |
Definition at line 121 of file BoundingConstraint.h.
◆ threshold_
template<class VALUE1 , class VALUE2 >
| double gtsam::BoundingConstraint2< VALUE1, VALUE2 >::threshold_ |
Definition at line 120 of file BoundingConstraint.h.
The documentation for this struct was generated from the following file: