kNML_inl.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                           *
 *                                                                          *
 ****************************************************************************/
 
#pragma once
 

 
#include <agrum/base/stattests/kNML.h>   // to ease IDE parser
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
namespace gum {
 
  namespace learning {

    INLINE KNML::KNML(const DBRowGeneratorParser&                                 parser,
                      const Prior&                                                prior,
                      const std::vector< std::pair< std::size_t, std::size_t > >& ranges,
                      const Bijection< NodeId, std::size_t >&                     nodeId2columns) :
        CachedContingencyCounter(parser, prior, ranges, nodeId2columns) {
      GUM_CONSTRUCTOR(KNML);
    }

    INLINE KNML::KNML(const DBRowGeneratorParser&             parser,
                      const Prior&                            prior,
                      const Bijection< NodeId, std::size_t >& nodeId2columns) :
        CachedContingencyCounter(parser, prior, nodeId2columns) {
      GUM_CONSTRUCTOR(KNML);
    }

    INLINE KNML::KNML(const KNML& from) :
        CachedContingencyCounter(from), _param_complexity_(from._param_complexity_) {
      GUM_CONS_CPY(KNML);
    }

    INLINE KNML::KNML(KNML&& from) :
        CachedContingencyCounter(std::move(from)),
        _param_complexity_(std::move(from._param_complexity_)) {
      GUM_CONS_MOV(KNML);
    }

    INLINE KNML* KNML::clone() const { return new KNML(*this); }

    INLINE KNML::~KNML() { GUM_DESTRUCTOR(KNML); }
 
    INLINE double KNML::score(const NodeId var1, const NodeId var2) {
      IdCondSet idset(var1, var2, empty_ids_, false, true);
      if (use_cache_) {
        if (auto p = cache_.tryGet(idset)) { return *p; }
        double s = _score_(idset);
        cache_.insert(std::move(idset), s);
        return s;
      } else {
        return _score_(std::move(idset));
      }
    }
 
    INLINE double
        KNML::score(const NodeId var1, const NodeId var2, const std::vector< NodeId >& rhs_ids) {
      IdCondSet idset(var1, var2, rhs_ids, false, false);
      if (use_cache_) {
        if (auto p = cache_.tryGet(idset)) { return *p; }
        double s = _score_(idset);
        cache_.insert(std::move(idset), s);
        return s;
      } else {
        return _score_(idset);
      }
    }
 
 
  } /* namespace learning */
 
} /* namespace gum */
 
#endif /* DOXYGEN_SHOULD_SKIP_THIS */