OrderingHeuristic.h

// OrderingHeuristic.h -- The interface to the super class of all CSP
// ordering heuristics.

/*
 * Copyright (C) 1998 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: OrderingHeuristic_8h-source.html,v 1.1 2005/05/25 12:37:18 tudor Exp $

#ifndef _CSP_KERNEL_OrderingHeuristic_H
#define _CSP_KERNEL_OrderingHeuristic_H


CSP_NAMESPACE_BEGIN(csp);


class CSP_API OrderingHeuristic
{
  public:
    OrderingHeuristic(
        const wstring& name,
        Decomposition& decomposition,
        const vector<pair<double, double> >& intervals,
        double quality = 1) :
        m_name(name),
        m_decomposition(decomposition),
        m_intervals(intervals),
        m_quality(quality),
        m_invocations(0) {}

    virtual ~OrderingHeuristic() {}

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

    bool inRange() const;

    const vector<pair<double, double> > intervals() const
    {
        return m_intervals;
    }

    double quality() const { return m_quality; }

    void recordCall() { m_invocations++; }

    ulonglong invocations() const { return m_invocations; }

    virtual wostream& print(wostream& wos) const;

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

  private:
    const wstring m_name;

  protected:
    Decomposition& m_decomposition;

    vector<pair<double, double> > m_intervals;

    double m_quality;

    ulonglong m_invocations;

    vector<ulonglong> m_selectionSizes;

  private:
    OrderingHeuristic(const OrderingHeuristic&);

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


CSP_NAMESPACE_END(csp);


#endif // _CSP_KERNEL_OrderingHeuristic_H

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

---