IBayesNetFactory.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_INTERFACE_BAYESNET_FACTORY_H
#define GUM_INTERFACE_BAYESNET_FACTORY_H
 
#include <string>
#include <vector>
 
#include <agrum/base/graphicalModels/variableNodeMap.h>
#include <agrum/base/multidim/implementations/multiDimAdressable.h>
#include <agrum/base/variables/labelizedVariable.h>
 
namespace gum {
  class IBayesNetFactory {
    public:
    enum class factory_state : char {
      NONE,
      NETWORK,
      VARIABLE,
      PARENTS,
      RAW_CPT,
      FACT_CPT,
      FACT_ENTRY
    };
 
    IBayesNetFactory() : _verbose_(false) {};
    // just to make some compilers happy
    virtual ~IBayesNetFactory() {};

    void setVerbose() { _verbose_ = true; };
 
    void resetVerbose() { _verbose_ = false; };
 
    bool isVerbose() { return _verbose_; };


    virtual const DiscreteVariable& varInBN(NodeId id)                        = 0;
    virtual factory_state           state() const                             = 0;
    virtual NodeId                  variableId(const std::string& name) const = 0;
    virtual Size                    cptDomainSize(NodeId n) const             = 0;
 
    virtual void startNetworkDeclaration()                                                     = 0;
    virtual void addNetworkProperty(const std::string& propName, const std::string& propValue) = 0;
    virtual void endNetworkDeclaration()                                                       = 0;
    virtual void startVariableDeclaration()                                                    = 0;
    virtual void variableName(const std::string& name)                                         = 0;
    virtual void variableDescription(const std::string& desc)                                  = 0;
    virtual void variableType(const VarType& type)                                             = 0;
    virtual void addModality(const std::string& name)                                          = 0;
    virtual void addMin(const long& min)                                                       = 0;
    virtual void addMax(const long& max)                                                       = 0;
    virtual void setVariableCPTImplementation(MultiDimAdressable* impl)                        = 0;
    virtual NodeId endVariableDeclaration()                                                    = 0;
    virtual void   startParentsDeclaration(const std::string& var)                             = 0;
    virtual void   addParent(const std::string& var)                                           = 0;
    virtual void   endParentsDeclaration()                                                     = 0;
    virtual void   startRawProbabilityDeclaration(const std::string& var)                      = 0;
    virtual void   rawConditionalTable(const std::vector< std::string >& variables,
                                       const std::vector< float >&       rawTable)
        = 0;
    virtual void rawConditionalTable(const std::vector< float >& rawTable)                 = 0;
    virtual void endRawProbabilityDeclaration()                                            = 0;
    virtual void startFactorizedProbabilityDeclaration(const std::string& var)             = 0;
    virtual void startFactorizedEntry()                                                    = 0;
    virtual void endFactorizedEntry()                                                      = 0;
    virtual void setParentModality(const std::string& parent, const std::string& modality) = 0;
    virtual void setVariableValuesUnchecked(const std::vector< float >& values)            = 0;
    virtual void setVariableValues(const std::vector< float >& values)                     = 0;
    virtual void endFactorizedProbabilityDeclaration()                                     = 0;
    virtual void setVariable(const DiscreteVariable& var)                                  = 0;
    virtual void
        setVariableCPT(const std::string& varName, MultiDimAdressable* table, bool redefineParents)
        = 0;
 
    private:
    bool _verbose_;
  };
} /* namespace gum */
 
#endif   // GUM_ASBTRACT_BAYESNET_FACTORY_H