mrpt::mrpt::utils Namespace Reference

Namespaces
namespace	detail
Classes
struct	CProfilerProxy
Typedefs
typedef unsigned long	POINTER_TYPE
	For performing type casting from a pointer to its numeric value.
typedef uint64_t	TNodeID
	The type for node IDs in graphs of different types.
typedef std::pair< TNodeID, TNodeID >	TPairNodeIDs
	A pair of node IDs.
Functions
template<class T >
T	square (const T x)
	Inline function for the square of a number.
void BASE_IMPEXP	global_profiler_enter (const char *func_name) MRPT_NO_THROWS
void BASE_IMPEXP	global_profiler_leave (const char *func_name) MRPT_NO_THROWS
double	DEG2RAD (const double x)
	Degrees to radians.
float	DEG2RAD (const float x)
	Degrees to radians.
float	DEG2RAD (const int x)
	Degrees to radians.
double	RAD2DEG (const double x)
	Radians to degrees.
float	RAD2DEG (const float x)
	Radians to degrees.
template<typename T >
int	sign (T x)
	Returns the sign of X as "1" or "-1".
template<typename T >
int	signWithZero (T x)
	Returns the sign of X as "0", "1" or "-1".
template<typename T >
int	round (const T value)
	Returns the closer integer (int) to x.
template<typename T >
long	round_long (const T value)
	Returns the closer integer (long) to x.
template<typename T >
int	fix (T x)
	Rounds toward zero.
template<class R , class P >
R *	getAs (stlplus::smart_ptr_clone< P > &o)
	Utility to get a cast'ed pointer from a smart pointer.
template<class R , class P >
const R *	getAs (const stlplus::smart_ptr_clone< P > &o)
	Utility to get a cast'ed pointer from a smart pointer.
template<class T >
void	reverseBytesInPlace (T &v_in_out)
	Reverse the order of the bytes of a given type (useful for transforming btw little/big endian)
template<class T >
void	reverseBytes (const T &v_in, T &v_out)
	Reverse the order of the bytes of a given type (useful for transforming btw little/big endian)
template<typename T , typename K >
void	keep_min (T &var, const K test_val)
	If the second argument is below the first one, set the first argument to this lower value.
template<typename T , typename K >
void	keep_max (T &var, const K test_val)
	If the second argument is above the first one, set the first argument to this higher value.
template<class T >
void	delete_safe (T *&ptr)
	Calls "delete" to free an object only if the pointer is not NULL, then set the pointer to NULL.
template<class T >
void	vector_strong_clear (std::vector< T > &v)
	Like calling a std::vector<>'s clear() method, but really forcing deallocating the memory.
Variables
class BASE_IMPEXP	CStream

---

Typedef Documentation

typedef unsigned long mrpt::mrpt::utils::POINTER_TYPE

For performing type casting from a pointer to its numeric value.

Definition at line 150 of file CColouredPointsMap.h.

typedef uint64_t mrpt::mrpt::utils::TNodeID

The type for node IDs in graphs of different types.

Definition at line 153 of file CColouredPointsMap.h.

typedef std::pair< TNodeID, TNodeID > mrpt::mrpt::utils::TPairNodeIDs

A pair of node IDs.

Definition at line 154 of file CColouredPointsMap.h.

---

Function Documentation

double mrpt::mrpt::utils::DEG2RAD

(

const double

x

)

[inline]

Degrees to radians.

Definition at line 86 of file CColouredPointsMap.h.

float mrpt::mrpt::utils::DEG2RAD

(

const float

x

)

[inline]

Degrees to radians.

Definition at line 88 of file CColouredPointsMap.h.

float mrpt::mrpt::utils::DEG2RAD

(

const int

x

)

[inline]

Degrees to radians.

Definition at line 90 of file CColouredPointsMap.h.

template<class T >

void mrpt::mrpt::utils::delete_safe

(

T *&

ptr

)

Calls "delete" to free an object only if the pointer is not NULL, then set the pointer to NULL.

Definition at line 200 of file CColouredPointsMap.h.

template<typename T >

int mrpt::mrpt::utils::fix

