Public Types | Public Member Functions | Private Attributes | List of all members
UnaryFactor Class Reference
Inheritance diagram for UnaryFactor:
Inheritance graph
[legend]

Public Types

typedef boost::shared_ptr< UnaryFactorshared_ptr
 shorthand for a smart pointer to a factor More...
 
- Public Types inherited from gtsam::NoiseModelFactor1< Pose2 >
typedef Pose2 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

gtsam::NonlinearFactor::shared_ptr clone () const override
 
Vector evaluateError (const Pose2 &q, boost::optional< Matrix & > H=boost::none) const
 
Vector evaluateError (const Pose2 &q, boost::optional< Matrix & > H=boost::none) const override
 
 UnaryFactor (Key j, double x, double y, const SharedNoiseModel &model)
 
 UnaryFactor (Key j, double x, double y, const SharedNoiseModel &model)
 
 ~UnaryFactor () override
 
- Public Member Functions inherited from gtsam::NoiseModelFactor1< Pose2 >
 NoiseModelFactor1 ()
 
 NoiseModelFactor1 (const SharedNoiseModel &noiseModel, Key key1)
 
 ~NoiseModelFactor1 () override
 
Key key () const
 
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 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...
 
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
 

Private Attributes

double mx_
 
double my_
 X and Y measurements. More...
 

Additional Inherited Members

- Protected Types inherited from gtsam::NoiseModelFactor1< Pose2 >
typedef NoiseModelFactor Base
 
typedef NoiseModelFactor1< Pose2This
 
- 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

Definition at line 1 of file LocalizationFactor.cpp.

Member Typedef Documentation

typedef boost::shared_ptr<UnaryFactor> UnaryFactor::shared_ptr

shorthand for a smart pointer to a factor

Definition at line 75 of file LocalizationExample.cpp.

Constructor & Destructor Documentation

UnaryFactor::UnaryFactor ( Key  j,
double  x,
double  y,
const SharedNoiseModel &  model 
)
inline

Definition at line 5 of file LocalizationFactor.cpp.

UnaryFactor::UnaryFactor ( Key  j,
double  x,
double  y,
const SharedNoiseModel model 
)
inline

Definition at line 78 of file LocalizationExample.cpp.

UnaryFactor::~UnaryFactor ( )
inlineoverride

Definition at line 81 of file LocalizationExample.cpp.

Member Function Documentation

gtsam::NonlinearFactor::shared_ptr UnaryFactor::clone ( ) const
inlineoverridevirtual

Creates a shared_ptr clone of the factor - needs to be specialized to allow for subclasses

By default, throws exception if subclass does not implement the function.

Reimplemented from gtsam::NonlinearFactor.

Definition at line 103 of file LocalizationExample.cpp.

Vector UnaryFactor::evaluateError ( const Pose2 &  q,
boost::optional< Matrix & >  H = boost::none 
) const
inline

Definition at line 8 of file LocalizationFactor.cpp.

Vector UnaryFactor::evaluateError ( const Pose2 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< Pose2 >.

Definition at line 87 of file LocalizationExample.cpp.

Member Data Documentation

double UnaryFactor::mx_
private

Definition at line 2 of file LocalizationFactor.cpp.

double UnaryFactor::my_
private

X and Y measurements.

Definition at line 2 of file LocalizationFactor.cpp.


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


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