include/dai/util.h

   1 /*  This file is part of libDAI - http://www.libdai.org/
   2  *
   3  *  libDAI is licensed under the terms of the GNU General Public License version
   4  *  2, or (at your option) any later version. libDAI is distributed without any
   5  *  warranty. See the file COPYING for more details.
   6  *
   7  *  Copyright (C) 2006-2009  Joris Mooij  [joris dot mooij at libdai dot org]
   8  *  Copyright (C) 2006-2007  Radboud University Nijmegen, The Netherlands
   9  */
  10
  11
  12 /// \file
  13 /// \brief Defines general utility functions and adds an abstraction layer for platform-dependent functionality
  14 /// \todo Improve documentation
  15
  16
  17 #ifndef __defined_libdai_util_h
  18 #define __defined_libdai_util_h
  19
  20
  21 #include <string>
  22 #include <vector>
  23 #include <set>
  24 #include <map>
  25 #include <iostream>
  26 #include <boost/foreach.hpp>
  27 #include <boost/functional/hash.hpp>
  28 #include <algorithm>
  29
  30
  31 #if defined(WINDOWS)
  32     #include <map>
  33 #elif defined(CYGWIN)
  34     #include <boost/tr1/unordered_map.hpp>
  35 #else
  36     #include <tr1/unordered_map>
  37 #endif
  38
  39
  40 /// An alias to the BOOST_FOREACH macro from the boost::foreach library
  41 #define foreach BOOST_FOREACH
  42
  43 #ifdef DAI_DEBUG
  44 /// \brief "Print variable". Prints the text of an expression, followed by its value (only if DAI_DEBUG is defined)
  45 /**
  46  *  Useful debugging macro to see what your code is doing.
  47  *  Example: \code DAI_PV(3+4) \endcode
  48  *  Output: \code 3+4= 7 \endcode
  49  */
  50 #define DAI_PV(x) do {std::cerr << #x "= " << (x) << std::endl;} while(0)
  51 /// "Debugging message": Prints a message (only if DAI_DEBUG is defined)
  52 #define DAI_DMSG(str) do {std::cerr << str << std::endl;} while(0)
  53 /// Assertion if DAI_DEBUG is defined
  54 #define DAI_DEBASSERT(x) do {assert(x);} while(0)
  55 #else
  56 #define DAI_PV(x) do {} while(0)
  57 #define DAI_DMSG(str) do {} while(0)
  58 #define DAI_DEBASSERT(X) do {} while(0)
  59 #endif
  60
  61 /// Produces accessor and mutator methods according to the common pattern.
  62 /** Example:
  63  *  \code DAI_ACCMUT(size_t& maxIter(), { return props.maxiter; }); \endcode
  64  *  \todo At the moment, only the mutator appears in doxygen documentation.
  65  */
  66 #define DAI_ACCMUT(x,y)                     \
  67       x y;                                  \
  68       const x const y;
  69
  70 /// Macro to give error message \a stmt if props.verbose>=\a n
  71 #define DAI_IFVERB(n, stmt) if(props.verbose>=n) { cerr << stmt; }
  72
  73
  74 /// Real number (alias for double, which could be changed to long double if necessary)
  75 typedef double Real;
  76
  77
  78 #ifdef WINDOWS
  79     /// Returns true if argument is NAN (Not A Number)
  80     bool isnan( double x );
  81
  82     /// Returns inverse hyperbolic tangent of argument
  83     double atanh( double x );
  84
  85     /// Returns log(1+x)
  86     double log1p( double x );
  87
  88     /// Define INFINITY
  89     #define INFINITY (std::numeric_limits<double>::infinity())
  90 #endif
  91
  92
  93 namespace dai {
  94
  95
  96 #ifdef WINDOWS
  97     /// hash_map is an alias for std::map.
  98     /** Since there is no TR1 unordered_map implementation available yet, we fall back on std::map.
  99      */
 100     template <typename T, typename U, typename H = boost::hash<T> >
 101         class hash_map : public std::map<T,U> {};
 102 #else
 103     /// hash_map is an alias for std::tr1::unordered_map.
 104     /** We use the (experimental) TR1 unordered_map implementation included in modern GCC distributions.
 105      */
 106     template <typename T, typename U, typename H = boost::hash<T> >
 107         class hash_map : public std::tr1::unordered_map<T,U,H> {};
 108 #endif
 109
 110
 111 /// Returns wall clock time in seconds
 112 double toc();
 113
 114
 115 /// Sets the random seed
 116 void rnd_seed( size_t seed );
 117
 118 /// Returns a real number, distributed uniformly on [0,1)
 119 double rnd_uniform();
 120
 121 /// Returns a real number from a standard-normal distribution
 122 double rnd_stdnormal();
 123
 124 /// Returns a random integer in interval [min, max]
 125 int rnd_int( int min, int max );
 126
 127 /// Returns a random integer in the half-open interval \f$[0,n)\f$
 128 inline int rnd( int n) {
 129     return rnd_int( 0, n-1 );
 130 }
 131
 132
 133 /// Writes a std::vector to a std::ostream
 134 template<class T>
 135 std::ostream& operator << (std::ostream& os, const std::vector<T> & x) {
 136     os << "(";
 137     for( typename std::vector<T>::const_iterator it = x.begin(); it != x.end(); it++ )
 138         os << (it != x.begin() ? ", " : "") << *it;
 139     os << ")";
 140     return os;
 141 }
 142
 143 /// Writes a std::set to a std::ostream
 144 template<class T>
 145 std::ostream& operator << (std::ostream& os, const std::set<T> & x) {
 146     os << "{";
 147    for( typename std::set<T>::const_iterator it = x.begin(); it != x.end(); it++ )
 148         os << (it != x.begin() ? ", " : "") << *it;
 149     os << "}";
 150     return os;
 151 }
 152
 153 /// Writes a std::map to a std::ostream
 154 template<class T1, class T2>
 155 std::ostream& operator << (std::ostream& os, const std::map<T1,T2> & x) {
 156     os << "{";
 157     for( typename std::map<T1,T2>::const_iterator it = x.begin(); it != x.end(); it++ )
 158         os << (it != x.begin() ? ", " : "") << it->first << "->" << it->second;
 159     os << "}";
 160     return os;
 161 }
 162
 163 /// Writes a std::pair to a std::ostream
 164 template<class T1, class T2>
 165 std::ostream& operator << (std::ostream& os, const std::pair<T1,T2> & x) {
 166     os << "(" << x.first << ", " << x.second << ")";
 167     return os;
 168 }
 169
 170 /// Concatenate two vectors
 171 template<class T>
 172 std::vector<T> concat( const std::vector<T>& u, const std::vector<T>& v ) {
 173     std::vector<T> w;
 174     w.reserve( u.size() + v.size() );
 175     for( size_t i = 0; i < u.size(); i++ )
 176         w.push_back( u[i] );
 177     for( size_t i = 0; i < v.size(); i++ )
 178         w.push_back( v[i] );
 179     return w;
 180 }
 181
 182 /// Split a string into tokens
 183 void tokenizeString( const std::string& s, std::vector<std::string>& outTokens, const std::string& delim="\t\n" );
 184
 185 /// Used to keep track of the progress made by iterative algorithms
 186 class Diffs : public std::vector<double> {
 187     private:
 188         size_t _maxsize;
 189         double _def;
 190         std::vector<double>::iterator _pos;
 191         std::vector<double>::iterator _maxpos;
 192     public:
 193         /// Constructor
 194         Diffs(long maxsize, double def) : std::vector<double>(), _maxsize(maxsize), _def(def) {
 195             this->reserve(_maxsize);
 196             _pos = begin();
 197             _maxpos = begin();
 198         }
 199         /// Returns maximum difference encountered
 200         double maxDiff() {
 201             if( size() < _maxsize )
 202                 return _def;
 203             else
 204                 return( *_maxpos );
 205         }
 206         /// Register new difference x
 207         void push(double x) {
 208             if( size() < _maxsize ) {
 209                 push_back(x);
 210                 _pos = end();
 211                 if( size() > 1 ) {
 212                     if( *_maxpos < back() ) {
 213                         _maxpos = end();
 214                         _maxpos--;
 215                     }
 216                 } else {
 217                     _maxpos = begin();
 218                 }
 219             } else {
 220                 if( _pos == end() )
 221                     _pos = begin();
 222                 if( _maxpos == _pos ) {
 223                     *_pos++ = x;
 224                     _maxpos = max_element(begin(),end());
 225                 } else {
 226                     if( x > *_maxpos )
 227                         _maxpos = _pos;
 228                     *_pos++ = x;
 229                 }
 230             }
 231         }
 232         /// Return maximum number of differences stored
 233         size_t maxSize() { return _maxsize; }
 234 };
 235
 236
 237 } // end of namespace dai
 238
 239
 240 #endif