Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Private Member Functions | Friends | List of all members
gtsam::VelocityConstraint3 Class Reference

#include <VelocityConstraint3.h>

Inheritance diagram for gtsam::VelocityConstraint3:
Inheritance graph
[legend]

Public Types

typedef boost::shared_ptr< VelocityConstraint3shared_ptr
 
- Public Types inherited from gtsam::NoiseModelFactor3< double, double, double >
typedef double X1
 
typedef double X2
 
typedef double X3
 
- 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

gtsam::NonlinearFactor::shared_ptr clone () const override
 
Vector evaluateError (const double &x1, const double &x2, const double &v, boost::optional< Matrix & > H1=boost::none, boost::optional< Matrix & > H2=boost::none, boost::optional< Matrix & > H3=boost::none) const override
 
 VelocityConstraint3 (Key key1, Key key2, Key velKey, double dt, double mu=1000.0)
 TODO: comment. More...
 
 ~VelocityConstraint3 () override
 
- Public Member Functions inherited from gtsam::NoiseModelFactor3< double, double, double >
Key key1 () const
 
Key key2 () const
 
Key key3 () const
 
 NoiseModelFactor3 ()
 
 NoiseModelFactor3 (const SharedNoiseModel &noiseModel, Key j1, Key j2, Key j3)
 
Vector unwhitenedError (const Values &x, boost::optional< std::vector< Matrix > & > H=boost::none) const override
 
 ~NoiseModelFactor3 () 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 bool active (const Values &) 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...
 
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
 
virtual void printKeys (const std::string &s="Factor", const KeyFormatter &formatter=DefaultKeyFormatter) const
 print only keys More...
 
KeyVectorkeys ()
 
iterator begin ()
 
iterator end ()
 

Protected Types

typedef NoiseModelFactor3< double, double, double > Base
 
- Protected Types inherited from gtsam::NoiseModelFactor3< double, double, double >
typedef NoiseModelFactor Base
 
typedef NoiseModelFactor3< double, double, double > 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

 VelocityConstraint3 ()
 
- 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...
 

Protected Attributes

double dt_
 
- Protected Attributes inherited from gtsam::NoiseModelFactor
SharedNoiseModel noiseModel_
 
- Protected Attributes inherited from gtsam::Factor
KeyVector keys_
 The keys involved in this factor. More...
 

Private Member Functions

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

Friends

class boost::serialization::access
 

Additional Inherited Members

- 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

Definition at line 13 of file VelocityConstraint3.h.

Member Typedef Documentation

typedef NoiseModelFactor3<double, double, double> gtsam::VelocityConstraint3::Base
protected

Definition at line 17 of file VelocityConstraint3.h.

Definition at line 26 of file VelocityConstraint3.h.

Constructor & Destructor Documentation

gtsam::VelocityConstraint3::VelocityConstraint3 ( )
inlineprotected

default constructor to allow for serialization

Definition at line 20 of file VelocityConstraint3.h.

gtsam::VelocityConstraint3::VelocityConstraint3 ( Key  key1,
Key  key2,
Key  velKey,
double  dt,
double  mu = 1000.0 
)
inline

TODO: comment.

Definition at line 29 of file VelocityConstraint3.h.

gtsam::VelocityConstraint3::~VelocityConstraint3 ( )
inlineoverride

Definition at line 31 of file VelocityConstraint3.h.

Member Function Documentation

gtsam::NonlinearFactor::shared_ptr gtsam::VelocityConstraint3::clone ( ) const
inlineoverridevirtual
Returns
a deep copy of this factor

Reimplemented from gtsam::NonlinearFactor.

Definition at line 34 of file VelocityConstraint3.h.

Vector gtsam::VelocityConstraint3::evaluateError ( const double &  x1,
const double &  x2,
const double &  v,
boost::optional< Matrix & >  H1 = boost::none,
boost::optional< Matrix & >  H2 = boost::none,
boost::optional< Matrix & >  H3 = boost::none 
) const
inlineoverridevirtual

x1 + v*dt - x2 = 0, with optional derivatives

Implements gtsam::NoiseModelFactor3< double, double, double >.

Definition at line 39 of file VelocityConstraint3.h.

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

Definition at line 55 of file VelocityConstraint3.h.

Friends And Related Function Documentation

friend class boost::serialization::access
friend

Serialization function

Definition at line 53 of file VelocityConstraint3.h.

Member Data Documentation

double gtsam::VelocityConstraint3::dt_
protected

Definition at line 22 of file VelocityConstraint3.h.


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


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