BayesNetFactory.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_BAYESNET_FACTORY_H
#define GUM_BAYESNET_FACTORY_H
 
#include <string>
#include <vector>
 
#include <agrum/BN/BayesNet.h>
#include <agrum/BN/IBayesNetFactory.h>
 
namespace gum {

  template < typename GUM_SCALAR >
  class BayesNetFactory: public IBayesNetFactory {
    public:
    // ==========================================================================
    // ==========================================================================

    explicit BayesNetFactory(BayesNet< GUM_SCALAR >* bn);

    BayesNetFactory(const BayesNetFactory< GUM_SCALAR >& source);

    virtual ~BayesNetFactory();

    // ==========================================================================
    // ==========================================================================

    BayesNet< GUM_SCALAR >* bayesNet();

    const DiscreteVariable& varInBN(NodeId id) final;

    factory_state state() const final;

    NodeId variableId(const std::string& name) const final;

    const DiscreteVariable& variable(const std::string& name) const;

    Size cptDomainSize(NodeId n) const final;

    // ==========================================================================
    // ==========================================================================

    void startNetworkDeclaration() final;

    void variableType(const VarType& type);

    void addNetworkProperty(const std::string& propName, const std::string& propValue) final;

    void endNetworkDeclaration() final;

    // ==========================================================================
    // ==========================================================================

    void startVariableDeclaration() final;

    void variableName(const std::string& name) final;

    void variableDescription(const std::string& desc) final;

    void addModality(const std::string& name) final;

    void addMin(const long& min);

    void addMax(const long& max);

    void addTick(const GUM_SCALAR& tick);

    void setVariableCPTImplementation(MultiDimAdressable* adressable) final;

    NodeId endVariableDeclaration() final;

    // ==========================================================================
    // ==========================================================================

    void startParentsDeclaration(const std::string& var) final;

    void addParent(const std::string& var) final;

    void endParentsDeclaration() final;

    // ==========================================================================
    // ==========================================================================

    void startRawProbabilityDeclaration(const std::string& var) final;

    void rawConditionalTable(const std::vector< std::string >& variables,
                             const std::vector< float >&       rawTable) final;

    void rawConditionalTable(const std::vector< float >& rawTable) final;

    void endRawProbabilityDeclaration() final;

    // ==========================================================================
    // (NONE -> RAW_CPT)
    // ==========================================================================

    void startFactorizedProbabilityDeclaration(const std::string& var) final;

    void startFactorizedEntry() final;

    void endFactorizedEntry() final;

    void setParentModality(const std::string& parent, const std::string& modality) final;

    void setVariableValuesUnchecked(const std::vector< float >& values) final;

    void setVariableValues(const std::vector< float >& values) final;

    void endFactorizedProbabilityDeclaration() final;

    // ==========================================================================
    // ==========================================================================

    void setVariable(const DiscreteVariable& var) final;

    void setVariableCPT(const std::string&  varName,
                        MultiDimAdressable* table,
                        bool                redefineParents) final;

 
    private:
    // ==========================================================================
    // ==========================================================================

    bool _foo_flag_;

    bool _bar_flag_;

    std::vector< std::string > _stringBag_;

    Instantiation* _parents_;

    MultiDimImplementation< GUM_SCALAR >* _impl_;


    std::vector< factory_state > _states_;

    BayesNet< GUM_SCALAR >* _bn_;

    HashTable< std::string, NodeId > _varNameMap_;

    BayesNetFactory< GUM_SCALAR >& operator=(const BayesNetFactory< GUM_SCALAR >& source) = delete;

    void _illegalStateError_(const std::string& s);

    void _checkVariableName_(const std::string& name) const;

    Idx _checkVariableModality_(const std::string& name, const std::string& mod);

    void _checkModalityInBag_(const std::string& mod);

    void _setCPTAndParents_(const DiscreteVariable& var, Tensor< GUM_SCALAR >* table);

    void _resetParts_();

    void _fillProbaWithValuesTable_(const std::vector< std::string >& variables,
                                    const std::vector< float >&       rawTable);
    void _fillProbaWithValuesTable_(const std::vector< float >& rawTable);

    bool _increment_(std::vector< gum::Idx >&         modCounter,
                     List< const DiscreteVariable* >& varList) const;
  };
 
 
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
  extern template class BayesNetFactory< double >;
#endif
 
} /* namespace gum */
 
#include <agrum/BN/BayesNetFactory_tpl.h>
 
#endif   // GUM_BAYESNET_FACTORY_H