eliminationSequenceStrategy.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_ELIMINATION_SEQUENCE_STRATEGY_H
#define GUM_ELIMINATION_SEQUENCE_STRATEGY_H

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


namespace gum {

  class EliminationSequenceStrategy {
    public:
    // ############################################################################
    // ############################################################################

    virtual ~EliminationSequenceStrategy();

    virtual EliminationSequenceStrategy* newFactory() const = 0;


    virtual EliminationSequenceStrategy* copyFactory() const = 0;



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


    virtual bool setGraph(UndiGraph* graph, const NodeProperty< Size >* dom_sizes);


    virtual NodeId nextNodeToEliminate() = 0;

    virtual void askFillIns(bool do_it) = 0;

    virtual bool providesFillIns() const = 0;

    virtual bool providesGraphUpdate() const = 0;


    virtual void eliminationUpdate(const NodeId node);

    virtual const EdgeSet& fillIns();

    virtual void clear();

    UndiGraph* graph() const noexcept;

    const NodeProperty< Size >* domainSizes() const noexcept;



    protected:
    UndiGraph* _graph{nullptr};

    const NodeProperty< Size >* _domain_sizes{nullptr};

    NodeProperty< double > _log_domain_sizes;


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

    EliminationSequenceStrategy();

    EliminationSequenceStrategy(UndiGraph*                  graph,
                                const NodeProperty< Size >* domain_sizes);

    EliminationSequenceStrategy(const EliminationSequenceStrategy& from);

    EliminationSequenceStrategy(EliminationSequenceStrategy&& from);


    private:
    static const EdgeSet& __empty_fill_ins();
  };


} /* namespace gum */


#ifndef GUM_NO_INLINE
#  include <agrum/graphs/algorithms/triangulations/eliminationStrategies/eliminationSequenceStrategy_inl.h>
#endif   // GUM_NOINLINE


#endif /* GUM_ELIMINATION_SEQUENCE_STRATEGY_H */