dlrLibs Utility Libraries: dlr::common Namespace Reference


Classes
class	CompileTimestamp
	The CompileTimestamp class permits user code to conveniently assess when it was compiled. More...
class	Exception
	Base class for all exceptions thrown from code in namespace dlr. More...
class	IOException
	This is an Exception class for errors in which the outside world is misbehaving. More...
class	BinaryComposeFunctor
	Functor template for composing one binary function, functor0(x, y), and two unary functions functor1(x) and functor2(x) so that the result is functor0(functor1(x), functor2(y)). More...
class	ComposeFunctor_1_2
	Functor template for composing one unary function, functor0(x) and one binary function functor1(x, y) so that the result is functor0(functor1(x, y)). More...
class	ExtractFirstFunctor
	Functor template for extracting the first element of a std::pair. More...
class	ExtractSecondFunctor
	Functor template for extracting the second element of a std::pair. More...
class	ApproximatelyEqualFunctor
	Functor template for comparing two values to determine equivalence within a specified precision. More...
class	PointerToBinaryFunctionRA
	Functor template much like std::pointer_to_binary_function, but specifically for functions which take const reference arguments. More...
struct	StaticCastFunctor
	Functor template which uses static_cast to convert instances of one type into instances of another. More...
class	UnaryComposeFunctor
	Functor template for composing two unary functions functor0(x) and functor1(x) so that the result is functor0(functor1(x)). More...
class	InputStream
	The InputStream class is used to add convenience functions to existing istreams. More...
class	ReferenceCount
	The ReferenceCount class provides a convenient way to track a shared resource so you know when to delete it. More...
class	StridedPointer
	The StridedPointer class permits convenient iterator-style access to regularly spaced elements within a C-style array. More...
class	type_tag
class	Triple
	The Triple class provides a convenient way to pass groups of three things around. More...
Typedefs
typedef privateCode::LocalTypeStruct::Int8	Int8
typedef privateCode::LocalTypeStruct::Int16	Int16
typedef privateCode::LocalTypeStruct::Int32	Int32
typedef privateCode::LocalTypeStruct::Int64	Int64
typedef privateCode::LocalTypeStruct::Float32	Float32
typedef privateCode::LocalTypeStruct::Float64	Float64
typedef privateCode::LocalTypeStruct::UnsignedInt8	UnsignedInt8
typedef privateCode::LocalTypeStruct::UnsignedInt16	UnsignedInt16
typedef privateCode::LocalTypeStruct::UnsignedInt32	UnsignedInt32
typedef privateCode::LocalTypeStruct::UnsignedInt64	UnsignedInt64
Enumerations
enum	ByteOrder { DLR_BIG_ENDIAN, DLR_LITTLE_ENDIAN }
	This enum provides a convenient way to represent the various machine-dependent byte orderings. More...
Functions
template<class Type>
std::ostream &	addArgumentDescription (std::ostream &outputStream, const Type &argument)
	This function template is responsible deciding how to print argument values during a stack trace.
ByteOrder	getByteOrder ()
template<class Type>
void	switchByteOrder (Type *dataPtr, size_t numberOfElements, ByteOrder fromByteOrder, ByteOrder toByteOrder)
	This function takes a pointer to a C-style array of values and modifies the array in place so that it has a particular byte order.
template<class Type>
void	switchByteOrder (const Type fromDataPtr, size_t numberOfElements, Type toDataPtr, ByteOrder fromByteOrder, ByteOrder toByteOrder)
	This function takes a pointer to a C-style array of values and copies it into another C-style array, swapping bytes if necessary so that the output array has the specified byte order.
	DLR_DECLARE_EXCEPTION_TYPE (IndexException, Exception)
	This is an Exception class for errors in which an array index or similar argument is out of bounds.
	DLR_DECLARE_EXCEPTION_TYPE (LogicException, Exception)
	This is an Exception class for errors which could have been caught at compile time.
	DLR_DECLARE_EXCEPTION_TYPE (NotImplementedException, Exception)
	This type of Exception is thrown when a piece of code has not been written, and the developer had the foresight to document its non-existence.
	DLR_DECLARE_EXCEPTION_TYPE (RunTimeException, Exception)
	This exception is thrown when an error occurs which could not have been anticipated at compile time, and for which ValueException, IOException, etc., are not appropriate.
	DLR_DECLARE_EXCEPTION_TYPE (StateException, Exception)
	This exception is thrown when the internal state of a class is inconsistent, or when the calling environment interacts with a class in a way which is inconsistent with its internal state.
	DLR_DECLARE_EXCEPTION_TYPE (ValueException, Exception)
	This exception is thrown when the argument to a function has and inappropriate value, and when a more specific exception is not appropriate.
