gist.hh

Go to the documentation of this file.

/*
 *  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_HH__
#define __GECODE_GIST_HH__

#include <gecode/kernel.hh>
#include <gecode/search.hh>
#include <gecode/int.hh>
#ifdef GECODE_HAS_SET_VARS
#include <gecode/set.hh>
#endif
#ifdef GECODE_HAS_FLOAT_VARS
#include <gecode/float.hh>
#endif

/*
 * Configure linking
 *
 */

#if !defined(GIST_STATIC_LIBS) && \
    (defined(__CYGWIN__) || defined(__MINGW32__) || defined(_MSC_VER))

#ifdef GECODE_BUILD_GIST
#define GECODE_GIST_EXPORT __declspec( dllexport )
#else
#define GECODE_GIST_EXPORT __declspec( dllimport )
#endif

#else

#ifdef GECODE_GCC_HAS_CLASS_VISIBILITY
#define GECODE_GIST_EXPORT __attribute__ ((visibility("default")))
#else
#define GECODE_GIST_EXPORT
#endif

#endif

// Configure auto-linking
#ifndef GECODE_BUILD_GIST
#define GECODE_LIBRARY_NAME "Gist"
#include <gecode/support/auto-link.hpp>
#endif

#include <string>
#include <sstream>

namespace Gecode {

  namespace Gist {

    class GECODE_GIST_EXPORT Inspector {
    public:
      virtual void inspect(const Space& s) = 0;
      virtual std::string name(void);
      virtual void finalize(void);
      virtual ~Inspector(void);
    };

    class GECODE_GIST_EXPORT Comparator {
    public:


      virtual void compare(const Space& s0, const Space& s1) = 0;
      virtual std::string name(void);
      virtual void finalize(void);
      virtual ~Comparator(void);




      template<class Var>
      static std::string compare(std::string x_n, const VarArgArray<Var>& x,
        const VarArgArray<Var>& y);
      static std::string compare(std::string x_n, IntVar x, IntVar y);
      static std::string compare(std::string x_n, BoolVar x, BoolVar y);
#ifdef GECODE_HAS_SET_VARS

      static std::string compare(std::string x_n, SetVar x, SetVar y);
#endif
#ifdef GECODE_HAS_FLOAT_VARS

      static std::string compare(std::string x_n, FloatVar x, FloatVar y);
#endif

    };

    class TextOutputI;

    class GECODE_GIST_EXPORT TextOutput {
    private:
      TextOutputI *t;
      std::string n;
    protected:
      void init(void);
      std::ostream& getStream(void);
      void flush(void);
      void addHtml(const char* s);
    public:
      TextOutput(const std::string& name);
      void finalize(void);
      virtual ~TextOutput(void);
      virtual std::string name(void);
    };

    template<class S>
    class Print : public TextOutput, public Inspector {
    public:
      Print(const std::string& name);
      virtual void inspect(const Space& node);
      virtual std::string name(void);
      virtual void finalize(void);
    };

    template<class S>
    class VarComparator : public TextOutput, public Comparator {
    public:
      VarComparator(std::string name);
      virtual void compare(const Space& s0, const Space& s1);
      virtual std::string name(void);
      virtual void finalize(void);
    };

    GECODE_GIST_EXPORT
    void stopBranch(Space& home);

    class Options : public Search::Options {
    public:
      class _I {
      private:
        Support::DynamicArray<Inspector*,Heap> _click;
        unsigned int n_click;
        Support::DynamicArray<Inspector*,Heap> _solution;
        unsigned int n_solution;
        Support::DynamicArray<Inspector*,Heap> _move;
        unsigned int n_move;
        Support::DynamicArray<Comparator*,Heap> _compare;
        unsigned int n_compare;
      public:
        _I(void);
        void click(Inspector* i);
        void solution(Inspector* i);
        void move(Inspector* i);
        void compare(Comparator* c);

        Inspector* click(unsigned int i) const;
        Inspector* solution(unsigned int i) const;
        Inspector* move(unsigned int i) const;
        Comparator* compare(unsigned int i) const;
      } inspect;
      GECODE_GIST_EXPORT static const Options def;
      Options(void);
    };


    GECODE_GIST_EXPORT int
    explore(Space* root, bool bab, const Options& opt);

    int
    dfs(Space* root, const Gist::Options& opt = Gist::Options::def);

    int
    bab(Space* root, const Gist::Options& opt = Gist::Options::def);

  }

}

#include <gecode/gist/gist.hpp>

#endif

// STATISTICS: gist-any