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

#include <PriorFactor.h>

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

Public Types

typedef std::shared_ptr< PriorFactor< VALUE > > shared_ptr
 shorthand for a smart pointer to a factor More...
 
typedef VALUE T
 
typedef PriorFactor< VALUE > This
 Typedef to this class. More...
 
- Public Types inherited from gtsam::NoiseModelFactorN< VALUE >
enum  
 N is the number of variables (N-way factor) More...
 
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

gtsam::NonlinearFactor::shared_ptr clone () const override
 
bool equals (const NonlinearFactor &expected, double tol=1e-9) const override
 
Vector evaluateError (const T &x, OptionalMatrixType H) const override
 
void print (const std::string &s, const KeyFormatter &keyFormatter=DefaultKeyFormatter) const override
 
const VALUE & prior () const
 
 PriorFactor ()
 
 PriorFactor (Key key, const VALUE &prior, const SharedNoiseModel &model=nullptr)
 
 PriorFactor (Key key, const VALUE &prior, const Matrix &covariance)
 
 ~PriorFactor () override
 
- Public Member Functions inherited from gtsam::NoiseModelFactorN< VALUE >
Key key () 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 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

enum  { NeedsToAlign = (sizeof(T) % 16) == 0 }
 
typedef NoiseModelFactorN< VALUE > Base
 

Private Attributes

VALUE prior_
 

Additional Inherited Members

- Protected Types inherited from gtsam::NoiseModelFactorN< 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::PriorFactor< VALUE >

A class for a soft prior on any Value type

Definition at line 30 of file nonlinear/PriorFactor.h.

Member Typedef Documentation

◆ Base

template<class VALUE>
typedef NoiseModelFactorN<VALUE> gtsam::PriorFactor< VALUE >::Base
private

Definition at line 41 of file nonlinear/PriorFactor.h.

◆ shared_ptr

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

shorthand for a smart pointer to a factor

The measurement concept check by type

Definition at line 51 of file nonlinear/PriorFactor.h.

◆ T

template<class VALUE>
typedef VALUE gtsam::PriorFactor< VALUE >::T

Definition at line 33 of file nonlinear/PriorFactor.h.

◆ This

template<class VALUE>
typedef PriorFactor<VALUE> gtsam::PriorFactor< VALUE >::This

Typedef to this class.

Definition at line 54 of file nonlinear/PriorFactor.h.

Member Enumeration Documentation

◆ anonymous enum

template<class VALUE>
anonymous enum
private
Enumerator
NeedsToAlign 

Definition at line 121 of file nonlinear/PriorFactor.h.

Constructor & Destructor Documentation

◆ PriorFactor() [1/3]

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

default constructor - only use for serialization

Definition at line 57 of file nonlinear/PriorFactor.h.

◆ ~PriorFactor()

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

Definition at line 59 of file nonlinear/PriorFactor.h.

◆ PriorFactor() [2/3]

template<class VALUE>
gtsam::PriorFactor< VALUE >::PriorFactor ( Key  key,
const VALUE &  prior,
const SharedNoiseModel model = nullptr 
)
inline

Constructor

Definition at line 62 of file nonlinear/PriorFactor.h.

◆ PriorFactor() [3/3]

template<class VALUE>
gtsam::PriorFactor< VALUE >::PriorFactor ( Key  key,
const VALUE &  prior,
const Matrix covariance 
)
inline

Convenience constructor that takes a full covariance argument

Definition at line 67 of file nonlinear/PriorFactor.h.

Member Function Documentation

◆ clone()

template<class VALUE>
gtsam::NonlinearFactor::shared_ptr gtsam::PriorFactor< VALUE >::clone ( ) const
inlineoverridevirtual
Returns
a deep copy of this factor

Reimplemented from gtsam::NonlinearFactor.

Definition at line 72 of file nonlinear/PriorFactor.h.

◆ equals()

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

equals

Reimplemented from gtsam::NoiseModelFactor.

Definition at line 90 of file nonlinear/PriorFactor.h.

◆ evaluateError()

template<class VALUE>
Vector gtsam::PriorFactor< VALUE >::evaluateError ( const T x,
OptionalMatrixType  H 
) const
inlineoverride

implement functions needed to derive from Factor vector of errors

Definition at line 98 of file nonlinear/PriorFactor.h.

◆ print()

template<class VALUE>
void gtsam::PriorFactor< 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 79 of file nonlinear/PriorFactor.h.

◆ prior()

template<class VALUE>
const VALUE& gtsam::PriorFactor< VALUE >::prior ( ) const
inline

Definition at line 104 of file nonlinear/PriorFactor.h.

Member Data Documentation

◆ prior_

template<class VALUE>
VALUE gtsam::PriorFactor< VALUE >::prior_
private

Definition at line 43 of file nonlinear/PriorFactor.h.


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


gtsam
Author(s):
autogenerated on Tue Jul 4 2023 02:47:07