nodecursor.hh

Go to the documentation of this file.

/* -*- mode: C++; c-basic-offset: 2; indent-tabs-mode: nil -*- */
/*
 *  Main authors:
 *     Guido Tack <tack@gecode.org>
 *
 *  Copyright:
 *     Guido Tack, 2006
 *
 *  This file is part of Gecode, the generic constraint
 *  development environment:
 *     http://www.gecode.org
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, 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.
 *
 */

#ifndef GECODE_GIST_NODECURSOR_HH
#define GECODE_GIST_NODECURSOR_HH

#include <gecode/gist/visualnode.hh>

namespace Gecode { namespace Gist {

  template<class Node>
  class NodeCursor {
  private:
    Node* _startNode;
    Node* _node;
    unsigned int _alternative;
  protected:
    const typename Node::NodeAllocator& na;
    void node(Node* n);
    Node* startNode(void);
  public:
    NodeCursor(Node* theNode, const typename Node::NodeAllocator& na);
    Node* node(void);
    unsigned int alternative(void);
    void alternative(unsigned int a);



    bool mayMoveUpwards(void);
    void moveUpwards(void);
    bool mayMoveDownwards(void);
    void moveDownwards(void);
    bool mayMoveSidewards(void);
    void moveSidewards(void);
  };

  class HideFailedCursor : public NodeCursor<VisualNode> {
  private:
    bool onlyDirty;
  public:
    HideFailedCursor(VisualNode* theNode,
                     const VisualNode::NodeAllocator& na,
                     bool onlyDirtyNodes);


    bool mayMoveDownwards(void);
    void processCurrentNode(void);
  };

  class UnhideAllCursor : public NodeCursor<VisualNode> {
  public:
    UnhideAllCursor(VisualNode* theNode,
                    const VisualNode::NodeAllocator& na);


    void processCurrentNode(void);
  };

  class UnstopAllCursor : public NodeCursor<VisualNode> {
  public:
    UnstopAllCursor(VisualNode* theNode,
                    const VisualNode::NodeAllocator& na);


    void processCurrentNode(void);
  };

  class NextSolCursor : public NodeCursor<VisualNode> {
  private:
    bool back;
    bool notOnSol(void);
  public:
    NextSolCursor(VisualNode* theNode, bool backwards,
                  const VisualNode::NodeAllocator& na);


    void processCurrentNode(void);
    bool mayMoveUpwards(void);
    bool mayMoveDownwards(void);
    void moveDownwards(void);
    bool mayMoveSidewards(void);
    void moveSidewards(void);
  };

  class StatCursor : public NodeCursor<VisualNode> {
  private:
    int curDepth;
  public:
    int depth;
    int failed;
    int solved;
    int choice;
    int open;

    StatCursor(VisualNode* theNode,
               const VisualNode::NodeAllocator& na);



    void processCurrentNode(void);
    void moveDownwards(void);
    void moveUpwards(void);

  };

  class BranchLabelCursor : public NodeCursor<VisualNode> {
  private:
    VisualNode::NodeAllocator& _na;
    BestNode* _curBest;
    int _c_d;
    int _a_d;
    bool _clear;
  public:
    BranchLabelCursor(VisualNode* theNode, BestNode* curBest,
                      int c_d, int a_d, bool clear,
                      VisualNode::NodeAllocator& na);

    void processCurrentNode(void);
  };

  class DisposeCursor : public NodeCursor<VisualNode> {
  public:
    DisposeCursor(VisualNode* theNode,
                  const VisualNode::NodeAllocator& na);



    void processCurrentNode(void);

  };

}}

#include <gecode/gist/nodecursor.hpp>

#endif

// STATISTICS: gist-any