Fixed division-by-zero issue in pow() which caused problems for GLC+ with sparse...
[libdai.git] / include / dai / util.h
index 458084d..dba4002 100644 (file)
@@ -1,17 +1,13 @@
 /*  This file is part of libDAI - http://www.libdai.org/
  *
- *  libDAI is licensed under the terms of the GNU General Public License version
- *  2, or (at your option) any later version. libDAI is distributed without any
- *  warranty. See the file COPYING for more details.
+ *  Copyright (c) 2006-2011, The libDAI authors. All rights reserved.
  *
- *  Copyright (C) 2006-2009  Joris Mooij  [joris dot mooij at libdai dot org]
- *  Copyright (C) 2006-2007  Radboud University Nijmegen, The Netherlands
+ *  Use of this source code is governed by a BSD-style license that can be found in the LICENSE file.
  */
 
 
 /// \file
 /// \brief Defines general utility functions and adds an abstraction layer for platform-dependent functionality
-/// \todo Improve documentation
 
 
 #ifndef __defined_libdai_util_h
 #include <iostream>
 #include <boost/foreach.hpp>
 #include <boost/functional/hash.hpp>
+#include <boost/lexical_cast.hpp>
 #include <algorithm>
+#include <cerrno>
+
+#if defined(WINDOWS)
+#include <cstdint> // only defined in C++11 and higher, but needed for Win64 builds in order to enable conditional code in MPIR library
+#endif
+#include <gmpxx.h>
+
+#include <dai/exceptions.h>
 
 
 #if defined(WINDOWS)
-    #include <map>
+    #include <boost/tr1/unordered_map.hpp> // only present in boost 1.37 and higher
 #elif defined(CYGWIN)
-    #include <boost/tr1/unordered_map.hpp>
+    #include <boost/tr1/unordered_map.hpp> // only present in boost 1.37 and higher
+#elif defined(MACOSX)
+    #include <boost/tr1/unordered_map.hpp> // only present in boost 1.37 and higher
 #else
-    #include <tr1/unordered_map>
+    #include <tr1/unordered_map> // only present in modern GCC distributions
 #endif
 
 
-/// An alias to the BOOST_FOREACH macro from the boost::foreach library
-#define foreach BOOST_FOREACH
+/// An alias to the BOOST_FOREACH macro from the boost::bforeach library
+#define bforeach BOOST_FOREACH
 
 #ifdef DAI_DEBUG
 /// \brief "Print variable". Prints the text of an expression, followed by its value (only if DAI_DEBUG is defined)
 #define DAI_DMSG(str) do {} while(0)
 #endif
 
-/// Produces accessor and mutator methods according to the common pattern.
-/** Example:
- *  \code DAI_ACCMUT(size_t& maxIter(), { return props.maxiter; }); \endcode
- *  \todo At the moment, only the mutator appears in doxygen documentation.
- */
-#define DAI_ACCMUT(x,y)                     \
-      x y;                                  \
-      const x const y;
-
-/// Macro to give error message \a stmt if props.verbose>=\a n
-#define DAI_IFVERB(n, stmt) if(props.verbose>=n) { cerr << stmt; }
+/// Macro to write message \a stmt to \c std::cerr if \a props.verbose >= \a n
+#define DAI_IFVERB(n, stmt) if(props.verbose>=n) { std::cerr << stmt; }
 
 
 #ifdef WINDOWS
-    /// Returns true if argument is NAN (Not A Number)
-    bool isnan( double x );
-
     /// Returns inverse hyperbolic tangent of argument
     double atanh( double x );
 
 
     /// Define INFINITY
     #define INFINITY (std::numeric_limits<Real>::infinity())
