this repo has no description
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
37namespace Gecode { namespace Gist {
38
39 /// \brief Base class for a visitor that runs a cursor over a tree
40 template<class Cursor>
41 class NodeVisitor {
42 protected:
43 /// The cursor
44 Cursor c;
45 public:
46 /// Constructor
47 NodeVisitor(const Cursor& c0);
48 /// Reset the cursor object to \a c0
49 void setCursor(const Cursor& c0);
50 /// Return the cursor
51 Cursor& getCursor(void);
52 };
53
54 /// \brief Run a cursor over a tree, processing nodes in post-order
55 template<class Cursor>
56 class PostorderNodeVisitor : public NodeVisitor<Cursor> {
57 protected:
58 using NodeVisitor<Cursor>::c;
59 /// Move the cursor to the left-most leaf
60 void moveToLeaf(void);
61 public:
62 /// Constructor
63 PostorderNodeVisitor(const Cursor& c);
64 /// Move cursor to next node, return true if succeeded
65 bool next(void);
66 /// Execute visitor
67 void run(void);
68 };
69
70 /// \brief Run a cursor over a tree, processing nodes in pre-order
71 template<class Cursor>
72 class PreorderNodeVisitor : public NodeVisitor<Cursor> {
73 protected:
74 using NodeVisitor<Cursor>::c;
75 /// Move cursor to next node from a leaf
76 bool backtrack(void);
77 public:
78 /// Constructor
79 PreorderNodeVisitor(const Cursor& c);
80 /// Move cursor to the next node, return true if succeeded
81 bool next(void);
82 /// Execute visitor
83 void run(void);
84 };
85
86}}
87
88#include <gecode/gist/nodevisitor.hpp>
89
90#endif
91
92// STATISTICS: gist-any