Public Member Functions | List of all members
gtsam::Value Class Referenceabstract

#include <Value.h>

Inheritance diagram for gtsam::Value:
Inheritance graph
[legend]

Public Member Functions

template<typename ValueType >
const ValueType & cast () const
 
virtual std::shared_ptr< Valueclone () const =0
 
virtual Valueclone_ () const =0
 
virtual void deallocate_ () const =0
 
virtual size_t dim () const =0
 
virtual bool equals_ (const Value &other, double tol=1e-9) const =0
 
virtual Vector localCoordinates_ (const Value &value) const =0
 
virtual Valueoperator= (const Value &)
 
virtual void print (const std::string &str="") const =0
 
virtual Valueretract_ (const Vector &delta) const =0
 
virtual ~Value ()
 

Detailed Description

This is the base class for any type to be stored in Values. Note: As of GTSAM 4.0, Value types should no longer derive from Value or DerivedValue. Use type traits instead. See https://bitbucket.org/gtborg/gtsam/wiki/Migrating%20from%20GTSAM%203.X%20to%20GTSAM%204.0#markdown-header-custom-value-types for current usage and migration details.

Definition at line 39 of file Value.h.

Constructor & Destructor Documentation

◆ ~Value()

virtual gtsam::Value::~Value ( )
inlinevirtual

Virutal destructor

Definition at line 91 of file Value.h.

Member Function Documentation

◆ cast()

template<typename ValueType >
const ValueType & gtsam::Value::cast ( ) const

Cast to known ValueType

Definition at line 204 of file GenericValue.h.

◆ clone()

virtual std::shared_ptr<Value> gtsam::Value::clone ( ) const
pure virtual

Clone this value (normal clone on the heap, delete with 'delete' operator)

Implemented in gtsam::GenericValue< T >.

◆ clone_()

virtual Value* gtsam::Value::clone_ ( ) const
pure virtual

Clone this value in a special memory pool, must be deleted with Value::deallocate_, not with the 'delete' operator.

Implemented in gtsam::GenericValue< T >.

◆ deallocate_()

virtual void gtsam::Value::deallocate_ ( ) const
pure virtual

Deallocate a raw pointer of this value

Implemented in gtsam::GenericValue< T >.

◆ dim()

virtual size_t gtsam::Value::dim ( ) const
pure virtual

Return the dimensionality of the tangent space of this value. This is the dimensionality of delta passed into retract() and of the vector returned by localCoordinates().

Returns
The dimensionality of the tangent space

Implemented in gtsam::GenericValue< T >.

◆ equals_()

virtual bool gtsam::Value::equals_ ( const Value other,
double  tol = 1e-9 
) const
pure virtual

Compare this Value with another for equality.

Implemented in gtsam::GenericValue< T >.

◆ localCoordinates_()

virtual Vector gtsam::Value::localCoordinates_ ( const Value value) const
pure virtual

Compute the coordinates in the tangent space of this value that retract() would map to value.

Parameters
valueThe value whose coordinates should be determined in the tangent space of the value on which this function is called.
Returns
The coordinates of value in the tangent space of this.

Implemented in gtsam::GenericValue< T >.

◆ operator=()

virtual Value& gtsam::Value::operator= ( const Value )
inlinevirtual

Assignment operator

Reimplemented in gtsam::GenericValue< T >.

Definition at line 81 of file Value.h.

◆ print()

virtual void gtsam::Value::print ( const std::string &  str = "") const
pure virtual

Print this value, for debugging and unit tests

Implemented in gtsam::GenericValue< T >.

◆ retract_()

virtual Value* gtsam::Value::retract_ ( const Vector delta) const
pure virtual

Increment the value, by mapping from the vector delta in the tangent space of the current value back to the manifold to produce a new, incremented value.

Parameters
deltaThe delta vector in the tangent space of this value, by which to increment this value.

Implemented in gtsam::GenericValue< T >.


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


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