template<class Type>
bool	approximatelyEqual (const Type &argument0, const Type &argument1, const Type &epsilon)
	This convenience function constructs an ApproximatelyEqualFunctor<Type> functor and applies it two the first two arguments.
template<class Functor0, class Functor1, class Functor2>
BinaryComposeFunctor< Functor0, Functor1, Functor2 >	binaryComposeFunctor (const Functor0 &functor0, const Functor1 &functor1, const Functor2 &functor2)
	This is a convenience function which makes it easy to create BinaryComposeFunctor instances.
template<class Type>
Type	clip (Type value, Type lowerBound, Type upperBound)
	This convenience function clips its first argument to lie within the closed range defined by it's remaining arguments.
template<class Functor0, class Functor1>
ComposeFunctor_1_2< Functor0, Functor1 >	composeFunctor_1_2 (const Functor0 &functor0, const Functor1 &functor1)
	This is a convenience function which makes it easy to create ComposeFunctor_1_2 instances.
template<class Functor0, class Functor1>
UnaryComposeFunctor< Functor0, Functor1 >	unaryComposeFunctor (const Functor0 &functor0, const Functor1 &functor1)
	This is a convenience function which makes it easy to create UnaryComposeFunctor instances.
std::string	describeArguments ()
	This function template formats its entire argument list for inclusion in a stack trace.
template<class Type0>
std::string	describeArguments (const Type0 &argument0)
	This function template formats its entire argument list for inclusion in a stack trace.
template<class Type0, class Type1>
std::string	describeArguments (const Type0 &argument0, const Type1 &argument1)
	This function template formats its entire argument list for inclusion in a stack trace.
template<class Type0, class Type1, class Type2>
std::string	describeArguments (const Type0 &argument0, const Type1 &argument1, const Type2 &argument2)
	This function template formats its entire argument list for inclusion in a stack trace.
template<class Type0, class Type1, class Type2, class Type3>
std::string	describeArguments (const Type0 &argument0, const Type1 &argument1, const Type2 &argument2, const Type3 &argument3)
	This function template formats its entire argument list for inclusion in a stack trace.
template<class Type0, class Type1, class Type2, class Type3, class Type4>
std::string	describeArguments (const Type0 &argument0, const Type1 &argument1, const Type2 &argument2, const Type3 &argument3, const Type4 &argument4)
	This function template formats its entire argument list for inclusion in a stack trace.
template<class Type0, class Type1, class Type2, class Type3, class Type4, class Type5>
std::string	describeArguments (const Type0 &argument0, const Type1 &argument1, const Type2 &argument2, const Type3 &argument3, const Type4 &argument4, const Type5 &argument5)
	This function template formats its entire argument list for inclusion in a stack trace.
template<class Type0, class Type1, class Type2, class Type3, class Type4, class Type5, class Type6>
std::string	describeArguments (const Type0 &argument0, const Type1 &argument1, const Type2 &argument2, const Type3 &argument3, const Type4 &argument4, const Type5 &argument5, const Type6 &argument6)
	This function template formats its entire argument list for inclusion in a stack trace.
template<class Type0, class Type1, class Type2, class Type3, class Type4, class Type5, class Type6, class Type7>
std::string	describeArguments (const Type0 &argument0, const Type1 &argument1, const Type2 &argument2, const Type3 &argument3, const Type4 &argument4, const Type5 &argument5, const Type6 &argument6, const Type7 &argument7)
	This function template formats its entire argument list for inclusion in a stack trace.
template<class Type0, class Type1, class Type2, class Type3, class Type4, class Type5, class Type6, class Type7, class Type8>
std::string	describeArguments (const Type0 &argument0, const Type1 &argument1, const Type2 &argument2, const Type3 &argument3, const Type4 &argument4, const Type5 &argument5, const Type6 &argument6, const Type7 &argument7, const Type8 &argument8)
	This function template formats its entire argument list for inclusion in a stack trace.
