orderedEliminationSequenceStrategy.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2026 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-2026                            *
 *       - 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_ORDERED_ELIMINATION_SEQUENCE_STRATEGY_H
#define GUM_ORDERED_ELIMINATION_SEQUENCE_STRATEGY_H
 
#include <vector>
 
#include <agrum/base/graphs/algorithms/triangulations/eliminationStrategies/eliminationSequenceStrategy.h>
 
namespace gum {

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

    OrderedEliminationSequenceStrategy();


    OrderedEliminationSequenceStrategy(UndiGraph*                   graph,
                                       const NodeProperty< Size >*  dom_sizes,
                                       const std::vector< NodeId >* order);

    OrderedEliminationSequenceStrategy(const OrderedEliminationSequenceStrategy& from);

    OrderedEliminationSequenceStrategy(OrderedEliminationSequenceStrategy&& from);

    ~OrderedEliminationSequenceStrategy() override;

    [[nodiscard]] OrderedEliminationSequenceStrategy* newFactory() const final;

    [[nodiscard]] OrderedEliminationSequenceStrategy* copyFactory() const final;

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


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


    virtual bool setOrder(const std::vector< NodeId >* order) final;

    void clear() final;


    NodeId nextNodeToEliminate() final;

    void askFillIns(bool do_it) final;

    bool providesFillIns() const final;

    bool providesGraphUpdate() const final;


    void eliminationUpdate(const NodeId node) final;

    const EdgeSet& fillIns() final;

    const std::vector< NodeId >* order() const noexcept;


    bool isOrderNeeded() const noexcept;

 
 
    private:
    const std::vector< NodeId >* _order_{nullptr};

    std::size_t _order_index_{std::size_t(0)};

    bool _order_needed_{true};
 

    bool _isOrderNeeded_(const std::vector< NodeId >* order) const;
  };
 
 
} /* namespace gum */
 
 
#ifndef GUM_NO_INLINE
#  include <agrum/base/graphs/algorithms/triangulations/eliminationStrategies/orderedEliminationSequenceStrategy_inl.h>
#endif   // GU%_NO_INLINE
 
 
#endif   /* GUM_ORDERED_ELIMINATION_SEQUENCE_STRATEGY_H */