Generated on Sat Apr 10 2021 00:00:00 for Gecode by doxygen 1.9.1
nodevisitor.hh
Go to the documentation of this file.
1 /* -*- mode: C++; c-basic-offset: 2; indent-tabs-mode: nil -*- */
2 /*
3  * Main authors:
4  * Guido Tack <tack@gecode.org>
5  *
6  * Copyright:
7  * Guido Tack, 2006
8  *
9  * This file is part of Gecode, the generic constraint
10  * development environment:
11  * http://www.gecode.org
12  *
13  * Permission is hereby granted, free of charge, to any person obtaining
14  * a copy of this software and associated documentation files (the
15  * "Software"), to deal in the Software without restriction, including
16  * without limitation the rights to use, copy, modify, merge, publish,
17  * distribute, sublicense, and/or sell copies of the Software, and to
18  * permit persons to whom the Software is furnished to do so, subject to
19  * the following conditions:
20  *
21  * The above copyright notice and this permission notice shall be
22  * included in all copies or substantial portions of the Software.
23  *
24  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
25  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
26  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
27  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
28  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
29  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
30  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
31  *
32  */
33 
34 #ifndef GECODE_GIST_NODEVISITOR_HH
35 #define GECODE_GIST_NODEVISITOR_HH
36 
37 namespace Gecode { namespace Gist {
38 
40  template<class Cursor>
41  class NodeVisitor {
42  protected:
44  Cursor c;
45  public:
47  NodeVisitor(const Cursor& c0);
49  void setCursor(const Cursor& c0);
51  Cursor& getCursor(void);
52  };
53 
55  template<class Cursor>
56  class PostorderNodeVisitor : public NodeVisitor<Cursor> {
57  protected:
60  void moveToLeaf(void);
61  public:
63  PostorderNodeVisitor(const Cursor& c);
65  bool next(void);
67  void run(void);
68  };
69 
71  template<class Cursor>
72  class PreorderNodeVisitor : public NodeVisitor<Cursor> {
73  protected:
76  bool backtrack(void);
77  public:
79  PreorderNodeVisitor(const Cursor& c);
81  bool next(void);
83  void run(void);
84  };
85 
86 }}
87 
89 
90 #endif
91 
92 // STATISTICS: gist-any
Base class for a visitor that runs a cursor over a tree.
Definition: nodevisitor.hh:41
Cursor c
The cursor.
Definition: nodevisitor.hh:44
Cursor & getCursor(void)
Return the cursor.
Definition: nodevisitor.hpp:46
NodeVisitor(const Cursor &c0)
Constructor.
Definition: nodevisitor.hpp:38
void setCursor(const Cursor &c0)
Reset the cursor object to c0.
Definition: nodevisitor.hpp:42
Run a cursor over a tree, processing nodes in post-order.
Definition: nodevisitor.hh:56
PostorderNodeVisitor(const Cursor &c)
Constructor.
Definition: nodevisitor.hpp:57
bool next(void)
Move cursor to next node, return true if succeeded.
Definition: nodevisitor.hpp:64
void run(void)
Execute visitor.
Definition: nodevisitor.hpp:79
void moveToLeaf(void)
Move the cursor to the left-most leaf.
Definition: nodevisitor.hpp:50
Run a cursor over a tree, processing nodes in pre-order.
Definition: nodevisitor.hh:72
bool next(void)
Move cursor to the next node, return true if succeeded.
PreorderNodeVisitor(const Cursor &c)
Constructor.
Definition: nodevisitor.hpp:98
bool backtrack(void)
Move cursor to next node from a leaf.
Definition: nodevisitor.hpp:85
void run(void)
Execute visitor.