utils_misc.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2025 by                                             *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *                                                                          *
 *   The aGrUM/pyAgrum library is free software; you can redistribute it    *
 *   and/or modify it under the terms of either :                           *
 *                                                                          *
 *    - the GNU Lesser General Public License as published by               *
 *      the Free Software Foundation, either version 3 of the License,      *
 *      or (at your option) any later version,                              *
 *    - the MIT license (MIT),                                              *
 *    - or both in dual license, as here.                                   *
 *                                                                          *
 *   (see https://agrum.gitlab.io/articles/dual-licenses-lgplv3mit.html)    *
 *                                                                          *
 *   This aGrUM/pyAgrum library is distributed in the hope that it will be  *
 *   useful, but WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,          *
 *   INCLUDING BUT NOT LIMITED TO THE WARRANTIES MERCHANTABILITY or FITNESS *
 *   FOR A PARTICULAR PURPOSE  AND NONINFRINGEMENT. IN NO EVENT SHALL THE   *
 *   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
 *   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,        *
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR  *
 *   OTHER DEALINGS IN THE SOFTWARE.                                        *
 *                                                                          *
 *   See LICENCES for more details.                                         *
 *                                                                          *
 *   SPDX-FileCopyrightText: Copyright 2005-2025                            *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *   SPDX-License-Identifier: LGPL-3.0-or-later OR MIT                      *
 *                                                                          *
 *   Contact  : info_at_agrum_dot_org                                       *
 *   homepage : http://agrum.gitlab.io                                      *
 *   gitlab   : https://gitlab.com/agrumery/agrum                           *
 *                                                                          *
 ****************************************************************************/
 

 
#ifndef GUM_UTILS_H
#define GUM_UTILS_H
 
#include <cstdlib>
#include <iostream>
#include <numeric>
#include <string>
#include <tuple>
#include <utility>
#include <vector>
 
#include <type_traits>
 
 
#ifdef GUM_DEBUG_MODE
#  define GUM_CAST dynamic_cast
#else
#  define GUM_CAST static_cast
#endif   // GUM_DEBUG_MODE
 
#include <agrum/agrum.h>
 
#include <agrum/base/core/utils_random.h>
#include <agrum/base/core/utils_string.h>
 
namespace std {


  template < typename T1, typename T2 >
  ostream& operator<<(ostream& stream, const pair< T1, T2 >& val);

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

  template < typename T >
  ostream& operator<<(ostream& stream, const vector< T >& val);

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

 
} /* namespace std */
 
namespace gum {


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

  struct NullStream: std::ostream {
    NullStream() : std::ios(0), std::ostream(0) {}
  };

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

  void _atexit_();

  template < typename T >
  struct AlmostDifferent {
    bool operator()(const T& t1, const T& t2) {
      if (t1 == t2) return false;
      else if (t1 == 0) return (std::abs(t2) > 1e-5);
      else return (std::abs(t2 - t1) / t1 > 1e-5);
    }
  };

  template < typename T >
  struct AlmostDifferent< T* > {
    bool operator()(const T* t1, const T* t2) { return (t1 != t2); }
  };

 
} /* namespace gum */
 
// Always include the template implementations
#include <agrum/base/core/utils_misc_tpl.h>
 
#endif /* GUM_UTILS_H */