About aGrUM utilities. More...

Collaboration diagram for Utilities:

Detailed Description

About aGrUM utilities.

Modules
	Math
	All the maths you'll need.

	Configuration
	About aGrUM configuration.

	Smart Pointers
	RefPtr are a replacement for the usual pointers: they keep track of the number of "smart" pointers pointing to a given element.

Classes
class	gum::Directory
	Cross-platform directory utility. More...

template<typename T1 , typename T2 >
ostream &	std::operator<< (ostream &stream, const pair< T1, T2 > &val)
	'std::cout<<' operator for pairs. More...

template<typename T0 , typename... T>
std::ostream &	std::operator<< (std::ostream &os, const std::tuple< T0, T... > &t)
	'std::cout<<' operator for vectors. More...

template<typename T >
ostream &	std::operator<< (ostream &stream, const vector< T > &val)
	'std::cout<<' operator for vectors. More...

template<typename T >
bool	std::hasUniqueElts (std::vector< T > const &x)
	More...

template<typename T1 , typename T2 >
using	gum::forbidden_type = typename std::enable_if< !std::is_same< T1, T2 >::value, int >::type
	Forbidden_type<T1,T2> return the "int" type if T1 and T2 are of the same type, else nothing. More...

bool	gum::Memcmp (const void const in_, const void const out_, unsigned long size)
	Cross-platform replacement for memcmp. More...

void	gum::_atexit_ ()
	Used for debug purpose. More...

Idx	gum::randomValue (const Size max=2)
	Returns a random Idx between 0 and max-1 included. More...

