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

#include <Lie.h>

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

Public Types

typedef lie_group_tag structure_category
 

Static Public Member Functions

Lie Group
static TangentVector Logmap (const Class &m, ChartJacobian Hm=boost::none)
 
static Class Expmap (const TangentVector &v, ChartJacobian Hv=boost::none)
 
static Class Compose (const Class &m1, const Class &m2, ChartJacobian H1=boost::none, ChartJacobian H2=boost::none)
 
static Class Between (const Class &m1, const Class &m2, ChartJacobian H1=boost::none, ChartJacobian H2=boost::none)
 
static Class Inverse (const Class &m, ChartJacobian H=boost::none)
 
- Static Public Member Functions inherited from gtsam::internal::GetDimensionImpl< Class, Class::dimension >
static int GetDimension (const Class &)
 

Group

typedef multiplicative_group_tag group_flavor
 
static Class Identity ()
 

Manifold

enum  { dimension = Class::dimension }
 
typedef Class ManifoldType
 
typedef Eigen::Matrix< double, dimension, 1 > TangentVector
 
typedef OptionalJacobian< dimension, dimensionChartJacobian
 
static TangentVector Local (const Class &origin, const Class &other, ChartJacobian Horigin=boost::none, ChartJacobian Hother=boost::none)
 
static Class Retract (const Class &origin, const TangentVector &v, ChartJacobian Horigin=boost::none, ChartJacobian Hv=boost::none)
 

Detailed Description

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

A helper class that implements the traits interface for GTSAM lie groups. To use this for your gtsam type, define: template<> struct traits<Class> : public internal::LieGroupTraits<Class> {}; Assumes existence of: identity, dimension, localCoordinates, retract, and additionally Logmap, Expmap, compose, between, and inverse

Definition at line 173 of file Lie.h.

Member Typedef Documentation

Definition at line 187 of file Lie.h.

Definition at line 178 of file Lie.h.

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

Definition at line 184 of file Lie.h.

Definition at line 174 of file Lie.h.

template<class Class>
typedef Eigen::Matrix<double, dimension, 1> gtsam::internal::LieGroupTraits< Class >::TangentVector

Definition at line 186 of file Lie.h.

Member Enumeration Documentation

template<class Class>
anonymous enum
Enumerator
dimension 

Definition at line 185 of file Lie.h.

Member Function Documentation

template<class Class>
static Class gtsam::internal::LieGroupTraits< Class >::Between ( const Class m1,
const Class m2,
ChartJacobian  H1 = boost::none,
ChartJacobian  H2 = boost::none 
)
inlinestatic

Definition at line 215 of file Lie.h.

template<class Class>
static Class gtsam::internal::LieGroupTraits< Class >::Compose ( const Class m1,
const Class m2,
ChartJacobian  H1 = boost::none,
ChartJacobian  H2 = boost::none 
)
inlinestatic

Definition at line 210 of file Lie.h.

template<class Class>
static Class gtsam::internal::LieGroupTraits< Class >::Expmap ( const TangentVector v,
ChartJacobian  Hv = boost::none 
)
inlinestatic

Definition at line 206 of file Lie.h.

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

Definition at line 179 of file Lie.h.

template<class Class>
static Class gtsam::internal::LieGroupTraits< Class >::Inverse ( const Class m,
ChartJacobian  H = boost::none 
)
inlinestatic

Definition at line 220 of file Lie.h.

template<class Class>
static TangentVector gtsam::internal::LieGroupTraits< Class >::Local ( const Class origin,
const Class other,
ChartJacobian  Horigin = boost::none,
ChartJacobian  Hother = boost::none 
)
inlinestatic

Definition at line 189 of file Lie.h.

template<class Class>
static TangentVector gtsam::internal::LieGroupTraits< Class >::Logmap ( const Class m,
ChartJacobian  Hm = boost::none 
)
inlinestatic

Definition at line 202 of file Lie.h.

template<class Class>
static Class gtsam::internal::LieGroupTraits< Class >::Retract ( const Class origin,
const TangentVector v,
ChartJacobian  Horigin = boost::none,
ChartJacobian  Hv = boost::none 
)
inlinestatic

Definition at line 194 of file Lie.h.


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


gtsam
Author(s):
autogenerated on Sat May 8 2021 02:58:37