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

#include <GaussMarkov1stOrderFactor.h>

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

Public Types

typedef std::shared_ptr< GaussMarkov1stOrderFactorshared_ptr
 
- Public Types inherited from gtsam::NoiseModelFactorN< VALUE, VALUE >
using ValueType = typename std::tuple_element< I - 1, std::tuple< ValueTypes... > >::type
 
- Public Types inherited from gtsam::NoiseModelFactor
typedef std::shared_ptr< Thisshared_ptr
 
- Public Types inherited from gtsam::NonlinearFactor
typedef std::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 equals (const NonlinearFactor &expected, double tol=1e-9) const override
 
Vector evaluateError (const VALUE &p1, const VALUE &p2, OptionalMatrixType H1, OptionalMatrixType H2) const override
 
 GaussMarkov1stOrderFactor ()
 
 GaussMarkov1stOrderFactor (const Key &key1, const Key &key2, double delta_t, Vector tau, const SharedGaussian &model)
 
void print (const std::string &s, const KeyFormatter &keyFormatter=DefaultKeyFormatter) const override
 
 ~GaussMarkov1stOrderFactor () override
 
- Public Member Functions inherited from gtsam::NoiseModelFactorN< VALUE, VALUE >
Key key () const
 
virtual Vector unwhitenedError (const Values &x, OptionalMatrixVecType H=nullptr) const =0
 
Vector unwhitenedError (const Values &x, std::vector< Matrix > &H) const
 
 ~NoiseModelFactorN () override
 
 NoiseModelFactorN ()
 Default Constructor for I/O. More...
 
 NoiseModelFactorN (const SharedNoiseModel &noiseModel, KeyType< ValueTypes >... keys)
 
 NoiseModelFactorN (const SharedNoiseModel &noiseModel, CONTAINER keys)
 
Vector unwhitenedError (const Values &x, OptionalMatrixVecType H=nullptr) const override
 
virtual Vector evaluateError (const ValueTypes &... x, OptionalMatrixTypeT< ValueTypes >... H) const=0
 
Vector evaluateError (const ValueTypes &... x, MatrixTypeT< ValueTypes > &... H) const
 
Vector evaluateError (const ValueTypes &... x) const
 
AreAllMatrixRefs< Vector, OptionalJacArgs... > evaluateError (const ValueTypes &... x, OptionalJacArgs &&... H) const
 
AreAllMatrixPtrs< Vector, OptionalJacArgs... > evaluateError (const ValueTypes &... x, OptionalJacArgs &&... H) const
 
Key key1 () const
 
Key key2 () const
 
Key key3 () const
 
Key key4 () const
 
Key key5 () const
 
Key key6 () const
 
- Public Member Functions inherited from gtsam::NoiseModelFactor
shared_ptr cloneWithNewNoiseModel (const SharedNoiseModel newNoise) const
 
size_t dim () const override
 
double error (const Values &c) const override
 
std::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)
 
Vector unweightedWhitenedError (const Values &c) const
 
Vector unwhitenedError (const Values &x, std::vector< Matrix > &H) 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)
 
double error (const HybridValues &c) const override
 
virtual bool active (const Values &) const
 
virtual shared_ptr clone () const
 
virtual shared_ptr rekey (const std::map< Key, Key > &rekey_mapping) const
 
virtual shared_ptr rekey (const KeyVector &new_keys) const
 
virtual bool sendable () 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
 
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 Types

typedef NoiseModelFactorN< VALUE, VALUE > Base
 
typedef GaussMarkov1stOrderFactor< VALUE > This
 

Private Member Functions

SharedGaussian calcDiscreteNoiseModel (const SharedGaussian &model, double delta_t)
 

Private Attributes

double dt_
 
Vector tau_
 

Additional Inherited Members

- Static Public Attributes inherited from gtsam::NoiseModelFactorN< VALUE, VALUE >
constexpr static auto N
 N is the number of variables (N-way factor) More...
 
- Protected Types inherited from gtsam::NoiseModelFactorN< VALUE, VALUE >
using Base = NoiseModelFactor
 
using KeyType = Key
 
using MatrixTypeT = Matrix
 
using OptionalMatrixTypeT = Matrix *
 
using This = NoiseModelFactorN< ValueTypes... >
 
using IsConvertible = typename std::enable_if< std::is_convertible< From, To >::value, void >::type
 
using IndexIsValid = typename std::enable_if<(I >=1) &&(I<=N), void >::type
 
using ContainerElementType = typename std::decay< decltype(*std::declval< Container >().begin())>::type
 
