vertigo::SwitchVariableSigmoid Struct Reference

#include <switchVariableSigmoid.h>

List of all members.

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
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_

---

Detailed Description

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

Definition at line 21 of file switchVariableSigmoid.h.

---

Constructor & Destructor Documentation

vertigo::SwitchVariableSigmoid::SwitchVariableSigmoid

(

)

[inline]

default constructor

Definition at line 24 of file switchVariableSigmoid.h.

vertigo::SwitchVariableSigmoid::SwitchVariableSigmoid

(

double

d

)

[inline]

wrap a double

Definition at line 27 of file switchVariableSigmoid.h.

---

Member Function Documentation

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 77 of file switchVariableSigmoid.h.

SwitchVariableSigmoid vertigo::SwitchVariableSigmoid::compose

(

const SwitchVariableSigmoid &

p

)

const [inline]

compose with another object

Definition at line 72 of file switchVariableSigmoid.h.

size_t vertigo::SwitchVariableSigmoid::dim

(

)

const [inline]

Returns dimensionality of the tangent space

Definition at line 48 of file switchVariableSigmoid.h.

static size_t vertigo::SwitchVariableSigmoid::Dim

(

)

[inline, static]

Definition at line 49 of file switchVariableSigmoid.h.

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

equality up to tolerance

Definition at line 41 of file switchVariableSigmoid.h.

static SwitchVariableSigmoid vertigo::SwitchVariableSigmoid::Expmap

(

const gtsam::Vector &

v

)

[inline, static]

Expmap around identity

Definition at line 93 of file switchVariableSigmoid.h.

static SwitchVariableSigmoid vertigo::SwitchVariableSigmoid::identity

(

)

[inline, static]

identity

Definition at line 67 of file switchVariableSigmoid.h.

SwitchVariableSigmoid vertigo::SwitchVariableSigmoid::inverse

(

)

const [inline]

invert the object and yield a new one

Definition at line 86 of file switchVariableSigmoid.h.

gtsam::Vector vertigo::SwitchVariableSigmoid::localCoordinates

(

const SwitchVariableSigmoid &

t2

)

const [inline]

Returns:

the local coordinates of another object

Definition at line 62 of file switchVariableSigmoid.h.

static gtsam::Vector vertigo::SwitchVariableSigmoid::Logmap

(

const SwitchVariableSigmoid &

p

)

[inline, static]

Logmap around identity - just returns with default cast back

Definition at line 96 of file switchVariableSigmoid.h.

void vertigo::SwitchVariableSigmoid::print

(

const std::string &

name = ""

)

const [inline]

print

Parameters:

s	optional string naming the object

Definition at line 36 of file switchVariableSigmoid.h.

SwitchVariableSigmoid vertigo::SwitchVariableSigmoid::retract

(

const gtsam::Vector &

v

)

const [inline]

Update the SwitchVariableSigmoid with a tangent space update

Definition at line 52 of file switchVariableSigmoid.h.

double vertigo::SwitchVariableSigmoid::value

(

)

const [inline]

access the underlying value

Definition at line 33 of file switchVariableSigmoid.h.

---

Member Data Documentation

double vertigo::SwitchVariableSigmoid::d_ [private]

Definition at line 99 of file switchVariableSigmoid.h.

---

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

• switchVariableSigmoid.h