Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
vertigo::SwitchVariableSigmoid Struct Reference

#include <switchVariableSigmoid.h>

Inheritance diagram for vertigo::SwitchVariableSigmoid:
Inheritance graph
[legend]

Public Member Functions

SwitchVariableSigmoid between (const SwitchVariableSigmoid &l2, boost::optional< gtsam::Matrix & > H1=boost::none, boost::optional< gtsam::Matrix & > H2=boost::none) const
 
SwitchVariableSigmoid compose (const SwitchVariableSigmoid &p) const
 
size_t dim () const
 
bool equals (const SwitchVariableSigmoid &expected, double tol=1e-5) const
 
SwitchVariableSigmoid inverse () const
 
gtsam::Vector localCoordinates (const SwitchVariableSigmoid &t2) const
 
void print (const std::string &name="") const
 
SwitchVariableSigmoid retract (const gtsam::Vector &v) const
 
 SwitchVariableSigmoid ()
 
 SwitchVariableSigmoid (double d)
 
double value () const
 
- Public Member Functions inherited from rtabmap::DerivedValue< SwitchVariableSigmoid >
virtual boost::shared_ptr< gtsam::Valueclone () const
 
virtual gtsam::Valueclone_ () const
 
virtual void deallocate_ () const
 
virtual bool equals_ (const gtsam::Value &p, double tol=1e-9) const
 equals implementing generic Value interface More...
 
virtual gtsam::Vector localCoordinates_ (const gtsam::Value &value2) const
 Generic Value interface version of localCoordinates. More...
 
 operator const SwitchVariableSigmoid & () const
 Conversion to the derived class. More...
 
 operator SwitchVariableSigmoid & ()
 Conversion to the derived class. More...
 
virtual gtsam::Valueoperator= (const gtsam::Value &rhs)
 Assignment operator. More...
 
virtual gtsam::Valueretract_ (const gtsam::Vector &delta) const
 Generic Value interface version of retract. More...
 
virtual ~DerivedValue ()
 
- Public Member Functions inherited from gtsam::Value
const ValueType & cast () const
 
virtual std::shared_ptr< Valueclone () const=0
 
virtual Valueclone_ () const=0
 
virtual void deallocate_ () const=0
 
virtual ~Value ()
 

Static Public Member Functions

static size_t Dim ()
 
static SwitchVariableSigmoid Expmap (const gtsam::Vector &v)
 
static SwitchVariableSigmoid identity ()
 
static gtsam::Vector Logmap (const SwitchVariableSigmoid &p)
 

Private Attributes

double d_
 

Additional Inherited Members

- Protected Member Functions inherited from rtabmap::DerivedValue< SwitchVariableSigmoid >
 DerivedValue ()
 
DerivedValue< SwitchVariableSigmoid > & operator= (const DerivedValue< SwitchVariableSigmoid > &)
 

Detailed Description

SwitchVariableSigmoid is a wrapper around double to allow it to be a Lie type

Definition at line 22 of file switchVariableSigmoid.h.

Constructor & Destructor Documentation

◆ SwitchVariableSigmoid() [1/2]

vertigo::SwitchVariableSigmoid::SwitchVariableSigmoid ( )
inline

default constructor

Definition at line 25 of file switchVariableSigmoid.h.

◆ SwitchVariableSigmoid() [2/2]

vertigo::SwitchVariableSigmoid::SwitchVariableSigmoid ( double  d)
inline

wrap a double

Definition at line 28 of file switchVariableSigmoid.h.

Member Function Documentation

◆ between()

SwitchVariableSigmoid vertigo::SwitchVariableSigmoid::between ( const SwitchVariableSigmoid l2,
boost::optional< gtsam::Matrix & >  H1 = boost::none,
boost::optional< gtsam::Matrix & >  H2 = boost::none 
) const
inline

between operation

Definition at line 78 of file switchVariableSigmoid.h.

◆ compose()

SwitchVariableSigmoid vertigo::SwitchVariableSigmoid::compose ( const SwitchVariableSigmoid p) const
inline

compose with another object

Definition at line 73 of file switchVariableSigmoid.h.

◆ Dim()

static size_t vertigo::SwitchVariableSigmoid::Dim ( )
inlinestatic

Definition at line 50 of file switchVariableSigmoid.h.

◆ dim()

size_t vertigo::SwitchVariableSigmoid::dim ( ) const
inlinevirtual

Returns dimensionality of the tangent space

Implements gtsam::Value.

Definition at line 49 of file switchVariableSigmoid.h.

◆ equals()

bool vertigo::SwitchVariableSigmoid::equals ( const SwitchVariableSigmoid expected,
double  tol = 1e-5 
) const
inline

equality up to tolerance

Definition at line 42 of file switchVariableSigmoid.h.

◆ Expmap()

static SwitchVariableSigmoid vertigo::SwitchVariableSigmoid::Expmap ( const gtsam::Vector v)
inlinestatic

Expmap around identity

Definition at line 99 of file switchVariableSigmoid.h.

◆ identity()

static SwitchVariableSigmoid vertigo::SwitchVariableSigmoid::identity ( )
inlinestatic

identity

Definition at line 68 of file switchVariableSigmoid.h.

◆ inverse()

SwitchVariableSigmoid vertigo::SwitchVariableSigmoid::inverse ( ) const
inline

invert the object and yield a new one

Definition at line 92 of file switchVariableSigmoid.h.

◆ localCoordinates()

gtsam::Vector vertigo::SwitchVariableSigmoid::localCoordinates ( const SwitchVariableSigmoid t2) const
inline
Returns
the local coordinates of another object

Definition at line 63 of file switchVariableSigmoid.h.

◆ Logmap()

static gtsam::Vector vertigo::SwitchVariableSigmoid::Logmap ( const SwitchVariableSigmoid p)
inlinestatic

Logmap around identity - just returns with default cast back

Definition at line 102 of file switchVariableSigmoid.h.

◆ print()

void vertigo::SwitchVariableSigmoid::print ( const std::string name = "") const
inlinevirtual

print

Parameters
soptional string naming the object

Implements gtsam::Value.

Definition at line 37 of file switchVariableSigmoid.h.

◆ retract()

SwitchVariableSigmoid vertigo::SwitchVariableSigmoid::retract ( const gtsam::Vector v) const
inline

Update the SwitchVariableSigmoid with a tangent space update

Definition at line 53 of file switchVariableSigmoid.h.

◆ value()

double vertigo::SwitchVariableSigmoid::value ( ) const
inline

access the underlying value

Definition at line 34 of file switchVariableSigmoid.h.

Member Data Documentation

◆ d_

double vertigo::SwitchVariableSigmoid::d_
private

Definition at line 105 of file switchVariableSigmoid.h.


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


rtabmap
Author(s): Mathieu Labbe
autogenerated on Thu Jul 25 2024 02:50:29