Retraction.h

// Retraction.h -- An interface to objects monitoring domain changes and
// filter failures.

/*
 * Copyright (C) 1998,2004 Tudor Hulubei <tudor@hulubei.net>.
 *
 * This library is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2, or (at
 * your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA,
 * 02111-1307, USA.
 */

/*
 * NOTE: This is an interal header file.
 * You should not attempt to use it directly.
 */

// $Id: Retraction_8h-source.html,v 1.1 2005/05/25 12:37:18 tudor Exp $

#ifndef _CSP_KERNEL_Retraction_H
#define _CSP_KERNEL_Retraction_H


CSP_NAMESPACE_BEGIN(csp);


class CSP_API Retraction
{
  public:
    Retraction(const wstring& name, Problem& problem) :
        m_name(name),
        m_problem(problem),
        m_decomposition(0),
        m_filter(0) {}

    virtual ~Retraction() {}

    const wstring& name() const { return m_name; }

    const Problem& problem() const { return m_problem; }

    Problem& problem() { return m_problem; }

    const Decomposition& decomposition() const
    {
        assert(m_decomposition);
        return *m_decomposition;
    }

    Decomposition& decomposition()
    {
        assert(m_decomposition);
        return *m_decomposition; }

    const Filter& filter() const
    {
        assert(m_filter);
        return *m_filter;
    }

    Filter& filter()
    {
        assert(m_filter);
        return *m_filter;
    }

    virtual void init() {}

    virtual void done() {}

    virtual void start() {}

    virtual void stop() {}

    virtual void recordDomainChange(
        Variable& victim,
        Variable& aggressor) = 0;

    virtual void recordFailure(
        Constraint& constraint,
        Variable& victim,
        Variable& aggressor) = 0;

    virtual void unifyConflictSets(int /*jumpDepth*/) {}

    virtual void eraseConflictSets(int /*jumpDepth*/) {}

    virtual int computeJump(bool chronological = true) const = 0;

    virtual wostream& print(wostream& wos) const
    {
        return wos << L"Retraction: " << m_name << endl;
    }

    friend CSP_API wostream& operator<<(
        wostream& wos, const Retraction& retraction)
    {
        return retraction.print(wos);
    }

  private:
    // The algorithm's name.
    const wstring m_name;

  protected:
    // The problem.
    Problem& m_problem;

    // The decomposition guided by this retraction.
    Decomposition* m_decomposition;

    // The filter monitored by this monitor.
    Filter* m_filter;

  private:
    friend class Decomposition;
    void setDecomposition(Decomposition& decomposition)
    {
        m_decomposition = &decomposition;
    }

    void setFilter(Filter& filter)
    {
        m_filter = &filter;
    }
};


CSP_NAMESPACE_END(csp);


#endif // _CSP_KERNEL_Retraction_H

// Local Variables:
// mode: C++
// End:

---