spanningForestPrim.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_SPANNING_FOREST_PRIM_H
#define GUM_SPANNING_FOREST_PRIM_H
 
#include <agrum/base/core/priorityQueue.h>
#include <agrum/base/graphs/algorithms/spanningForest.h>
 
namespace gum {
 
  /* ===========================================================================
   */
  /* ===========================================================================
   */
  class GUM_SHARED_PUBLIC SpanningForestPrim: public SpanningForest {
    public:
    // ############################################################################
    // ############################################################################


    SpanningForestPrim(const UndiGraph* graph, const EdgeProperty< float >* costTable);

    SpanningForestPrim(const SpanningForestPrim& toCopy);

    SpanningForestPrim(SpanningForestPrim&& from);

    ~SpanningForestPrim() override;

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


    const EdgeSet& edgesInSpanningForest() override;


    const UndiGraph& spanningForest() override;


    float costOfSpanningForest() override;

 
    private:
    const UndiGraph& _graph_;

    const EdgeProperty< float >& _costTable_;

    PriorityQueue< Edge, float > _edgesToExplore_;

    UndiGraph _spanning_tree_;

    float _spanning_tree_cost_;

    bool _require_computation_;

    void _compute_();

    void _computeInAComponent_(const NodeId id);

    void _exploreNode_(const NodeId id);

    SpanningForestPrim& operator=(const SpanningForestPrim& toCopy);
  };
 
} /* namespace gum */
 
#endif /* GUM_SPANNING_FOREST_PRIM_H */