Public Types | Public Member Functions | List of all members
gtsam::internal::VectorSpaceTraits< Class > Struct Template Reference

#include <VectorSpace.h>

Inheritance diagram for gtsam::internal::VectorSpaceTraits< Class >:
Inheritance graph
[legend]

Public Types

typedef vector_space_tag structure_category
 
- Public Types inherited from gtsam::internal::VectorSpaceImpl< Class, Class::dimension >
typedef Eigen::Matrix< double, N, 1 > TangentVector
 
typedef OptionalJacobian< N, NChartJacobian
 
typedef Eigen::Matrix< double, N, NJacobian
 

Public Member Functions

 GTSAM_CONCEPT_ASSERT (HasVectorSpacePrereqs< Class >)
 

Group

typedef additive_group_tag group_flavor
 
static Class Identity ()
 

Manifold

typedef Class ManifoldType
 
constexpr static auto dimension = Class::dimension
 

Additional Inherited Members

- Static Public Member Functions inherited from gtsam::internal::VectorSpaceImpl< Class, Class::dimension >
static TangentVector Logmap (const Class &m, ChartJacobian Hm={})
 
static Class Expmap (const TangentVector &v, ChartJacobian Hv={})
 
static Class Compose (const Class &v1, const Class &v2, ChartJacobian H1={}, ChartJacobian H2={})
 
static Class Between (const Class &v1, const Class &v2, ChartJacobian H1={}, ChartJacobian H2={})
 
static Class Inverse (const Class &v, ChartJacobian H={})
 
static int GetDimension (const Class &)
 
static TangentVector Local (const Class &origin, const Class &other, ChartJacobian H1={}, ChartJacobian H2={})
 
static Class Retract (const Class &origin, const TangentVector &v, ChartJacobian H1={}, ChartJacobian H2={})
 

Detailed Description

template<class Class>
struct gtsam::internal::VectorSpaceTraits< Class >

A helper that implements the traits interface for classes that define vector spaces To use this for your class, define: template<> struct traits<Class> : public VectorSpaceTraits<Class> {}; The class needs to support the requirements defined by HasVectorSpacePrereqs above

Definition at line 185 of file VectorSpace.h.

Member Typedef Documentation

◆ group_flavor

Definition at line 194 of file VectorSpace.h.

◆ ManifoldType

template<class Class >
typedef Class gtsam::internal::VectorSpaceTraits< Class >::ManifoldType

Definition at line 201 of file VectorSpace.h.

◆ structure_category

Definition at line 190 of file VectorSpace.h.

Member Function Documentation

◆ GTSAM_CONCEPT_ASSERT()

template<class Class >
gtsam::internal::VectorSpaceTraits< Class >::GTSAM_CONCEPT_ASSERT ( HasVectorSpacePrereqs< Class )

◆ Identity()

template<class Class >
static Class gtsam::internal::VectorSpaceTraits< Class >::Identity ( )
inlinestatic

Definition at line 195 of file VectorSpace.h.

Member Data Documentation

◆ dimension

template<class Class >
constexpr static auto gtsam::internal::VectorSpaceTraits< Class >::dimension = Class::dimension
inlinestaticconstexpr

Definition at line 200 of file VectorSpace.h.


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


gtsam
Author(s):
autogenerated on Sun Dec 22 2024 04:24:51