VariableOH.h

// VariableOH.h -- The interface to the super class of all the
// variable ordering heuristics.

/*
 * 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: VariableOH_8h-source.html,v 1.1 2005/05/25 12:37:18 tudor Exp $

#ifndef _CSP_KERNEL_VariableOH_H
#define _CSP_KERNEL_VariableOH_H


CSP_NAMESPACE_BEGIN(csp);


class StrictWeakVariableOrdering
{
  public:
    virtual ~StrictWeakVariableOrdering() {}
    virtual bool operator()(
        const Variable* /* variable0 */,
        const Variable* /* variable1 */) = 0;
};


class StrictWeakVariableOrderingWrapper
{
  public:
    StrictWeakVariableOrderingWrapper(
        StrictWeakVariableOrdering& implementation) :
        m_implementation(implementation) {}

    bool operator()(
        const Variable* variable0,
        const Variable* variable1)
    {
        return m_implementation(variable0, variable1);
    }

  private:
    StrictWeakVariableOrdering& m_implementation;
};


class CSP_API VariableOH :
    public OrderingHeuristic
{
  public:
    VariableOH(
        const wstring& name,
        Decomposition& decomposition,
        const vector<pair<double, double> >& intervals,
        double quality = 1);

    virtual ~VariableOH() {}

    virtual void init(const vlist_type& /*uninstantiatedVariables*/) {}

    virtual void done() {}

    virtual void select(vlist_type& selectable, vlist_type& selected) = 0;

    virtual wostream& print(wostream& wos) const;

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

  protected:
    void selectByQuality(
        vlist_type& selectable,
        vlist_type& selected,
        StrictWeakVariableOrdering& better,
        StrictWeakVariableOrdering& equal);

  private:
    VariableOH(const VariableOH&);

    VariableOH& operator=(const VariableOH&);
};


CSP_NAMESPACE_END(csp);


#endif // _CSP_KERNEL_VariableOH_H

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

---