prior.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_LEARNING_PRIOR_H
#define GUM_LEARNING_PRIOR_H
 
#include <string>
#include <vector>
 
#include <agrum/agrum.h>
 
#include <agrum/base/database/databaseTable.h>
#include <agrum/base/stattests/idCondSet.h>
 
namespace gum::learning {
  enum class PriorType : uint8_t {
    DirichletPriorType,
    SmoothingPriorType,
    NoPriorType,
    BDeuPriorType,
  };
 
  // constexpr requires the full definition to be visible in every TU that
  // evaluates it at compile time, so -- unlike an ordinary INLINE method --
  // this cannot be moved to prior_inl.h behind the GUM_NO_INLINE toggle.
  constexpr const char* priorTypeToString(PriorType e) noexcept {
    switch (e) {
      case PriorType::NoPriorType : return "No prior";
      case PriorType::DirichletPriorType : return "Dirichlet prior";
      case PriorType::SmoothingPriorType : return "TriSmoothing prior";
      case PriorType::BDeuPriorType : return "BDeu prior";
    }
    return "Error in prior";
  }

  class GUM_SHARED_PUBLIC Prior {
    public:
    // ##########################################################################
    // ##########################################################################


    explicit Prior(const DatabaseTable&                    database,
                   const Bijection< NodeId, std::size_t >& nodeId2columns
                   = Bijection< NodeId, std::size_t >());

    [[nodiscard]] virtual Prior* clone() const = 0;

    virtual ~Prior();

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

    virtual void setWeight(double weight);

    double weight() const;

    virtual PriorType getType() const = 0;


    virtual bool isInformative() const = 0;


    virtual void addJointPseudoCount(const IdCondSet& idset, std::vector< double >& counts) = 0;

    virtual void addConditioningPseudoCount(const IdCondSet& idset, std::vector< double >& counts)
        = 0;

 
 
    protected:
    double weight_{1.0};

    const DatabaseTable* database_;

    Bijection< NodeId, std::size_t > nodeId2columns_;
 

    Prior(const Prior& from);

    Prior(Prior&& from) noexcept;

    Prior& operator=(const Prior& from);

    Prior& operator=(Prior&& from) noexcept;
  };
 
} /* namespace gum::learning */
 
// include the inlined functions if necessary
#ifndef GUM_NO_INLINE
#  include <agrum/base/stattests/priors/prior_inl.h>
#endif   // GUM_NO_INLINE
 
#endif   /* GUM_LEARNING_PRIOR_H */