gtsam::Cyclic< N > Class Template Reference

Cyclic group of order N. More...

#include <Cyclic.h>

Public Member Functions
	Cyclic (size_t i)
	Constructor. More...
	Cyclic ()
	Default constructor yields identity. More...
bool	equals (const Cyclic &other, double tol=1e-9) const
	equals with an tolerance, prints out message if unequal More...
	operator size_t () const
	Cast to size_t. More...
Cyclic	operator+ (const Cyclic &h) const
	Addition modulo N. More...
Cyclic	operator- (const Cyclic &h) const
	Subtraction modulo N. More...
Cyclic	operator- () const
	Inverse. More...
void	print (const std::string &s="") const
	print with optional string More...

Static Public Member Functions
static Cyclic	Identity ()

Private Attributes
size_t	i_
	we just use an unsigned int More...

Detailed Description

template<size_t N>
class gtsam::Cyclic< N >

Cyclic group of order N.

Definition at line 30 of file Cyclic.h.

Constructor & Destructor Documentation

Cyclic() [1/2]

template<size_t N>

gtsam::Cyclic< N >::Cyclic ( size_t  i )

inline

Constructor.

Definition at line 34 of file Cyclic.h.

Cyclic() [2/2]

template<size_t N>

gtsam::Cyclic< N >::Cyclic ( )

inline

Default constructor yields identity.

Definition at line 39 of file Cyclic.h.

Member Function Documentation

equals()

template<size_t N>

bool gtsam::Cyclic< N >::equals ( const Cyclic< N > &  other, double  tol = 1e-9  ) const

inline

equals with an tolerance, prints out message if unequal

Definition at line 64 of file Cyclic.h.

Identity()

template<size_t N>

static Cyclic gtsam::Cyclic< N >::Identity ( )

inlinestatic

Definition at line 41 of file Cyclic.h.

operator size_t()

template<size_t N>

gtsam::Cyclic< N >::operator size_t ( ) const

inline

Cast to size_t.

Definition at line 44 of file Cyclic.h.

operator+()

template<size_t N>

Cyclic gtsam::Cyclic< N >::operator+ ( const Cyclic< N > &  h ) const

inline

Addition modulo N.

Definition at line 48 of file Cyclic.h.

operator-() [1/2]

template<size_t N>

Cyclic gtsam::Cyclic< N >::operator- ( const Cyclic< N > &  h ) const

inline

Subtraction modulo N.

Definition at line 52 of file Cyclic.h.

operator-() [2/2]

template<size_t N>

Cyclic gtsam::Cyclic< N >::operator- ( void  ) const

inline

Inverse.

Definition at line 56 of file Cyclic.h.

print()

template<size_t N>

void gtsam::Cyclic< N >::print ( const std::string &  s = "" ) const

inline

print with optional string

Definition at line 60 of file Cyclic.h.

Member Data Documentation

i_

template<size_t N>

size_t gtsam::Cyclic< N >::i_

private

we just use an unsigned int

Definition at line 31 of file Cyclic.h.

---

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

• Cyclic.h