spacenode.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
 *
 *  Last modified:
 *     $Date: 2009-02-05 06:02:25 +0100 (Thu, 05 Feb 2009) $ by $Author: tack $
 *     $Revision: 8152 $
 *
 *  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_SPACENODE_HH
#define GECODE_GIST_SPACENODE_HH

#include <gecode/gist/node.hh>
#include <gecode/kernel.hh>

namespace Gecode { namespace Gist {

  enum NodeStatus {
    SOLVED,       
    FAILED,       
    BRANCH,       
    UNDETERMINED, 
    SPECIAL,      
    STEP          
  };

  static const unsigned int FIRSTBIT = 5; //< First free bit in status word
  static const unsigned int STATUSMASK = (1<<(FIRSTBIT-1))-1; //< Mask for accessing status

  class StepDesc {
  public:
    int noOfSteps;
    bool debug;
    StepDesc(int steps);
    void toggleDebug(void);
  };

  class SpecialDesc {
  public:
    const std::string vn;
    const int v;
    const int rel;
    SpecialDesc(std::string varName, int rel0, int v0);
  };

  class Statistics : public StatusStatistics {
  public:
    int solutions;
    int failures;
    int choices;
    int undetermined;
    int maxDepth;

    Statistics(void)
      : solutions(0), failures(0), choices(0), undetermined(1), maxDepth(0) {}
  };

  class SpaceNode;

  class BestNode {
  public:
    SpaceNode* s;
    BestNode(SpaceNode* s0);
  };

  class SpaceNode : public Node {
  protected:
    Space* copy;
    Space* workingSpace;
  private:
    SpaceNode* ownBest;
  protected:
    union {
      const BranchingDesc* branch;
      const SpecialDesc* special;
      StepDesc* step;
    } desc;

    unsigned int nstatus;

    enum SpaceNodeFlags {
      HASOPENCHILDREN = FIRSTBIT,
      HASFAILEDCHILDREN,
      HASSOLVEDCHILDREN
    };
    static const int LASTBIT = HASSOLVEDCHILDREN;

  private:
    void setHasOpenChildren(bool b);
    void setHasFailedChildren(bool b);
    void setHasSolvedChildren(bool b);
    void setStatus(NodeStatus s);

    int recompute(BestNode* curBest, int c_d, int a_d);

    void closeChild(bool hadFailures, bool hadSolutions);
  protected:
    void acquireSpace(BestNode* curBest, int c_d, int a_d);
  public:
    SpaceNode(void);
    SpaceNode(Space* root);
    ~SpaceNode(void);

    Space* getSpace(BestNode* curBest, int c_d, int a_d);

    const Space* getWorkingSpace(void) const;

    void purge(void);

    bool isCurrentBest(BestNode* curBest);

    int getNumberOfChildNodes(NodeAllocator& na,
                              BestNode* curBest,
                              Statistics& stats,
                              int c_d, int a_d);

    NodeStatus getStatus(void) const;
    bool isStepNode(void);
    void setSpecialDesc(const SpecialDesc* d);
    void setStepDesc(StepDesc* d);
    StepDesc* getStepDesc(void);

    bool isOpen(void);
    bool hasFailedChildren(void);
    bool hasSolvedChildren(void);
    bool hasOpenChildren(void);
    int getNoOfOpenChildren(void);
    void setNoOfOpenChildren(int n);
    bool hasCopy(void);
    bool hasWorkingSpace(void);

    SpaceNode* getParent(void);
    SpaceNode* getChild(int i);
    int getAlternative(void);
  };

}}

#include <gecode/gist/spacenode.hpp>

#endif

// STATISTICS: gist-any