(

T

x

)

[inline]

Rounds toward zero.

Definition at line 157 of file CColouredPointsMap.h.

template<class R , class P >

R* mrpt::mrpt::utils::getAs

(

stlplus::smart_ptr_clone< P > &

o

)

[inline]

Utility to get a cast'ed pointer from a smart pointer.

Definition at line 165 of file CColouredPointsMap.h.

template<class R , class P >

const R* mrpt::mrpt::utils::getAs

(

const stlplus::smart_ptr_clone< P > &

o

)

[inline]

Utility to get a cast'ed pointer from a smart pointer.

Definition at line 169 of file CColouredPointsMap.h.

void BASE_IMPEXP mrpt::mrpt::utils::global_profiler_enter

(

const char *

func_name

)

void BASE_IMPEXP mrpt::mrpt::utils::global_profiler_leave

(

const char *

func_name

)

template<typename T , typename K >

void mrpt::mrpt::utils::keep_max	(	T &	var,
		const K	test_val
	)		[inline]

If the second argument is above the first one, set the first argument to this higher value.

Definition at line 194 of file CColouredPointsMap.h.

Referenced by mrpt::vision::TSimpleFeatureList_templ< TSimpleFeature >::getMaxID(), mrpt::math::maximum(), and mrpt::graphslam::optimize_graph_spa_levmarq().

template<typename T , typename K >

void mrpt::mrpt::utils::keep_min	(	T &	var,
		const K	test_val
	)		[inline]

If the second argument is below the first one, set the first argument to this lower value.

Definition at line 188 of file CColouredPointsMap.h.

Referenced by mrpt::math::minimum().

float mrpt::mrpt::utils::RAD2DEG

(

const float

x

)

[inline]

Radians to degrees.

Definition at line 94 of file CColouredPointsMap.h.

double mrpt::mrpt::utils::RAD2DEG

(

const double

x

)

[inline]

Radians to degrees.

Definition at line 92 of file CColouredPointsMap.h.

template<class T >

void mrpt::mrpt::utils::reverseBytes	(	const T &	v_in,
		T &	v_out
	)		[inline]

Reverse the order of the bytes of a given type (useful for transforming btw little/big endian)

Definition at line 179 of file CColouredPointsMap.h.

template<class T >

void mrpt::mrpt::utils::reverseBytesInPlace

(

T &

v_in_out

)

[inline]

Reverse the order of the bytes of a given type (useful for transforming btw little/big endian)

Definition at line 172 of file CColouredPointsMap.h.

References ASSERT_BELOW_, and mrpt::math::size().

Referenced by mrpt::utils::CStream::ReadBufferFixEndianness().

template<typename T >

int mrpt::mrpt::utils::round

(

const T

value

)

[inline]

Returns the closer integer (int) to x.

Definition at line 113 of file CColouredPointsMap.h.

template<typename T >

long mrpt::mrpt::utils::round_long

(

const T

value

)

[inline]

Returns the closer integer (long) to x.

Definition at line 135 of file CColouredPointsMap.h.

template<typename T >

int mrpt::mrpt::utils::sign

(

T

x

)

[inline]

Returns the sign of X as "1" or "-1".

Definition at line 105 of file CColouredPointsMap.h.

template<typename T >

int mrpt::mrpt::utils::signWithZero

(

T

x

)

[inline]

Returns the sign of X as "0", "1" or "-1".

Definition at line 109 of file CColouredPointsMap.h.

template<class T >

T mrpt::mrpt::utils::square

(

const T

x

)

[inline]

Inline function for the square of a number.

Definition at line 161 of file CColouredPointsMap.h.

Referenced by mrpt::math::meanAndStd().

template<class T >

void mrpt::mrpt::utils::vector_strong_clear

(

std::vector< T > &

v

)

[inline]

Like calling a std::vector<>'s clear() method, but really forcing deallocating the memory.

Definition at line 209 of file CColouredPointsMap.h.

---

Variable Documentation

class BASE_IMPEXP mrpt::mrpt::utils::CStream

Definition at line 47 of file CColouredPointsMap.h.