template<class Type0, class Type1, class Type2, class Type3, class Type4, class Type5, class Type6, class Type7, class Type8, class Type9>
std::string	describeArguments (const Type0 &argument0, const Type1 &argument1, const Type2 &argument2, const Type3 &argument3, const Type4 &argument4, const Type5 &argument5, const Type6 &argument6, const Type7 &argument7, const Type8 &argument8, const Type9 &argument9)
	This function template formats its entire argument list for inclusion in a stack trace.
template<class Type0, class Type1, class Type2, class Type3, class Type4, class Type5, class Type6, class Type7, class Type8, class Type9, class Type10>
std::string	describeArguments (const Type0 &argument0, const Type1 &argument1, const Type2 &argument2, const Type3 &argument3, const Type4 &argument4, const Type5 &argument5, const Type6 &argument6, const Type7 &argument7, const Type8 &argument8, const Type9 &argument9, const Type10 &argument10)
	This function template formats its entire argument list for inclusion in a stack trace.
template<class Type0, class Type1, class Type2, class Type3, class Type4, class Type5, class Type6, class Type7, class Type8, class Type9, class Type10, class Type11>
std::string	describeArguments (const Type0 &argument0, const Type1 &argument1, const Type2 &argument2, const Type3 &argument3, const Type4 &argument4, const Type5 &argument5, const Type6 &argument6, const Type7 &argument7, const Type8 &argument8, const Type9 &argument9, const Type10 &argument10, const Type11 &argument11)
	This function template formats its entire argument list for inclusion in a stack trace.
template<class Type0, class Type1, class Type2, class Type3, class Type4, class Type5, class Type6, class Type7, class Type8, class Type9, class Type10, class Type11, class Type12>
std::string	describeArguments (const Type0 &argument0, const Type1 &argument1, const Type2 &argument2, const Type3 &argument3, const Type4 &argument4, const Type5 &argument5, const Type6 &argument6, const Type7 &argument7, const Type8 &argument8, const Type9 &argument9, const Type10 &argument10, const Type11 &argument11, const Type12 &argument12)
	This function template formats its entire argument list for inclusion in a stack trace.
template<class Type0, class Type1, class Type2, class Type3, class Type4, class Type5, class Type6, class Type7, class Type8, class Type9, class Type10, class Type11, class Type12, class Type13>
std::string	describeArguments (const Type0 &argument0, const Type1 &argument1, const Type2 &argument2, const Type3 &argument3, const Type4 &argument4, const Type5 &argument5, const Type6 &argument6, const Type7 &argument7, const Type8 &argument8, const Type9 &argument9, const Type10 &argument10, const Type11 &argument11, const Type12 &argument12, const Type13 &argument13)
	This function template formats its entire argument list for inclusion in a stack trace.
template<class Type0, class Type1, class Type2, class Type3, class Type4, class Type5, class Type6, class Type7, class Type8, class Type9, class Type10, class Type11, class Type12, class Type13, class Type14>
std::string	describeArguments (const Type0 &argument0, const Type1 &argument1, const Type2 &argument2, const Type3 &argument3, const Type4 &argument4, const Type5 &argument5, const Type6 &argument6, const Type7 &argument7, const Type8 &argument8, const Type9 &argument9, const Type10 &argument10, const Type11 &argument11, const Type12 &argument12, const Type13 &argument13, const Type14 &argument14)
	This function template formats its entire argument list for inclusion in a stack trace.
template<class Type0, class Type1, class Type2, class Type3, class Type4, class Type5, class Type6, class Type7, class Type8, class Type9, class Type10, class Type11, class Type12, class Type13, class Type14, class Type15>
std::string	describeArguments (const Type0 &argument0, const Type1 &argument1, const Type2 &argument2, const Type3 &argument3, const Type4 &argument4, const Type5 &argument5, const Type6 &argument6, const Type7 &argument7, const Type8 &argument8, const Type9 &argument9, const Type10 &argument10, const Type11 &argument11, const Type12 &argument12, const Type13 &argument13, const Type14 &argument14, const Type15 &argument15)
	This function template formats its entire argument list for inclusion in a stack trace.
