Public Types | Public Member Functions | Public Attributes | Private Member Functions | Friends | List of all members
gtsam::BoundingConstraint1< VALUE > Struct Template Referenceabstract

#include <BoundingConstraint.h>

Inheritance diagram for gtsam::BoundingConstraint1< VALUE >:
Inheritance graph
[legend]

Public Types

typedef NoiseModelFactor1< VALUE > Base
 
typedef boost::shared_ptr< BoundingConstraint1< VALUE > > shared_ptr
 
typedef VALUE X
 
- Public Types inherited from gtsam::NoiseModelFactor1< VALUE >
typedef VALUE X
 
- Public Types inherited from gtsam::NoiseModelFactor
typedef boost::shared_ptr< Thisshared_ptr
 
- Public Types inherited from gtsam::NonlinearFactor
typedef boost::shared_ptr< Thisshared_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

bool active (const Values &c) const override
 
 BoundingConstraint1 (Key key, double threshold, bool isGreaterThan, double mu=1000.0)
 flag for greater/less than More...
 
Vector evaluateError (const X &x, boost::optional< Matrix & > H=boost::none) const override
 
bool isGreaterThan () const
 
double threshold () const
 
virtual double value (const X &x, boost::optional< Matrix & > H=boost::none) const =0
 
 ~BoundingConstraint1 () override
 
- Public Member Functions inherited from gtsam::NoiseModelFactor1< VALUE >
 NoiseModelFactor1 ()
 
 ~NoiseModelFactor1 () override
 
Key key () const
 
 NoiseModelFactor1 (const SharedNoiseModel &noiseModel, Key key1)
 
Vector unwhitenedError (const Values &x, boost::optional< std::vector< Matrix > & > H=boost::none) const override
 
- 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 Values &c) const override
 
boost::shared_ptr< GaussianFactorlinearize (const Values &x) const override
 
const SharedNoiseModelnoiseModel () 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
 
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)
 
virtual ~NonlinearFactor ()
 
virtual shared_ptr clone () const
 
shared_ptr rekey (const std::map< Key, Key > &rekey_mapping) const
 
shared_ptr rekey (const KeyVector &new_keys) const
 
- Public Member Functions inherited from gtsam::Factor
virtual ~Factor ()=default
 Default destructor. More...
 
KeyVectorkeys ()
 
iterator begin ()
 
iterator end ()
 
virtual void printKeys (const std::string &s="Factor", const KeyFormatter &formatter=DefaultKeyFormatter) const
 print only keys More...
 
Key front () const
 First key. More...
 
Key back () const
 Last key. More...
 
const_iterator find (Key key) const
 find More...
 
const KeyVectorkeys () const
 Access the factor's involved variable keys. More...
 
const_iterator begin () const
 
const_iterator end () const
 
size_t size () const
 

Public Attributes

bool isGreaterThan_
 
double threshold_
 

Private Member Functions

template<class ARCHIVE >
void serialize (ARCHIVE &ar, const unsigned int)
 

Friends

class boost::serialization::access
 

Additional Inherited Members

- Protected Types inherited from gtsam::NoiseModelFactor1< VALUE >
typedef NoiseModelFactor Base
 
typedef NoiseModelFactor1< VALUE > 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)
 
- Protected Member Functions inherited from gtsam::Factor
 Factor ()
 
template<typename CONTAINER >
 Factor (const CONTAINER &keys)
 
template<typename ITERATOR >
 Factor (ITERATOR first, ITERATOR last)
 
bool equals (const This &other, double tol=1e-9) const
 check equality More...
 
- 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 gtsam::BoundingConstraint1< VALUE >

Definition at line 33 of file BoundingConstraint.h.

Member Typedef Documentation

template<class VALUE >
typedef NoiseModelFactor1<VALUE> gtsam::BoundingConstraint1< VALUE >::Base

Definition at line 35 of file BoundingConstraint.h.

template<class VALUE >
typedef boost::shared_ptr<BoundingConstraint1<VALUE> > gtsam::BoundingConstraint1< VALUE >::shared_ptr

Definition at line 36 of file BoundingConstraint.h.

template<class VALUE >
typedef VALUE gtsam::BoundingConstraint1< VALUE >::X

Definition at line 34 of file BoundingConstraint.h.

Constructor & Destructor Documentation

template<class VALUE >
gtsam::BoundingConstraint1< VALUE >::BoundingConstraint1 ( Key  key,
double  threshold,
bool  isGreaterThan,
double  mu = 1000.0 
)
inline

flag for greater/less than

Definition at line 41 of file BoundingConstraint.h.

template<class VALUE >
gtsam::BoundingConstraint1< VALUE >::~BoundingConstraint1 ( )
inlineoverride

Definition at line 47 of file BoundingConstraint.h.

Member Function Documentation

template<class VALUE >
bool gtsam::BoundingConstraint1< VALUE >::active ( const Values c) const
inlineoverridevirtual

active when constraint NOT met

Reimplemented from gtsam::NonlinearFactor.

Definition at line 61 of file BoundingConstraint.h.

template<class VALUE >
Vector gtsam::BoundingConstraint1< VALUE >::evaluateError ( const X x,
boost::optional< Matrix & >  H = boost::none 
) const
inlineoverridevirtual

Override this method to finish implementing a unary factor. If the optional Matrix reference argument is specified, it should compute both the function evaluation and its derivative in X.

Implements gtsam::NoiseModelFactor1< VALUE >.

Definition at line 67 of file BoundingConstraint.h.

template<class VALUE >
bool gtsam::BoundingConstraint1< VALUE >::isGreaterThan ( ) const
inline

Definition at line 50 of file BoundingConstraint.h.

template<class VALUE >
template<class ARCHIVE >
void gtsam::BoundingConstraint1< VALUE >::serialize ( ARCHIVE &  ar,
const unsigned  int 
)
inlineprivate

Definition at line 87 of file BoundingConstraint.h.

template<class VALUE >
double gtsam::BoundingConstraint1< VALUE >::threshold ( ) const
inline

Definition at line 49 of file BoundingConstraint.h.

template<class VALUE >
virtual double gtsam::BoundingConstraint1< VALUE >::value ( const X x,
boost::optional< Matrix & >  H = boost::none 
) const
pure virtual

function producing a scalar value to compare to the threshold Must have optional argument for derivative with 1xN matrix, where N = X::dim()

Implemented in simulated2D::inequality_constraints::ScalarCoordConstraint1< VALUE, IDX >.

Friends And Related Function Documentation

template<class VALUE >
friend class boost::serialization::access
friend

Serialization function

Definition at line 85 of file BoundingConstraint.h.

Member Data Documentation

template<class VALUE >
bool gtsam::BoundingConstraint1< VALUE >::isGreaterThan_

Definition at line 39 of file BoundingConstraint.h.

template<class VALUE >
double gtsam::BoundingConstraint1< VALUE >::threshold_

Definition at line 38 of file BoundingConstraint.h.


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


gtsam
Author(s):
autogenerated on Sat May 8 2021 02:58:04