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

#include <Manifold.h>

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

Public Types

typedef Class ManifoldType
 
typedef manifold_tag structure_category
 
typedef Eigen::Matrix< double, dimension, 1 > TangentVector
 

Public Member Functions

 GTSAM_CONCEPT_ASSERT (HasManifoldPrereqs< Class >)
 

Static Public Member Functions

static TangentVector Local (const Class &origin, const Class &other)
 
static Class Retract (const Class &origin, const TangentVector &v)
 
- Static Public Member Functions inherited from gtsam::internal::GetDimensionImpl< Class, Class::dimension >
static int GetDimension (const Class &)
 

Static Public Attributes

constexpr static auto dimension = Class::dimension
 

Detailed Description

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

A helper that implements the traits interface for GTSAM manifolds. To use this for your class type, define: template<> struct traits<Class> : public internal::ManifoldTraits<Class> { };

Definition at line 92 of file Manifold.h.

Member Typedef Documentation

◆ ManifoldType

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

Definition at line 101 of file Manifold.h.

◆ structure_category

Definition at line 102 of file Manifold.h.

◆ TangentVector

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

Definition at line 103 of file Manifold.h.

Member Function Documentation

◆ GTSAM_CONCEPT_ASSERT()

template<class Class >
gtsam::internal::ManifoldTraits< Class >::GTSAM_CONCEPT_ASSERT ( HasManifoldPrereqs< Class )

◆ Local()

template<class Class >
static TangentVector gtsam::internal::ManifoldTraits< Class >::Local ( const Class origin,
const Class other 
)
inlinestatic

Definition at line 106 of file Manifold.h.

◆ Retract()

template<class Class >
static Class gtsam::internal::ManifoldTraits< Class >::Retract ( const Class origin,
const TangentVector v 
)
inlinestatic

Definition at line 111 of file Manifold.h.

Member Data Documentation

◆ dimension

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

Definition at line 98 of file Manifold.h.


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


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