double	gum::randomProba ()
	Returns a random double between 0 and 1 included (i.e. More...

template<typename GUM_SCALAR >
std::vector< GUM_SCALAR >	gum::randomDistribution (Size n)
	Return a random discrete distribution. More...

unsigned int	gum::randomGeneratorSeed ()
	Returns the aGrUM's seed used by the std::generators. More...

void	gum::initRandom (unsigned int seed=0)
	Initialize random generator seed. More...

std::default_random_engine	gum::getRandomGenerator (unsigned int seed=0)
	define a random_engine with correct seed More...

std::string	gum::getUniqueFileName ()
	Returns a path to a unique file name. More...

bool	gum::endsWith (std::string const &value, std::string const &ending)
	Returns true if value ends with ending. More...

std::vector< std::string >	gum::split (const std::string &orig, const std::string &delimiter)
	Split str using the delimiter. More...

std::string	gum::replace (const std::string &s, const std::string &val, const std::string &new_val)
	not usable for gcc 4.8 std::vector<std::string> split( const std::string& orig, const std::string& delimiter ) { More...

std::string	gum::toLower (std::string str)
	Returns the lowercase version of str. More...

Typedef Documentation

◆ forbidden_type

template<typename T1 , typename T2 >

using gum::forbidden_type = typedef typename std::enable_if< !std::is_same< T1, T2 >::value, int >::type

Forbidden_type<T1,T2> return the "int" type if T1 and T2 are of the same type, else nothing.

Use it as a guard in template specification :

// Creates a template except if T is int or char

template<T,forbidden_type<T,int> =0,forbidden_type<T,char> =0> // ...

Parameters

T1	The type to test for.
T2	The expected type.

Definition at line 123 of file utils_misc.h.

Function Documentation

◆ _atexit_()

void gum::_atexit_ ( )

Used for debug purpose.

Definition at line 47 of file utils_misc.cpp.

                   {
 #ifdef GUM_DEBUG_MODE
     gum::__debug__::_atexit_();
 #endif
   }

◆ endsWith()

bool gum::endsWith	(	std::string const &	value,
		std::string const &	ending
	)

Returns true if value ends with ending.

Returns: Returns true if value ends with ending.

Definition at line 49 of file utils_string.cpp.

                                                                  {
     if (ending.size() > value.size()) return false;
     return std::equal(ending.rbegin(), ending.rend(), value.rbegin());
   }

◆ getRandomGenerator()

std::default_random_engine gum::getRandomGenerator ( unsigned int seed )

define a random_engine with correct seed

Definition at line 47 of file utils_random.cpp.

                                                                  {
     std::default_random_engine generator;
     generator.seed(seed ? seed : randomGeneratorSeed());
     return generator;
   }

◆ getUniqueFileName()

std::string gum::getUniqueFileName ( )

Returns a path to a unique file name.

Returns: Returns a path to a unique file name.

Definition at line 36 of file utils_string.cpp.

                                 {
 #ifdef HAVE_MKSTEMP
     char tmpFileName_[] = "fileXXXXXX";
     int  fd             = mkstemp(tmpFileName_);
     close(fd);
 #else   // mainly Windows
     char tmpFileName_[] = "fileXXXXXX";
     _mktemp_s(tmpFileName_, strlen(tmpFileName_));
 #endif
 
     return std::string(tmpFileName_);
   }

◆ hasUniqueElts()

template<typename T >

bool std::hasUniqueElts ( std::vector< T > const & x )

check if a vector consists in unique values (no duplicate).

Template Parameters

T	The vector's elements type.

Parameters

x	the vector

Returns: Returns true if the vector has no duplicate.

Definition at line 87 of file utils_misc_tpl.h.

                                               {
     if (x.size() <= 1) return true;
     if (x.size() == 2) return x[0] != x[1];
 
     auto refless = [](T const* l, T const* r) {
       return *l < *r;
     };
     auto refeq = [](T const* l, T const* r) {
       return *l == *r;
     };
 
     std::vector< T const* > vp;
     vp.reserve(x.size());
     for (size_t i = 0; i < x.size(); ++i)
       vp.push_back(&x[i]);
     sort(vp.begin(), vp.end(), refless);   // O(N log N)
     // if no adjacent pair (vp_n,vp_n+1) has *vp_n == *vp_n+1
     return std::adjacent_find(vp.begin(), vp.end(), refeq) == vp.end();
   }

◆ initRandom()

INLINE void gum::initRandom ( unsigned int seed = 0 )

Initialize random generator seed.

Definition at line 40 of file utils_random_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                      {
     if (seed) {
       srand(seed);
     } else {
       srand(randomGeneratorSeed());
     }
   }

Here is the call graph for this function:

◆ Memcmp()

bool gum::Memcmp	(	const void *const	in_,
		const void *const	out_,
		unsigned long	size
	)

Cross-platform replacement for memcmp.

Parameters

in_	A pointer to the block of memory to copy.
out_	A pointer to the block of memory receiving copy.
size	Number of bytes to copy.

Returns: Returns true if OK.

Definition at line 37 of file utils_misc.cpp.

                                                                                  {
     unsigned char* in  = (unsigned char*)in_;
     unsigned char* out = (unsigned char*)out_;
 
     for (unsigned long i = 0; i < size; ++i)
       if (*(in++) != *(out++)) return false;
 
     return true;
   }

◆ operator<<() [1/3]

template<typename T1 , typename T2 >

ostream & std::operator<<	(	ostream &	stream,
		const pair< T1, T2 > &	val
	)

'std::cout<<' operator for pairs.

Template Parameters

T1	The pair's first's type.
T2	The pair's second's type.

Parameters

stream	The stream to print to.
val	The pair to print to stream.

Returns: Returns stream.

Definition at line 58 of file utils_misc_tpl.h.

                                                                   {
     stream << "(" << val.first << "," << val.second << ")";
     return stream;
   }

◆ operator<<() [2/3]

template<typename T0 , typename... T>

std::ostream & std::operator<<	(	std::ostream &	os,
		const std::tuple< T0, T... > &	t
	)

'std::cout<<' operator for vectors.

Parameters

stream The stream to print to.

Template Parameters

t	The std::tuple

Parameters

val	The std::vector to print to stream.

Returns: Returns stream.

Definition at line 79 of file utils_misc_tpl.h.

                                                                         {
     char quote = (std::is_convertible< T0, std::string >::value) ? '"' : 0;
     os << '(' << quote << std::get< 0 >(t) << quote;
     _auxiliary_print_tuple_< 1 >::print(os, t);
     return os << ')';
   }

◆ operator<<() [3/3]

template<typename T >

ostream & std::operator<<	(	ostream &	stream,
		const vector< T > &	val
	)

'std::cout<<' operator for vectors.

Template Parameters

T	The vector's elements type.

Parameters

stream	The stream to print to.
val	The std::vector to print to stream.

Returns: Returns stream.

Definition at line 40 of file utils_misc_tpl.h.

                                                                {
     bool deja = false;
     stream << "[";
 
     for (const auto& v: val) {
       if (deja)
         stream << " , ";
       else
         deja = true;
       stream << v;
     }
 
     stream << "]";
 
     return stream;
   }

◆ randomDistribution()

template<typename GUM_SCALAR >

std::vector< GUM_SCALAR > gum::randomDistribution ( Size n )

Return a random discrete distribution.

Parameters

n	The number of modalities for the ditribution.

Returns: Return a random discrete distribution.

Template Parameters

GUM_SCALAR The type used for representing probabilities.

Definition at line 34 of file utils_random_tpl.h.

                                                      {
     if (n < 2) n = 2;
 
     std::vector< GUM_SCALAR > v(n);
     GUM_SCALAR                s;
 
     do {
       for (Idx i = 0; i < n; i++) {
         v[i] = (GUM_SCALAR)randomProba();
       }
 
       s = std::accumulate(v.begin(), v.end(), (GUM_SCALAR)0.0);
 
     } while (s < (GUM_SCALAR)(1e-5));
 
     for (Idx i = 0; i < n; i++) {
       v[i] /= s;
     }
 
     return v;
   }

◆ randomGeneratorSeed()

unsigned int gum::randomGeneratorSeed ( )

Returns the aGrUM's seed used by the std::generators.

Returns: Returns the aGrUM's seed used by the std::generators.

Definition at line 40 of file utils_random.cpp.

                                      {
     return (unsigned int)((GUM_RANDOMSEED == 0)
                              ? std::chrono::system_clock::now().time_since_epoch().count()
                              : GUM_RANDOMSEED);
   }

◆ randomProba()

INLINE double gum::randomProba ( )

Returns a random double between 0 and 1 included (i.e.

a proba).

Returns: Returns a random double between 0 and 1 included (i.e. a proba).

Definition at line 37 of file utils_random_inl.h.

References gum::Set< Key, Alloc >::emplace().

37 { return ((double)rand()) / ((double)RAND_MAX); }

double

Here is the call graph for this function:

◆ randomValue()

INLINE Idx gum::randomValue ( const Size max = 2 )

Returns a random Idx between 0 and max-1 included.

Returns: Returns a random Odxbetween 0 and max-1 included (i.e. a proba). By default, max=2

Definition at line 34 of file utils_random_inl.h.

References gum::Set< Key, Alloc >::emplace().

34 { return (Idx)(rand() % max); }

Idx

Here is the call graph for this function:

◆ replace()

std::string gum::replace	(	const std::string &	s,
		const std::string &	val,
		const std::string &	new_val
	)

not usable for gcc 4.8 std::vector<std::string> split( const std::string& orig, const std::string& delimiter ) {

Replace val by new_val in s.

std::regex rgx( delimiter );

std::sregex_token_iterator first{begin( orig ), end( orig ), rgx, -1}, last;

return {first, last}; }

Parameters

s	A string.
val	The value to replace in s.
new_val	The new value to replace val in s.

Returns: A new string with val replaced by new_val.

Definition at line 78 of file utils_string.cpp.

                                                                                         {
     auto retVal = s;
     auto pos    = retVal.find(val);
     while (pos != std::string::npos) {
       std::stringstream sBuff;
       sBuff << s.substr(0, pos) << new_val << s.substr(pos + val.size(), std::string::npos);
       retVal = sBuff.str();
       pos    = retVal.find(val);
     }
     return retVal;
   }

◆ split()

std::vector< std::string > gum::split	(	const std::string &	orig,
		const std::string &	delimiter
	)

Split str using the delimiter.

Parameters

orig	searched string
delimiter	string

Returns: Vector of splitted strings

Definition at line 54 of file utils_string.cpp.

                                                                              {
     std::vector< std::string > tokens;
     size_t                     prev = 0, pos = 0;
     do {
       pos = str.find(delim, prev);
       if (pos == std::string::npos) pos = str.length();
       std::string token = str.substr(prev, pos - prev);
       if (!token.empty()) tokens.push_back(token);
       prev = pos + delim.length();
     } while (pos < str.length() && prev < str.length());
     return tokens;
   }

◆ toLower()

INLINE std::string gum::toLower ( std::string str )

Returns the lowercase version of str.

Returns: Returns the lowercase version of str.

Definition at line 36 of file utils_string_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                    {
     std::transform(str.begin(), str.end(), str.begin(), ::tolower);
     return str;
   }

Here is the call graph for this function:

Detailed Description

Modules

Classes

Typedef Documentation

◆ forbidden_type

Function Documentation

◆ _atexit_()

◆ endsWith()

◆ getRandomGenerator()

◆ getUniqueFileName()

◆ hasUniqueElts()

◆ initRandom()

◆ Memcmp()

◆ operator<<() [1/3]

◆ operator<<() [2/3]

◆ operator<<() [3/3]

◆ randomDistribution()

◆ randomGeneratorSeed()

◆ randomProba()

◆ randomValue()

◆ replace()

◆ split()

◆ toLower()