gtsam::EdgeKey Class Reference

#include <EdgeKey.h>

Public Member Functions
Constructors
	EdgeKey ()
	Default constructor. More...
	EdgeKey (std::uint32_t i, std::uint32_t j)
	Constructor. More...
	EdgeKey (Key key)
Testable
void	print (const std::string &s="") const
	Prints the EdgeKey with an optional prefix string. More...
bool	equals (const EdgeKey &expected, double tol=0.0) const
	Checks if this EdgeKey is equal to another, tolerance is ignored. More...

Protected Attributes
std::uint32_t	i_
	Upper 32 bits. More...
std::uint32_t	j_
	Lower 32 bits. More...

API
	operator Key () const
	Cast to Key. More...
std::uint32_t	i () const
	Retrieve high 32 bits. More...
std::uint32_t	j () const
	Retrieve low 32 bits. More...
	operator std::string () const
GTSAM_EXPORT std::ostream &	operator<< (std::ostream &, const EdgeKey &)
	Output stream operator. More...

Detailed Description

Definition at line 25 of file EdgeKey.h.

Constructor & Destructor Documentation

EdgeKey() [1/3]

gtsam::EdgeKey::EdgeKey ( )

inline

Default constructor.

Definition at line 35 of file EdgeKey.h.

EdgeKey() [2/3]

gtsam::EdgeKey::EdgeKey ( std::uint32_t  i, std::uint32_t  j  )

inline

Constructor.

Definition at line 38 of file EdgeKey.h.

EdgeKey() [3/3]

gtsam::EdgeKey::EdgeKey ( Key  key )

inline

Definition at line 40 of file EdgeKey.h.

Member Function Documentation

equals()

bool gtsam::EdgeKey::equals ( const EdgeKey &  expected, double  tol = 0.0  ) const

inline

Checks if this EdgeKey is equal to another, tolerance is ignored.

Definition at line 71 of file EdgeKey.h.

i()

std::uint32_t gtsam::EdgeKey::i ( ) const

inline

Retrieve high 32 bits.

Definition at line 52 of file EdgeKey.h.

j()

std::uint32_t gtsam::EdgeKey::j ( ) const

inline

Retrieve low 32 bits.

Definition at line 55 of file EdgeKey.h.

operator Key()

gtsam::EdgeKey::operator Key ( ) const

inline

Cast to Key.

Definition at line 49 of file EdgeKey.h.

operator std::string()

gtsam::EdgeKey::operator std::string

(

)

const

Create a string from the key

Definition at line 23 of file EdgeKey.cpp.

print()

void gtsam::EdgeKey::print

(

const std::string &

s = ""

)

const

Prints the EdgeKey with an optional prefix string.

Definition at line 32 of file EdgeKey.cpp.

Friends And Related Function Documentation

operator<<

GTSAM_EXPORT std::ostream& operator<< ( std::ostream &  os, const EdgeKey &  key  )

friend

Output stream operator.

Definition at line 27 of file EdgeKey.cpp.

Member Data Documentation

i_

std::uint32_t gtsam::EdgeKey::i_

protected

Upper 32 bits.

Definition at line 27 of file EdgeKey.h.

j_

std::uint32_t gtsam::EdgeKey::j_

protected

Lower 32 bits.

Definition at line 28 of file EdgeKey.h.

---

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

• EdgeKey.h
• EdgeKey.cpp