spacenode.hh

/* -*- mode: C++; c-basic-offset: 2; indent-tabs-mode: nil -*- */
/*
 *  Main authors:
 *     Guido Tack <tack@gecode.org>
 *
 *  Copyright:
 *     Guido Tack, 2006
 *
 *  Last modified:
 *     $Date$ by $Author$
 *     $Revision$
 *
 *  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 SPACENODE_HH
#define SPACENODE_HH
// #pragma once


#include "node.hh"

/** \brief Status of nodes in the search tree
 */
enum NodeStatus : char {
  SOLVED = 0,       ///< Node representing a solution
  FAILED = 1,       ///< Node representing failure
  BRANCH = 2,       ///< Node representing a branch
  SKIPPED = 3,      ///< Skipped by backjumping (basically failed)
  UNDETERMINED, ///< Node that has not been explored yet
  REMOVED,      ///< Used for unwanted white nodes
  MERGING
};

static const unsigned int STATUSSTART = 28;

static const unsigned int FIRSTFLAG = 1; //< Number of first flag in status word
static const unsigned int STATUSMASK = 0xF << STATUSSTART; //< Mask for accessing status

class TreeCanvas;
class Data;

#ifdef MAXIM_DEBUG

std::string statusToString(NodeStatus status);

#endif

/// %Statistics about the search tree
class Statistics {
public:
  /// Number of solutions
  int solutions;
  /// Number of failures
  int failures;
  /// Number of choice nodes
  int choices;
  /// Number of open, undetermined nodes
  int undetermined;
  /// Maximum depth of the tree
  int maxDepth;

  /// Constructor
  Statistics(void)
    : solutions(0), failures(0), choices(0), undetermined(0), maxDepth(0) {}

  int allNodes() const { return solutions + failures + choices + undetermined; }
};

class SpaceNode;

/// \brief A node of a search tree of %Gecode spaces
class SpaceNode : public Node {

    friend class TreeBuilder;

protected:

  /** \brief Status of the node
   *
   * Anatomy of nstatus
   *
   *            Subtree
   *             Size |
   *   Node           |       flags
   *   Status         |  /------------\
   *                  |  IDHSBHOMHCDHHH
   *   /--\        /----\VEOEMINRILRSFO
   *   SSSS       SSSSSSSNLVLKGPKDDTCCC
   *   ********************************
   *    3         2         1         0
   *   10987654321098765432109876543210
   *
   * NOTE THAT THE FLAG NUMBERS DO NOT MATCH THE BIT NUMBERS.
   * (e.g. HASOPENCHILDREN=1 but resides at bit 0)
   * setFlag and getFlag subtract one to correct for this.
   * (setNumericFlag/getNumericFlag do it too.)
   *
   */


  /// Set status flag
  void setFlag(int flag, bool value);

  /// Return status flag
  bool getFlag(int flag) const;

  /// Return nstatus for copying nodes
  // unsigned int getStatusAndFlags(void) const;

  /// Set status numeric flag
  void setNumericFlag(int flag, int size, unsigned int value);

  /// Get status numeric flag
  unsigned int getNumericFlag(int flag, int size) const;

  /// Flags for SpaceNodes
  enum SpaceNodeFlags {
    HASOPENCHILDREN = FIRSTFLAG,
    HASFAILEDCHILDREN,
    HASSOLVEDCHILDREN
  };
  /// Last flag used for SpaceNode flags
  static const int LASTFLAG = HASSOLVEDCHILDREN;

private:
  /// Set whether the node has children that are not fully explored
  void setHasOpenChildren(bool b);
  /// Set whether the subtree of this node is known to contain failure
  void setHasFailedChildren(bool b);
  /// Set whether the subtree of this node is known to contain solutions
  void setHasSolvedChildren(bool b);


public:
  unsigned int nstatus;
  /// Book-keeping of open children
  void closeChild(const NodeAllocator& na,
                  bool hadFailures, bool hadSolutions);
  /// Set status to \a s
  void setStatus(NodeStatus s);

  /// Construct node with parent \a p
  SpaceNode(int p);
  /// Construct root node
  SpaceNode();

  /// Free allocated memory
  void dispose(void);

  /** \brief Compute and return the number of children
    *
    * On a node whose status is already determined, this function
    * just returns the number of children.  On an undetermined node,
    * it first acquires a Space (possibly through recomputation), and
    * then asks for its status.  If the space is solved or failed, the
    * node's status will be set accordingly, and 0 will be returned.
    * Otherwise, the status is SS_BRANCH, and as many new children will
    * be created as the branch has alternatives, and the number returned.
    */


  /// Return current status of the node
  NodeStatus getStatus(void) const;

  /// Return whether this node still has open children
  bool isOpen(void);
  /// Return whether the subtree of this node has any failed children
  bool hasFailedChildren(void);
  /// Return whether the subtree of this node has any solved children
  bool hasSolvedChildren(void) const;
  /// Return whether the subtree of this node has any open children
  bool hasOpenChildren(void) const;
  /// Return number of open children
  int getNoOfOpenChildren(const NodeAllocator& na) const;
  /// Set number of open children to \a n
  void setNoOfOpenChildren(int n);

  /// Return alternative number of this node
  int getAlternative(const NodeAllocator& na) const;
};

#endif // SPACENODE_HH