+
+    /// Define NAN
+    #define NAN (std::numeric_limits<Real>::quiet_NaN())
+
+    #if defined(_MSC_VER)
+      // Disable unsafe warning (use of the function 'strcpy' instead of 
+      // 'strcpy_s' for portability reasons;
+      #pragma warning( disable : 4996 )
+      // Workaround for the char16_t type defined in Matlab and MSVC 2010
+      #if (_MSC_VER >= 1600)
+        #define __STDC_UTF_16__
+      #endif
+    #endif
 #endif
 
 
 namespace dai {
 
 
-/// Real number (alias for double, which could be changed to long double if necessary)
+/// Real number (alias for \c double, which could be changed to <tt>long double</tt> if necessary)
 typedef double Real;
 
+/// Arbitrary precision integer number
+typedef mpz_class BigInt;
+
+/// Safe down-cast of big integer to size_t
+inline size_t BigInt_size_t( const BigInt &N ) {
+    DAI_ASSERT( N <= (BigInt)std::numeric_limits<std::size_t>::max() );
+    return N.get_ui();
+}
+
+/// Returns true if argument is NAN (Not A Number)
+bool isnan( Real x );
+
 /// Returns logarithm of \a x
 inline Real log( Real x ) {
     return std::log(x);
@@ -104,20 +124,26 @@ inline Real exp( Real x ) {
     return std::exp(x);
 }
 
+/// Returns \a x to the power \a y
+/** We use the convention that division by zero yields zero;
+ *  for powers, this means that if \a x == 0.0 and \a y < 0.0, we 
+ *  return 0.0 instead of generating an error.
+ */
+inline Real pow( Real x, Real y ) {
+    errno = 0;
+    if( x == 0.0 && y < 0.0 )
+        return 0.0;
+    Real result = std::pow(x, y);
+    DAI_DEBASSERT( errno == 0 );
+    return result;
+}
 
-#ifdef WINDOWS
-    /// hash_map is an alias for std::map.
-    /** Since there is no TR1 unordered_map implementation available yet, we fall back on std::map.
-     */
-    template <typename T, typename U, typename H = boost::hash<T> >
-        class hash_map : public std::map<T,U> {};
-#else
-    /// hash_map is an alias for std::tr1::unordered_map.
-    /** We use the (experimental) TR1 unordered_map implementation included in modern GCC distributions.
-     */
-    template <typename T, typename U, typename H = boost::hash<T> >
-        class hash_map : public std::tr1::unordered_map<T,U,H> {};
-#endif
+
+/// hash_map is an alias for \c std::tr1::unordered_map.
+/** We use the (experimental) TR1 unordered_map implementation included in modern GCC distributions or in boost versions 1.37 and higher.
+ */
+template <typename T, typename U, typename H = boost::hash<T> >
+    class hash_map : public std::tr1::unordered_map<T,U,H> {};
 
 
 /// Returns wall clock time in seconds
@@ -140,16 +166,30 @@ Real rnd_uniform();
 /// Returns a real number from a standard-normal distribution
 Real rnd_stdnormal();
 
-/// Returns a random integer in interval [min, max]
+/// Returns a random integer in interval [\a min, \a max]
 int rnd_int( int min, int max );
 
-/// Returns a random integer in the half-open interval \f$[0,n)\f$
-inline int rnd( int n) {
+/// Returns a random integer in the half-open interval [0, \a n)
+inline int rnd( int n ) {
     return rnd_int( 0, n-1 );
 }
 
 
-/// Writes a std::vector to a std::ostream
+/// Converts a variable of type \a T to a \c std::string by using a \c boost::lexical_cast
+template<class T>
+std::string toString( const T& x ) {
+    return boost::lexical_cast<std::string>(x);
+}
+
+
+/// Converts a variable of type std::string to \a T by using a \c boost::lexical_cast
+template<class T>
+T fromString( const std::string& x ) {
+    return boost::lexical_cast<T>(x);
+}
+
+
+/// Writes a \c std::vector<> to a \c std::ostream
 template<class T>
 std::ostream& operator << (std::ostream& os, const std::vector<T> & x) {
     os << "(";
@@ -159,7 +199,7 @@ std::ostream& operator << (std::ostream& os, const std::vector<T> & x) {
     return os;
 }
 
-/// Writes a std::set to a std::ostream
+/// Writes a \c std::set<> to a \c std::ostream
 template<class T>
 std::ostream& operator << (std::ostream& os, const std::set<T> & x) {
     os << "{";
@@ -169,7 +209,7 @@ std::ostream& operator << (std::ostream& os, const std::set<T> & x) {
     return os;
 }
 
-/// Writes a std::map to a std::ostream
+/// Writes a \c std::map<> to a \c std::ostream
 template<class T1, class T2>
 std::ostream& operator << (std::ostream& os, const std::map<T1,T2> & x) {
     os << "{";
@@ -179,14 +219,14 @@ std::ostream& operator << (std::ostream& os, const std::map<T1,T2> & x) {
     return os;
 }
 
-/// Writes a std::pair to a std::ostream
+/// Writes a \c std::pair<> to a \c std::ostream
 template<class T1, class T2>
 std::ostream& operator << (std::ostream& os, const std::pair<T1,T2> & x) {
     os << "(" << x.first << ", " << x.second << ")";
     return os;
 }
 
-/// Concatenate two vectors
+/// Concatenates two vectors
 template<class T>
 std::vector<T> concat( const std::vector<T>& u, const std::vector<T>& v ) {
     std::vector<T> w;
@@ -198,59 +238,31 @@ std::vector<T> concat( const std::vector<T>& u, const std::vector<T>& v ) {
     return w;
 }
 
-/// Split a string into tokens
-void tokenizeString( const std::string& s, std::vector<std::string>& outTokens, const std::string& delim="\t\n" );
-
-/// Used to keep track of the progress made by iterative algorithms
-class Diffs : public std::vector<Real> {
-    private:
-        size_t _maxsize;
-        Real _def;
-        std::vector<Real>::iterator _pos;
-        std::vector<Real>::iterator _maxpos;
-    public:
-        /// Constructor
-        Diffs(long maxsize, Real def) : std::vector<Real>(), _maxsize(maxsize), _def(def) {
-            this->reserve(_maxsize);
-            _pos = begin();
-            _maxpos = begin();
-        }
-        /// Returns maximum difference encountered
-        Real maxDiff() {
-            if( size() < _maxsize )
-                return _def;
-            else
-                return( *_maxpos );
-        }
-        /// Register new difference x
-        void push(Real x) {
-            if( size() < _maxsize ) {
-                push_back(x);
-                _pos = end();
-                if( size() > 1 ) {
-                    if( *_maxpos < back() ) {
-                        _maxpos = end();
-                        _maxpos--;
-                    }
-                } else {
-                    _maxpos = begin();
-                }
-            } else {
-                if( _pos == end() )
-                    _pos = begin();
-                if( _maxpos == _pos ) {
-                    *_pos++ = x;
-                    _maxpos = max_element(begin(),end());
-                } else {
-                    if( x > *_maxpos )
-                        _maxpos = _pos;
-                    *_pos++ = x;
-                }
-            }
-        }
-        /// Return maximum number of differences stored
-        size_t maxSize() { return _maxsize; }
-};
+/// Split a string into tokens delimited by one of the characters in \a delim
+/** \param s the string to be split into tokens
+ *  \param singleDelim if \c true, any single delimiter forms a boundary between two tokens; 
+ *         if \c false, a maximal group of consecutive delimiters forms a boundary between two tokens
+ *  \param delim delimiter characters
+ */
+std::vector<std::string> tokenizeString( const std::string& s, bool singleDelim, const std::string& delim="\t\n" );
+
+
+/// Enumerates different ways of normalizing a probability measure.
+/**
+ *  - NORMPROB means that the sum of all entries should be 1;
+ *  - NORMLINF means that the maximum absolute value of all entries should be 1.
+ */
+typedef enum { NORMPROB, NORMLINF } ProbNormType;
+
+/// Enumerates different distance measures between probability measures.
+/**
+ *  - DISTL1 is the \f$\ell_1\f$ distance (sum of absolute values of pointwise difference);
+ *  - DISTLINF is the \f$\ell_\infty\f$ distance (maximum absolute value of pointwise difference);
+ *  - DISTTV is the total variation distance (half of the \f$\ell_1\f$ distance);
+ *  - DISTKL is the Kullback-Leibler distance (\f$\sum_i p_i (\log p_i - \log q_i)\f$).
+ *  - DISTHEL is the Hellinger distance (\f$\frac{1}{2}\sum_i (\sqrt{p_i}-\sqrt{q_i})^2\f$).
+ */
+typedef enum { DISTL1, DISTLINF, DISTTV, DISTKL, DISTHEL } ProbDistType;
 
 
 } // end of namespace dai