DAGmodel.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005 by Christophe GONZALES and Pierre-Henri WUILLEMIN  *
 *   {prenom.nom}_at_lip6.fr                                               *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
#ifndef GUM_DAGMODEL_H
#define GUM_DAGMODEL_H
#include <agrum/agrum.h>
#include <agrum/multidim/instantiation.h>

#include <agrum/graphs/DAG.h>
#include <agrum/graphs/undiGraph.h>

#include <agrum/graphicalModels/variableNodeMap.h>

namespace gum {

  class DAGmodel {
    public:

    DAGmodel();

    virtual ~DAGmodel();

    DAGmodel(const DAGmodel& source);


    const std::string& property(const std::string& name) const;

    const std::string& propertyWithDefault(const std::string& name,
                                           const std::string& byDefault) const;

    void setProperty(const std::string& name, const std::string& value);


    const DAG& dag() const;

    virtual const VariableNodeMap& variableNodeMap() const = 0;

    Size size() const;

    Size sizeArcs() const;

    bool empty() const;

    const NodeGraphPart& nodes() const;

    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;

    virtual Instantiation completeInstantiation() const final;

    const ArcSet& arcs() const;


    const NodeSet& parents(const NodeId id) const;
    const NodeSet& parents(const std::string& name) const {
      return parents(idFromName(name));
    };


    const NodeSet& children(const NodeId id) const;
    const NodeSet& children(const std::string& name) const {
      return parents(idFromName(name));
    };


    const UndiGraph& moralGraph(bool clear = true) const;

    const Sequence< NodeId >& topologicalOrder(bool clear = true) const;


    double log10DomainSize() const;

    bool hasSameStructure(const DAGmodel& other);

    protected:
    DAGmodel& operator=(const DAGmodel& source);

    DAG _dag;

    private:
    void __moralGraph() const;

    mutable UndiGraph* __mutableMoralGraph;

    mutable HashTable< std::string, std::string >* __propertiesMap;

    HashTable< std::string, std::string >& __properties() const;
  };
}   // namespace gum

#ifndef GUM_NO_INLINE
#  include <agrum/graphicalModels/DAGmodel_inl.h>
#endif /* GUM_NO_INLINE */

#endif /* GUM_DAGMODEL_H */