variableLog2ParamComplexity.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2026 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-2026                            *
 *       - 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_VARIABLE_LOG2_PARAM_COMPLEXITY_H
#define GUM_VARIABLE_LOG2_PARAM_COMPLEXITY_H
 
#include <cstddef>
#include <fstream>
#include <string>
 
#include <agrum/agrum.h>
 
#include <agrum/base/core/hashTable.h>
 
#include <agrum/base/core/math/math_utils.h>
#include <string_view>
 
namespace gum {
 
 
  // the CTable cache for log2(C_n^r), with n in {0,...,999} and r in {2,3,4,5}
  extern const double VariableLog2ParamComplexityCTable[4][1000];
 
  // the size in r of the CTable cache
  constexpr std::size_t VariableLog2ParamComplexityCTableRSize{std::size_t(4)};
 
  // the size in n of the CTable cache
  constexpr std::size_t VariableLog2ParamComplexityCTableNSize{std::size_t(1000)};

  class GUM_SHARED_PUBLIC VariableLog2ParamComplexity {
    public:
    // ########################################################################
    // ########################################################################

    VariableLog2ParamComplexity();

    VariableLog2ParamComplexity(const VariableLog2ParamComplexity& from);

    VariableLog2ParamComplexity(VariableLog2ParamComplexity&& from);

    [[nodiscard]] virtual VariableLog2ParamComplexity* clone() const;

    virtual ~VariableLog2ParamComplexity();

 
 
    // ########################################################################
    // ########################################################################

    VariableLog2ParamComplexity& operator=(const VariableLog2ParamComplexity& from);

    VariableLog2ParamComplexity& operator=(VariableLog2ParamComplexity&& from);

 
 
    // ########################################################################
    // ########################################################################

    double log2Cnr(const std::size_t r, const double n);

    void CnrToFile(std::string_view filename);

    void useCache(const bool on_off);

    void clearCache();

 
    private:
    // const double _Szpankowski_threshold_{VariableLog2ParamComplexityCTableNSize};
 
    // constants used to speed-up the computation of the Szpankowski
    // approximation.
    // The formula for the approximation given in Silander, Roos,
    // Kontkanen and Myllymaki (2007) "Factorized Normalized Maximum "
    // Likelihood Criterion for Learning Bayesian network Structures" paper
    // is incorrect. However, the one in Kontkanen, Buntine, Myllymaki,
    // Rissanen and Tirri (2003) "Efficient Computation of Stochastic
    // Complexity" is correct. So we use the latter and simplify it. Thus,
    // the approximation of log2(Cnr) is equal to:
    // 0.5 log2(n) - 0.5 + log2(sqrt(pi)) + (sqrt(2/pi)/3) / sqrt(n) +
    // (3/36 - 4/(9*pi)) / n.
    // So, given the constants below, it is equal to:
    // 0.5 * std::log2 (n) +  _cst1_ +  _cst2_ / std::sqrt(n) +  _cst3_ / n
    const double _cst1_ = -0.5 + std::log2(std::sqrt(M_PI));
    const double _cst2_ = std::sqrt(2.0 / M_PI) / 3.0;
    const double _cst3_ = 3.0 / 36.0 - 4.0 / (9.0 * M_PI);
 
    // indicates whether we should use a cache or not
    bool _use_cache_{true};
 
    // the cache used, eventually, to store the log2Cnr values
    HashTable< std::pair< std::size_t, double >, double > _cache_;
  };
 
} /* namespace gum */
 
 
#ifndef GUM_NO_INLINE
#  include <agrum/base/core/math/variableLog2ParamComplexity_inl.h>
#endif   // GUM_NO_INLINE
 
#endif   /* GUM_VARIABLE_LOG2_PARAM_COMPLEXITY_H */