template<class Type0, class Type1, class Type2, class Type3, class Type4, class Type5, class Type6, class Type7, class Type8, class Type9, class Type10, class Type11, class Type12, class Type13, class Type14, class Type15, class Type16>
std::string	describeArguments (const Type0 &argument0, const Type1 &argument1, const Type2 &argument2, const Type3 &argument3, const Type4 &argument4, const Type5 &argument5, const Type6 &argument6, const Type7 &argument7, const Type8 &argument8, const Type9 &argument9, const Type10 &argument10, const Type11 &argument11, const Type12 &argument12, const Type13 &argument13, const Type14 &argument14, const Type15 &argument15, const Type16 &argument16)
	This function template formats its entire argument list for inclusion in a stack trace.
template<class Type0, class Type1, class Type2, class Type3, class Type4, class Type5, class Type6, class Type7, class Type8, class Type9, class Type10, class Type11, class Type12, class Type13, class Type14, class Type15, class Type16, class Type17>
std::string	describeArguments (const Type0 &argument0, const Type1 &argument1, const Type2 &argument2, const Type3 &argument3, const Type4 &argument4, const Type5 &argument5, const Type6 &argument6, const Type7 &argument7, const Type8 &argument8, const Type9 &argument9, const Type10 &argument10, const Type11 &argument11, const Type12 &argument12, const Type13 &argument13, const Type14 &argument14, const Type15 &argument15, const Type16 &argument16, const Type17 &argument17)
	This function template formats its entire argument list for inclusion in a stack trace.
template<class Type0, class Type1, class Type2, class Type3, class Type4, class Type5, class Type6, class Type7, class Type8, class Type9, class Type10, class Type11, class Type12, class Type13, class Type14, class Type15, class Type16, class Type17, class Type18>
std::string	describeArguments (const Type0 &argument0, const Type1 &argument1, const Type2 &argument2, const Type3 &argument3, const Type4 &argument4, const Type5 &argument5, const Type6 &argument6, const Type7 &argument7, const Type8 &argument8, const Type9 &argument9, const Type10 &argument10, const Type11 &argument11, const Type12 &argument12, const Type13 &argument13, const Type14 &argument14, const Type15 &argument15, const Type16 &argument16, const Type17 &argument17, const Type18 &argument18)
	This function template formats its entire argument list for inclusion in a stack trace.
template<class Type0, class Type1, class Type2, class Type3, class Type4, class Type5, class Type6, class Type7, class Type8, class Type9, class Type10, class Type11, class Type12, class Type13, class Type14, class Type15, class Type16, class Type17, class Type18, class Type19>
std::string	describeArguments (const Type0 &argument0, const Type1 &argument1, const Type2 &argument2, const Type3 &argument3, const Type4 &argument4, const Type5 &argument5, const Type6 &argument6, const Type7 &argument7, const Type8 &argument8, const Type9 &argument9, const Type10 &argument10, const Type11 &argument11, const Type12 &argument12, const Type13 &argument13, const Type14 &argument14, const Type15 &argument15, const Type16 &argument16, const Type17 &argument17, const Type18 &argument18, const Type19 &argument19)
	This function template formats its entire argument list for inclusion in a stack trace.
template<class Type0, class Type1, class Type2>
Triple< Type0, Type1, Type2 >	makeTriple (const Type0 &element0, const Type1 &element1, const Type2 &element2)
	makeTriple is a convenience function for creating Triples.
Variables
type_tag< char >	Char
type_tag< double >	Double
type_tag< float >	Float
type_tag< int >	Int
type_tag< short >	Short
type_tag< unsigned char >	UnsignedChar
type_tag< unsigned short >	UnsignedShort
type_tag< char >	Char
type_tag< double >	Double
type_tag< float >	Float
type_tag< int >	Int
type_tag< short >	Short
type_tag< size_t >	SizeT
type_tag< unsigned char >	UnsignedChar
type_tag< unsigned short >	UnsignedShort

Detailed Description

Enumeration Type Documentation

enum dlr::common::ByteOrder

This enum provides a convenient way to represent the various machine-dependent byte orderings.

Enumerator:

DLR_BIG_ENDIAN
DLR_LITTLE_ENDIAN

Definition at line 31 of file byteOrder.h.

Function Documentation

template<class Type>

