IMarkovRandomField.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_SIMPLE_MARKOV_NET_H
#define GUM_SIMPLE_MARKOV_NET_H
 
#include <utility>
 
#include <agrum/agrum.h>
 
#include <agrum/base/graphicalModels/UGmodel.h>
#include <agrum/base/multidim/tensor.h>
 
namespace gum {
  template < typename GUM_SCALAR >
  using FactorTable = HashTable< NodeSet, const Tensor< GUM_SCALAR >* >;

  template < typename GUM_SCALAR >
  class IMarkovRandomField: public UGmodel {
    public:
    // ===========================================================================
    // ===========================================================================

    IMarkovRandomField();
    explicit IMarkovRandomField(std::string name);

    virtual ~IMarkovRandomField();

    IMarkovRandomField(const IMarkovRandomField< GUM_SCALAR >& source);

    IMarkovRandomField< GUM_SCALAR >& operator=(const IMarkovRandomField< GUM_SCALAR >& source);

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

    virtual const Tensor< GUM_SCALAR >& factor(const NodeSet& varIds) const = 0;

    virtual const NodeSet& smallestFactorFromNode(NodeId node) const = 0;

    virtual const NodeSet& smallestFactorFromNode(const std::string& name) const;

    virtual const FactorTable< GUM_SCALAR >& factors() const = 0;

    virtual const VariableNodeMap& variableNodeMap() const = 0;

    virtual const DiscreteVariable& variable(NodeId id) const = 0;

    virtual NodeId nodeId(const DiscreteVariable& var) const = 0;

    virtual NodeId idFromName(const std::string& name) const = 0;

    virtual const DiscreteVariable& variableFromName(const std::string& name) const = 0;

    bool operator==(const IMarkovRandomField< GUM_SCALAR >& from) const;

    bool operator!=(const IMarkovRandomField< GUM_SCALAR >& from) const;

    Size dim() const;

 
    Size maxVarDomainSize() const;

    GUM_SCALAR minParam() const;

    GUM_SCALAR maxParam() const;

    GUM_SCALAR minNonZeroParam() const;

    GUM_SCALAR maxNonOneParam() const;

    virtual std::string toDot() const;

    virtual std::string toDotAsFactorGraph() const;

    std::string toString() const;
 
    /***
     * @return the minimal subset of soids that conditions the target
     *
     * i.e. P(target| soids)=P(target|@return)
     */
    NodeSet minimalCondSet(NodeId target, const NodeSet& soids) const;
 
 
    /***
     * @return the minimal subset of soids that conditions the targets
     *
     * i.e. P(targets| soids)=P(targets|@return)
     */
    NodeSet minimalCondSet(const NodeSet& targets, const NodeSet& soids) const;
 
    private:
    void _minimalCondSetVisit_(NodeId         node,
                               const NodeSet& soids,
                               NodeSet&       minimal,
                               NodeSet&       alreadyVisited) const;
  };
 
 
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
  extern template class IMarkovRandomField< double >;
#endif
 

  template < typename GUM_SCALAR >
  std::ostream& operator<<(std::ostream& output, const IMarkovRandomField< GUM_SCALAR >& mn);
 
} /* namespace gum */
 
#include <agrum/MRF/IMarkovRandomField_tpl.h>
 
#endif /* GUM_SIMPLE_MARKOV_NET_H */