Public Types | Public Member Functions | Private Member Functions | Private Attributes | List of all members
gtsam::BinaryMeasurement< T > Class Template Reference

#include <BinaryMeasurement.h>

Inheritance diagram for gtsam::BinaryMeasurement< T >:
Inheritance graph
[legend]

Public Types

using shared_ptr = typename boost::shared_ptr< BinaryMeasurement >
 
- 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

 BinaryMeasurement (Key key1, Key key2, const T &measured, const SharedNoiseModel &model=nullptr)
 
virtual ~BinaryMeasurement ()
 Destructor. More...
 
Standard Interface
Key key1 () const
 
Key key2 () const
 
const Tmeasured () const
 
const SharedNoiseModelnoiseModel () const
 
Testable
void print (const std::string &s, const KeyFormatter &keyFormatter=DefaultKeyFormatter) const override
 print More...
 
bool equals (const BinaryMeasurement &expected, double tol=1e-9) 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 Member Functions

 BOOST_CONCEPT_ASSERT ((IsTestable< T >))
 

Private Attributes

T measured_
 The measurement. More...
 
SharedNoiseModel noiseModel_
 Noise model. More...
 

Additional Inherited Members

- 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::Factor
KeyVector keys_
 The keys involved in this factor. More...
 

Detailed Description

template<class T>
class gtsam::BinaryMeasurement< T >

Definition at line 36 of file BinaryMeasurement.h.

Member Typedef Documentation

template<class T>
using gtsam::BinaryMeasurement< T >::shared_ptr = typename boost::shared_ptr<BinaryMeasurement>

Definition at line 42 of file BinaryMeasurement.h.

Constructor & Destructor Documentation

template<class T>
gtsam::BinaryMeasurement< T >::BinaryMeasurement ( Key  key1,
Key  key2,
const T measured,
const SharedNoiseModel model = nullptr 
)
inline

Definition at line 49 of file BinaryMeasurement.h.

template<class T>
virtual gtsam::BinaryMeasurement< T >::~BinaryMeasurement ( )
inlinevirtual

Destructor.

Definition at line 56 of file BinaryMeasurement.h.

Member Function Documentation

template<class T>
gtsam::BinaryMeasurement< T >::BOOST_CONCEPT_ASSERT ( (IsTestable< T >)  )
private
template<class T>
bool gtsam::BinaryMeasurement< T >::equals ( const BinaryMeasurement< T > &  expected,
double  tol = 1e-9 
) const
inline

Definition at line 78 of file BinaryMeasurement.h.

template<class T>
Key gtsam::BinaryMeasurement< T >::key1 ( ) const
inline

Definition at line 61 of file BinaryMeasurement.h.

template<class T>
Key gtsam::BinaryMeasurement< T >::key2 ( ) const
inline

Definition at line 62 of file BinaryMeasurement.h.

template<class T>
const T& gtsam::BinaryMeasurement< T >::measured ( ) const
inline

Definition at line 63 of file BinaryMeasurement.h.

template<class T>
const SharedNoiseModel& gtsam::BinaryMeasurement< T >::noiseModel ( ) const
inline

Definition at line 64 of file BinaryMeasurement.h.

template<class T>
void gtsam::BinaryMeasurement< T >::print ( const std::string &  s,
const KeyFormatter formatter = DefaultKeyFormatter 
) const
inlineoverridevirtual

print

Reimplemented from gtsam::Factor.

Definition at line 70 of file BinaryMeasurement.h.

Member Data Documentation

template<class T>
T gtsam::BinaryMeasurement< T >::measured_
private

The measurement.

Definition at line 45 of file BinaryMeasurement.h.

template<class T>
SharedNoiseModel gtsam::BinaryMeasurement< T >::noiseModel_
private

Noise model.

Definition at line 46 of file BinaryMeasurement.h.


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


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