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 std::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)
 
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...
 
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 KeyVectorkeys () const
 Access the factor's involved variable keys. More...
 
const_iterator begin () const
 
const_iterator end () const
 
virtual double error (const HybridValues &c) 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...
 
KeyVectorkeys ()
 
iterator begin ()
 
iterator end ()
 

Private Member Functions

 GTSAM_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)
 
- 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

◆ shared_ptr

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

Definition at line 42 of file BinaryMeasurement.h.

Constructor & Destructor Documentation

◆ BinaryMeasurement()

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.

Member Function Documentation

◆ equals()

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

Definition at line 75 of file BinaryMeasurement.h.

◆ GTSAM_CONCEPT_ASSERT()

template<class T >
gtsam::BinaryMeasurement< T >::GTSAM_CONCEPT_ASSERT ( IsTestable< T )
private

◆ key1()

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

Definition at line 58 of file BinaryMeasurement.h.

◆ key2()

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

Definition at line 59 of file BinaryMeasurement.h.

◆ measured()

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

Definition at line 60 of file BinaryMeasurement.h.

◆ noiseModel()

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

Definition at line 61 of file BinaryMeasurement.h.

◆ print()

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 67 of file BinaryMeasurement.h.

Member Data Documentation

◆ measured_

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

The measurement.

Definition at line 45 of file BinaryMeasurement.h.

◆ noiseModel_

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 Fri Nov 1 2024 03:51:01