std::ostream& dlr::common::addArgumentDescription	(	std::ostream &	outputStream,
		const Type &	argument
	)			`[inline]`

This function template is responsible deciding how to print argument values during a stack trace.

The default is to use the stream output operator, but you'll want to specialize it for classes which don't implement a stream output operator, and for classes whose stream output operators print inappropriate stuff.

Parameters:

	outputStream	This argument is the stream to which the argument description will be sent.
	argument	This argument is the actual argument to be described.

Returns:: The return value is a reference to parameter outputStream.

Definition at line 41 of file argumentDescription.h.

Referenced by describeArguments().

template<class Type>

bool dlr::common::approximatelyEqual	(	const Type &	argument0,
		const Type &	argument1,
		const Type &	epsilon
	)			`[inline]`

This convenience function constructs an ApproximatelyEqualFunctor<Type> functor and applies it two the first two arguments.

The third argument sets the threshold for approximate equality. For example, approximatelyEqual(1.0003, 1.0005, 1.0E-6) will return false, while approximatelyEqual(1.0003, 1.0005, 1.0E-3) will return true.

Parameters:

	argument0	This argument is the first value to be compared.
	argument1	This argument is the second value to be compared.
	epsilon	This argument is passed directly to the constructor of ApproximatelyEqual, and specifies the threshold for approximate equality.

Returns:: The return value is true if the values are approximately equal, false otherwise.

Definition at line 451 of file dlrCommon/functional.h.

Referenced by dlr::computerVision::OpticalFlow< Format >::getFlow(), dlr::numeric::transform3DToQuaternion(), and dlr::numeric::transform3DToRollPitchYaw().

template<class Functor0, class Functor1, class Functor2>

BinaryComposeFunctor<Functor0, Functor1, Functor2> dlr::common::binaryComposeFunctor	(	const Functor0 &	functor0,
		const Functor1 &	functor1,
		const Functor2 &	functor2
	)			`[inline]`

This is a convenience function which makes it easy to create BinaryComposeFunctor instances.

Parameters:

	functor0	This will be passed as the first constructor argument of the returned BinaryComposeFunctor instance.
	functor1	This will be passed as the second constructor argument of the returned BinaryComposeFunctor instance.
	functor2	This will be passed as the third constructor argument of the returned BinaryComposeFunctor instance.

Returns:: A BinaryComposeFunctor template instantiation of the appropriate type.

Definition at line 475 of file dlrCommon/functional.h.

template<class Type>

Type dlr::common::clip	(	Type	value,
		Type	lowerBound,
		Type	upperBound
	)			`[inline]`

This convenience function clips its first argument to lie within the closed range defined by it's remaining arguments.

Parameters:

	value	This argument is the value to be clipped.
	lowerBound	The value will be clipped so that it is greater than or equal to this argument.
	upperBound	The value will be clipped so that it is less than or equal to this argument.

Returns:: The clipped value is returned.

Definition at line 499 of file dlrCommon/functional.h.

template<class Functor0, class Functor1>

ComposeFunctor_1_2<Functor0, Functor1> dlr::common::composeFunctor_1_2	(	const Functor0 &	functor0,
		const Functor1 &	functor1
	)			`[inline]`

This is a convenience function which makes it easy to create ComposeFunctor_1_2 instances.

Parameters:

	functor0	This will be passed as the first constructor argument of the returned functor.
	functor1	This will be passed as the second constructor argument of the returned functor.

Returns:: A ComposeFunctor_1_2 template instantiation of the appropriate type.

Definition at line 523 of file dlrCommon/functional.h.

Referenced by dlr::computerVision::registerPoints3D().

template<class Type0, class Type1, class Type2, class Type3, class Type4, class Type5, class Type6, class Type7, class Type8, class Type9, class Type10, class Type11, class Type12, class Type13, class Type14, class Type15, class Type16, class Type17, class Type18, class Type19>

std::string dlr::common::describeArguments	(	const Type0 &	argument0,
		const Type1 &	argument1,
		const Type2 &	argument2,
		const Type3 &	argument3,
		const Type4 &	argument4,
		const Type5 &	argument5,
		const Type6 &	argument6,
		const Type7 &	argument7,
		const Type8 &	argument8,
		const Type9 &	argument9,
		const Type10 &	argument10,
		const Type11 &	argument11,
		const Type12 &	argument12,
		const Type13 &	argument13,
		const Type14 &	argument14,
		const Type15 &	argument15,
		const Type16 &	argument16,
		const Type17 &	argument17,
		const Type18 &	argument18,
		const Type19 &	argument19
	)			`[inline]`

