pattern.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2025 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-2025                            *
 *       - 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_PATTERN_H
#define GUM_PATTERN_H
 
#include <agrum/agrum.h>
 
#include <agrum/PRM/gspan/DFSCode.h>
#include <agrum/PRM/gspan/interfaceGraph.h>
 
namespace gum {
  namespace prm {
    namespace gspan {
 
      class NeighborIterator;

      class Pattern: private DiGraph {
        public:
        // =========================================================================
        // ==========================================================================

        Pattern();

        Pattern(const Pattern& source);

        ~Pattern();

        // =========================================================================
        // ==========================================================================

        NodeId addNodeWithLabel(LabelData& l);

        LabelData& label(NodeId node);

        const LabelData& label(NodeId node) const;

        LabelData& label(NodeId i, NodeId j);

        const LabelData& label(NodeId i, NodeId j) const;

        LabelData& label(const Arc& arc);

        const LabelData& label(const Arc& arc) const;
 
        // Returns the last added LabelData.
        LabelData& lastAdded();
 
        // Returns the last added LabelData.
        const LabelData& lastAdded() const;

        void addArc(NodeId i, NodeId j, LabelData& l);

        bool exists(NodeId id) const;

        bool exists(NodeId tail, NodeId head) const;

        Size size() const;

        Size sizeArcs() const;

        void rightmostPath(std::list< NodeId >& r_path) const;

        std::string toDot(size_t name) const;

        // =========================================================================
        // ==========================================================================
        const NodeGraphPart& nodes() const;
 
        const ArcSet& arcs() const;

        // =========================================================================
        // ==========================================================================

        DFSCode& code();

        const DFSCode& code() const;

        EdgeCode& edgeCode(NodeId tail, NodeId head);

        EdgeCode& edgeCode(const Arc& arc);

        const EdgeCode& edgeCode(NodeId tail, NodeId head) const;

        const EdgeCode& edgeCode(const Arc& arc) const;

        void pop_back();

        void remove(NodeId node);
 
        bool isMinimal();

 
        private:
        DFSCode _code_;

        NodeProperty< LabelData* > _node_map_;

        ArcProperty< std::pair< LabelData*, EdgeCode* > > _arc_map_;

        LabelData* _last_ = nullptr;

        bool _expandCodeIsMinimal_(NodeId u, NodeId v);

        bool _rec_(Pattern& p, Bijection< NodeId, NodeId >& node_map, NodeId u, NodeId v);

        bool _not_rec_(Pattern& p, Bijection< NodeId, NodeId >& node_map, NodeId u, NodeId v);
 
        // to avoid clang++ warnings
        using DiGraph::addNode;
        using DiGraph::addArc;
        using DiGraph::toDot;
        using DiGraph::parents;
        using DiGraph::children;
      };
    } /* namespace gspan */
  } /* namespace prm */
} /* namespace gum */
#ifndef GUM_NO_INLINE
#  include <agrum/PRM/gspan/pattern_inl.h>
#endif   // GUM_NO_INLINE
 
#endif   /* GUM_PATTERN_H */