using IsContainerOfKeys = IsConvertible< ContainerElementType< Container >, Key >
 
using AreAllMatrixRefs = std::enable_if_t<(... &&std::is_convertible< Args, Matrix & >::value), Ret >
 
using IsMatrixPointer = std::is_same< typename std::decay_t< Arg >, Matrix * >
 
using IsNullpointer = std::is_same< typename std::decay_t< Arg >, std::nullptr_t >
 
using AreAllMatrixPtrs = std::enable_if_t<(... &&(IsMatrixPointer< Args >::value||IsNullpointer< Args >::value)), Ret >
 
- 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)
 
- 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>
class gtsam::GaussMarkov1stOrderFactor< VALUE >

Definition at line 45 of file GaussMarkov1stOrderFactor.h.

Member Typedef Documentation

◆ Base

template<class VALUE >
typedef NoiseModelFactorN<VALUE, VALUE> gtsam::GaussMarkov1stOrderFactor< VALUE >::Base
private

Definition at line 50 of file GaussMarkov1stOrderFactor.h.

◆ shared_ptr

template<class VALUE >
typedef std::shared_ptr<GaussMarkov1stOrderFactor> gtsam::GaussMarkov1stOrderFactor< VALUE >::shared_ptr

Definition at line 61 of file GaussMarkov1stOrderFactor.h.

◆ This

template<class VALUE >
typedef GaussMarkov1stOrderFactor<VALUE> gtsam::GaussMarkov1stOrderFactor< VALUE >::This
private

Definition at line 49 of file GaussMarkov1stOrderFactor.h.

Constructor & Destructor Documentation

◆ GaussMarkov1stOrderFactor() [1/2]

template<class VALUE >
gtsam::GaussMarkov1stOrderFactor< VALUE >::GaussMarkov1stOrderFactor ( )
inline

default constructor - only use for serialization

Definition at line 64 of file GaussMarkov1stOrderFactor.h.

◆ GaussMarkov1stOrderFactor() [2/2]

template<class VALUE >
gtsam::GaussMarkov1stOrderFactor< VALUE >::GaussMarkov1stOrderFactor ( const Key key1,
const Key key2,
double  delta_t,
Vector  tau,
const SharedGaussian model 
)
inline

Constructor

Definition at line 67 of file GaussMarkov1stOrderFactor.h.

◆ ~GaussMarkov1stOrderFactor()

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

Definition at line 72 of file GaussMarkov1stOrderFactor.h.

Member Function Documentation

◆ calcDiscreteNoiseModel()

template<class VALUE >
SharedGaussian gtsam::GaussMarkov1stOrderFactor< VALUE >::calcDiscreteNoiseModel ( const SharedGaussian model,
double  delta_t 
)
inlineprivate

Definition at line 127 of file GaussMarkov1stOrderFactor.h.

◆ equals()

template<class VALUE >
bool gtsam::GaussMarkov1stOrderFactor< VALUE >::equals ( const NonlinearFactor expected,
double  tol = 1e-9 
) const
inlineoverridevirtual

equals

Reimplemented from gtsam::NoiseModelFactor.

Definition at line 85 of file GaussMarkov1stOrderFactor.h.

◆ evaluateError()

template<class VALUE >
Vector gtsam::GaussMarkov1stOrderFactor< VALUE >::evaluateError ( const VALUE &  p1,
const VALUE &  p2,
OptionalMatrixType  H1,
OptionalMatrixType  H2 
) const
inlineoverride

implement functions needed to derive from Factor vector of errors

Definition at line 93 of file GaussMarkov1stOrderFactor.h.

◆ print()

template<class VALUE >
void gtsam::GaussMarkov1stOrderFactor< VALUE >::print ( const std::string &  s,
const KeyFormatter keyFormatter = DefaultKeyFormatter 
) const
inlineoverridevirtual

implement functions needed for Testable print

Reimplemented from gtsam::NoiseModelFactor.

Definition at line 77 of file GaussMarkov1stOrderFactor.h.

Member Data Documentation

◆ dt_

template<class VALUE >
double gtsam::GaussMarkov1stOrderFactor< VALUE >::dt_
private

Definition at line 52 of file GaussMarkov1stOrderFactor.h.

◆ tau_

template<class VALUE >
Vector gtsam::GaussMarkov1stOrderFactor< VALUE >::tau_
private

Definition at line 53 of file GaussMarkov1stOrderFactor.h.


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


gtsam
Author(s):
autogenerated on Sun Dec 22 2024 04:23:53