This function template formats its entire argument list for inclusion in a stack trace.

You'll need to have templates like this defined which take 1, 2, 3, 4, etc., arguments.

Parameters:

	argument0	This argument is the first argument to be included in the formatted output.
	argument1	This argument is the second argument to be included in the formatted output.
	argument2	This argument is the second argument to be included in the formatted output.
	argument3	This argument is the second argument to be included in the formatted output.
	argument4	This argument is the second argument to be included in the formatted output.
	argument5	This argument is the second argument to be included in the formatted output.
	argument6	This argument is the second argument to be included in the formatted output.
	argument7	This argument is the second argument to be included in the formatted output.
	argument8	This argument is the second argument to be included in the formatted output.
	argument9	This argument is the second argument to be included in the formatted output.
	argument10	This argument is the second argument to be included in the formatted output.
	argument11	This argument is the second argument to be included in the formatted output.
	argument12	This argument is the second argument to be included in the formatted output.
	argument13	This argument is the second argument to be included in the formatted output.
	argument14	This argument is the second argument to be included in the formatted output.
	argument15	This argument is the second argument to be included in the formatted output.
	argument16	This argument is the second argument to be included in the formatted output.
	argument17	This argument is the second argument to be included in the formatted output.
	argument18	This argument is the second argument to be included in the formatted output.
	argument19	This argument is the second argument to be included in the formatted output.

Returns:: The return value is a string describing the argument list.

Definition at line 1663 of file traceable.h.

dlr::common::DLR_DECLARE_EXCEPTION_TYPE	(	ValueException	,
		Exception
	)

dlr::common::DLR_DECLARE_EXCEPTION_TYPE	(	StateException	,
		Exception
	)

dlr::common::DLR_DECLARE_EXCEPTION_TYPE	(	RunTimeException	,
		Exception
	)

dlr::common::DLR_DECLARE_EXCEPTION_TYPE	(	NotImplementedException	,
		Exception
	)

dlr::common::DLR_DECLARE_EXCEPTION_TYPE	(	LogicException	,
		Exception
	)

dlr::common::DLR_DECLARE_EXCEPTION_TYPE	(	IndexException	,
		Exception
	)

Triple<Type0, Type1, Type2> dlr::common::makeTriple	(	const Type0 &	element0,
		const Type1 &	element1,
		const Type2 &	element2
	)			`[inline]`

	element0	This argument specifies the first element of the triple.
	element1	This argument specifies the second element of the triple.
	element2	This argument specifies the third element of the triple.

void dlr::common::switchByteOrder	(	const Type *	fromDataPtr,
		size_t	numberOfElements,
		Type *	toDataPtr,
		ByteOrder	fromByteOrder,
		ByteOrder	toByteOrder
	)			`[inline]`

	fromDataPtr	This argument is a pointer to the C-style array of input values.
	numberOfElements	This argument indicates how many values are in both the input array and the output array.
	toDataPtr	This argument is a pointer to the C-style array of output values.
	fromByteOrder	This argument indicates the current byte order of the values in the array.
	toByteOrder	This argument specifies the desired final byte order for the data in the array.

void dlr::common::switchByteOrder	(	Type *	dataPtr,
		size_t	numberOfElements,
		ByteOrder	fromByteOrder,
		ByteOrder	toByteOrder
	)			`[inline]`

	dataPtr	This argument is a pointer to the C-style array of values.
	numberOfElements	This argument indicates how many values are in the array.
	fromByteOrder	This argument indicates the current byte order of the values in the array.
	toByteOrder	This argument specifies the desired final byte order for the data in the array.

UnaryComposeFunctor<Functor0, Functor1> dlr::common::unaryComposeFunctor	(	const Functor0 &	functor0,
		const Functor1 &	functor1
	)			`[inline]`

dlr::common Namespace Reference

Classes

Typedefs

Enumerations

Functions

Variables

Detailed Description

Enumeration Type Documentation

Function Documentation

Variable Documentation