bdeuPrior_inl.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                           *
 *                                                                          *
 ****************************************************************************/
#pragma once
 
 
#include <agrum/BN/learning/priors/bdeuPrior.h>
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
namespace gum::learning {

  INLINE BDeuPrior::BDeuPrior(const DatabaseTable&                    database,
                              const Bijection< NodeId, std::size_t >& nodeId2columns) :
      Prior(database, nodeId2columns) {
    GUM_CONSTRUCTOR(BDeuPrior)
  }

  INLINE BDeuPrior::BDeuPrior(const BDeuPrior& from) : Prior(from) { GUM_CONS_CPY(BDeuPrior) }

  INLINE BDeuPrior::BDeuPrior(BDeuPrior&& from) noexcept : Prior(std::move(from)) {
    GUM_CONS_MOV(BDeuPrior)
  }

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

  INLINE BDeuPrior::~BDeuPrior() { GUM_DESTRUCTOR(BDeuPrior) }

  INLINE BDeuPrior& BDeuPrior::operator=(const BDeuPrior& from) {
    Prior::operator=(from);
    return *this;
  }

  INLINE BDeuPrior& BDeuPrior::operator=(BDeuPrior&& from) noexcept {
    Prior::operator=(std::move(from));
    return *this;
  }

  INLINE void BDeuPrior::setWeight(const double weight) {
    if (weight < 0.0) {
      GUM_ERROR(OutOfBounds, "A negative weight (" << weight << ") is forbidden for the BDeu prior")
    }
    this->weight_ = weight;
  }

  INLINE void BDeuPrior::setEffectiveSampleSize(const double weight) { setWeight(weight); }

  INLINE PriorType BDeuPrior::getType() const { return PriorType::BDeuPriorType; }

  INLINE bool BDeuPrior::isInformative() const { return this->weight_ != 0.0; }

  INLINE void BDeuPrior::addJointPseudoCount(const IdCondSet&       idset,
                                             std::vector< double >& counts) {
    // if the idset is empty or the weight is zero, the prior is also empty
    if (idset.empty() || (this->weight_ == 0.0)) return;
 
    // otherwise, add the weight to all the cells in the counting vector
    const double weight = this->weight_ / double(counts.size());
    for (auto& count: counts)
      count += weight;
  }
 
 
}   // namespace gum::learning
 
#endif /* DOXYGEN_SHOULD_SKIP_THIS */