Miscellaneous Tools

The same group on the Doxygen site.

group Miscellaneous Tools

Tools for development, debugging and testing.

This group contains several useful tools for development, debugging and testing.

Subgroups

Group

Description

Time Measuring and Counting

Simple tools for measuring the performance of algorithms.

Classes

Class

Description

ArgParser

Command line arguments parser.

Color

Data structure representing RGB colors.

Palette

Map ints to different Colors.

_random_bits::Random

Mersenne Twister random number generator.

Tolerance

A class to provide a basic way to handle the comparison of numbers that are obtained as a result of a probably inexact computation.

Other classes of its headers

Class

Description

ArgParserException

Exception used by ArgParser.

Programs

Program

Description

test_tools.h

Functions and other members

typedef _random_bits::Random< unsigned long > Random

Mersenne Twister random number generator.

This class implements either the 32-bit or the 64-bit version of the Mersenne Twister random number generator algorithm depending on the system architecture.

For the API description, see its base class Random.

See also

Random

typedef _random_bits::Random< unsigned int > Random32

Mersenne Twister random number generator (32-bit version).

This class implements the 32-bit version of the Mersenne Twister random number generator algorithm. It is recommended to be used when someone wants to make sure that the same pseudo random sequence will be generated on every platfrom.

For the API description, see its base class Random.

See also

Random

typedef _random_bits::Random< unsigned long long > Random64

Mersenne Twister random number generator (64-bit version).

This class implements the 64-bit version of the Mersenne Twister random number generator algorithm. (Even though it runs on 32-bit architectures, too.) It is recommended to be used when someone wants to make sure that the same pseudo random sequence will be generated on every platfrom.

For the API description, see its base class Random.

See also

Random

const Color WHITE = Color(1, 1, 1)

White color constant.

const Color BLACK = Color(0, 0, 0)

Black color constant.

const Color RED = Color(1, 0, 0)

Red color constant.

const Color GREEN = Color(0, 1, 0)

Green color constant.

const Color BLUE = Color(0, 0, 1)

Blue color constant.

const Color YELLOW = Color(1, 1, 0)

Yellow color constant.

const Color MAGENTA = Color(1, 0, 1)

Magenta color constant.

const Color CYAN = Color(0, 1, 1)

Cyan color constant.

const Color GREY = Color(0, 0, 0)

Grey color constant.

const Color DARK_RED = Color(.5, 0, 0)

Dark red color constant.

const Color DARK_GREEN = Color(0, .5, 0)

Dark green color constant.

const Color DARK_BLUE = Color(0, 0, .5)

Drak blue color constant.

const Color DARK_YELLOW = Color(.5, .5, 0)

Dark yellow color constant.

const Color DARK_MAGENTA = Color(.5, 0, .5)

Dark magenta color constant.

const Color DARK_CYAN = Color(0, .5, .5)

Dark cyan color constant.

LEMON_CONSTANT long double E = 2.7182818284590452353602874713526625L

The Euler constant.

LEMON_CONSTANT long double LOG2E = 1.4426950408889634073599246810018921L

log_2(e)

LEMON_CONSTANT long double LOG10E = 0.4342944819032518276511289189166051L

log_10(e)

LEMON_CONSTANT long double LN2 = 0.6931471805599453094172321214581766L

ln(2)

LEMON_CONSTANT long double LN10 = 2.3025850929940456840179914546843642L

ln(10)

LEMON_CONSTANT long double PI = 3.1415926535897932384626433832795029L

pi

LEMON_CONSTANT long double PI_2 = 1.5707963267948966192313216916397514L

pi/2

LEMON_CONSTANT long double PI_4 = 0.7853981633974483096156608458198757L

pi/4

LEMON_CONSTANT long double SQRT2 = 1.4142135623730950488016887242096981L

sqrt(2)

LEMON_CONSTANT long double SQRT1_2 = 0.7071067811865475244008443621048490L

1/sqrt(2)

inline Color distantColor( const Color & c )

Returns a visibly distinct Color.

Returns a Color which is as different from the given parameter as it is possible.

inline Color distantBW( const Color & c )

Returns black for light colors and white for the dark ones.

inline bool isNaN( double v )

Check whether the parameter is NaN or not.

This function checks whether the parameter is NaN or not. Is should be equivalent with std::isnan(), but it is not provided by all compilers.

inline double round( double r )

Round a value to its closest integer.