cliqueGraph.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_CLIQUE_GRAPH_H
#define GUM_CLIQUE_GRAPH_H

#include <iostream>

#include <agrum/agrum.h>

#include <agrum/graphs/undiGraph.h>

namespace gum {
  /* ===========================================================================
   */
  /* ===                           GRAPHS OF CLIQUES                         ===
   */
  /* ===========================================================================
   */
  /* ===========================================================================
   */

  class CliqueGraph : public UndiGraph {
    public:
    // ############################################################################
    // ############################################################################


    explicit CliqueGraph(Size nodes_size = HashTableConst::default_size,
                         bool nodes_resize_policy = true,
                         Size edges_size = HashTableConst::default_size,
                         bool edges_resize_policy = true);


    CliqueGraph(const CliqueGraph& from);


    virtual ~CliqueGraph();


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


    virtual void addEdge(const NodeId first, const NodeId second);


    virtual void eraseEdge(const Edge& edge);


    virtual void clearEdges();


    NodeId addNode(const NodeSet& clique);


    virtual NodeId addNode();


    virtual void addNode(const NodeId id, const NodeSet& clique);


    virtual void addNode(const NodeId id);


    virtual void eraseNode(const NodeId node);

    virtual void clear();


    const NodeSet& clique(const NodeId idClique) const;

    NodeId container(const NodeId idNode) const;

    virtual void setClique(const NodeId idClique, const NodeSet& new_clique);

    virtual void addToClique(const NodeId clique_id, const NodeId node_id);


    virtual void eraseFromClique(const NodeId clique_id, const NodeId node_id);


    const NodeSet& separator(const Edge& edge) const;


    const NodeSet& separator(const NodeId clique1, const NodeId clique) const;


    std::vector< NodeId > containerPath(const NodeId node1,
                                        const NodeId node2) const;


    bool hasRunningIntersection() const;


    bool isJoinTree() const;


    virtual const std::string toString() const;


    virtual const std::string toDot() const;


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


    CliqueGraph& operator=(const CliqueGraph& from);


    bool operator!=(const CliqueGraph& from) const;


    bool operator==(const CliqueGraph& from) const;


    private:
    NodeProperty< NodeSet > __cliques;

    EdgeProperty< NodeSet > __separators;


    void __updateSeparators(const NodeId clique1);


    struct __RunningIntersect {
      NodeSet visited_cliques;


      NodeSet nodes_other_components;

      NodeSet nodes_DFS_forbidden;

      NodeSet nodes_DFS_seen;

      NodeProperty< NodeSet > cliques_DFS_chain;
    };


    bool __runningIntersectionDFS(const NodeId        clique,
                                  const NodeId        from,
                                  __RunningIntersect& infos_DFS) const;
  };

  typedef CliqueGraph JunctionTree;

  typedef CliqueGraph JoinTree;


  std::ostream& operator<<(std::ostream&, const CliqueGraph&);

} /* namespace gum */

#ifndef GUM_NO_INLINE
#  include <agrum/graphs/cliqueGraph_inl.h>
#endif   // GUM_NOINLINE

#endif /* GUM_CLIQUE_GRAPH_H */