basic.h File Reference

Basic declarations, included by all source files. More...

#include <ogdf/basic/internal/config.h>
#include <ogdf/basic/internal/config_autogen.h>
#include <algorithm>
#include <cmath>
#include <fstream>
#include <string>
#include <cassert>

Go to the source code of this file.

Classes
class	ogdf::BucketFunc< E >
	Abstract base class for bucket functions. More...
class	ogdf::Initialization
	The class Initialization is used for initializing global variables. More...

Namespaces
namespace	ogdf
	The namespace for all OGDF objects.

Macros
#define	OGDF_TRIVIALLY_COPYABLE   std::is_trivially_copyable
Assertions (only active in debug builds)
#define	OGDF_ASSERT(expr)
	Assert condition expr. See doc/build.md for more information.
#define	OGDF_ASSERT(expr)   assert(expr)
	Assert condition expr. See doc/build.md for more information.
#define	OGDF_HEAVY_ASSERT(expr)
	Assert condition expr when using heavy debugging. See OGDF_ASSERT.
#define	OGDF_IF_DBG(x)
	Single statement that will only be compiled if OGDF_DEBUG is defined.
#define	OGDF_IF_DBG(x)   x
	Single statement that will only be compiled if OGDF_DEBUG is defined.

Enumerations
enum class	ogdf::Direction { ogdf::before , ogdf::after }

Functions
bool	ogdf::equalIgnoreCase (const string &str1, const string &str2)
	Compares the two strings str1 and str2, ignoring the case of characters.
bool	ogdf::prefixIgnoreCase (const string &prefix, const string &str)
	Tests if prefix is a prefix of str, ignoring the case of characters.
double	ogdf::randomDouble (double low, double high)
	Returns a random double value from the interval [low, high).
double	ogdf::randomDoubleExponential (double beta)
	Returns a random double value from the exponential distribution.
double	ogdf::randomDoubleNormal (double m, double sd)
	Returns a random double value from the normal distribution with mean m and standard deviation sd.
int	ogdf::randomNumber (int low, int high)
	Returns random integer between low and high (including).
long unsigned int	ogdf::randomSeed ()
	Returns a random value suitable as initial seed for a random number engine.
void	ogdf::removeTrailingWhitespace (string &str)
	Removes trailing space, horizontal and vertical tab, feed, newline, and carriage return from str.
template<typename CONTAINER , typename T >
int	ogdf::searchPos (const CONTAINER &C, const T &x)
	Searches for the position of x in container C; returns -1 if not found.
void	ogdf::setSeed (int val)
	Sets the seed for functions like randomSeed(), randomNumber(), randomDouble().
double	ogdf::usedTime (double &T)
	Returns used CPU time from T to current time and assigns current time to T.

Variables
bool	ogdf::debugMode
	Set to true iff debug mode is used during compilation of the OGDF.
static Initialization	ogdf::s_ogdfInitializer

Detailed Description

Basic declarations, included by all source files.

Author

Carsten Gutwenger

License:

This file is part of the Open Graph Drawing Framework (OGDF).

Copyright (C)
See README.md in the OGDF root directory for details.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License Version 2 or 3 as published by the Free Software Foundation; see the file LICENSE.txt included in the packaging of this file for details.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, see http://www.gnu.org/copyleft/gpl.html

Definition in file basic.h.

Macro Definition Documentation

OGDF_TRIVIALLY_COPYABLE

#define OGDF_TRIVIALLY_COPYABLE   std::is_trivially_copyable

Definition at line 111 of file basic.h.