ValueOH.h

// ValueOH.h -- The interface to the super class of all the value
// 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: ValueOH_8h-source.html,v 1.1 2005/05/25 12:37:18 tudor Exp $

#ifndef _CSP_KERNEL_ValueOH_H
#define _CSP_KERNEL_ValueOH_H


CSP_NAMESPACE_BEGIN(csp);


class StrictWeakValueOrdering
{
  public:
    virtual ~StrictWeakValueOrdering() {}
    virtual bool operator()(
        const Value* /* value0 */,
        const Value* /* value1 */) = 0;
};


class StrictWeakValueOrderingWrapper
{
  public:
    StrictWeakValueOrderingWrapper(
        StrictWeakValueOrdering& implementation) :
        m_implementation(implementation) {}

    bool operator()(
        const Value* value0,
        const Value* value1)
    {
        return m_implementation(value0, value1);
    }

  private:
    StrictWeakValueOrdering& m_implementation;
};


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

    virtual ~ValueOH() {}

    virtual void init(const vlist_type& /*uninstantiatedVariables*/)
    {
        m_previousVariable = 0;
        m_mistakeCount = 0;
    }

    virtual void done() {}

    void solutionFound(const Solution& solution);

    virtual void dynamicInit(
        Variable& /*variable*/,
        Domain& /*selectable*/) {}

    virtual void dynamicDone(Variable& /*variable*/) {}

    virtual void select(
        Domain& selectable,
        Domain& selected,
        Variable& variable) = 0;

    virtual bool better(const Value& value0, const Value& value1) /*= 0*/;

    virtual bool equal(const Value& value0, const Value& value1) /*= 0*/;

    virtual void sort(
        Domain& original,
        Domain& sorted,
        Variable& variable) /*= 0*/;

    virtual long double score(Variable& variable, const Value& value) = 0;

    void setDistance(size_t distance) { m_distance = distance; }

    bool analysisFlag() const { return m_analysis; }

    virtual wostream& print(wostream& wos) const;

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

  protected:
    void selectByQuality(
        const Variable& variable,
        Domain& selectable,
        Domain& selected,
        StrictWeakValueOrdering& better,
        StrictWeakValueOrdering& equal);

    void selectByDistance(
        const Variable& variable,
        Domain& selectable,
        Domain& selected,
        StrictWeakValueOrdering& better);

    void sort(
        Domain& original,
        Domain& sorted,
        Variable& variable,
        StrictWeakValueOrdering& better,
        StrictWeakValueOrdering& equal);

    int distance(
        vector<Value*>& preferred,
        hash_set<const Value*>& perfect) const;

    void printPerfectPositions(
        vector<Value*>& preferred,
        hash_set<const Value*>& perfect) const;

    bool m_analysis;

    size_t m_distance;

  protected:
    wostringstream& printScores(
        wostringstream& wos,
        Variable& variable,
        vector<Value*>& preferred);

  private:
    ValueOH(const ValueOH&);

    ValueOH& operator=(const ValueOH&);

    void updateStatistics(
        vector<Value*>& preferred,
        hash_set<const Value*>& perfect);

    int analyze(const Variable& variable, vector<Value*>& preferred);

    void sanityChecks(
        vector<Value*>& preferred,
        hash_set<const Value*>& perfect);

    void getNewlyInstantiatedVariables(
        hash_set<const Variable*>& newlyInstantiatedVariables) const;

    bool inKnownSubtree(
        const hash_set<const Variable*>& variables,
        const hash_map<const Variable*, const Value*>& values) const;

    void rememberGoodSubtree(shash_type& goodSolutions);

    void forgetKnownGoodSubtree();

    bool inKnownGoodSubtree() const;

    void rememberBadSubtree();

    void forgetKnownBadSubtree();

    bool inKnownBadSubtree() const;

    vector<ulonglong> m_usefulCalls;

    vector<ulonglong> m_uselessCalls;

    vector<double> m_averageQuality;

    vector<pair<double, double> > m_qualityRange;

    hash_set<const Variable*> m_goodVariables;

    hash_map<const Variable*, const Value*> m_goodValues;

    shash_type m_goodSolutions;

    hash_set<const Variable*> m_badVariables;

    hash_map<const Variable*, const Value*> m_badValues;

    hash_set<const Variable*> m_instantiatedVariables;

    int m_mistakeCount;

    const Variable* m_previousVariable;
};


CSP_NAMESPACE_END(csp);


#endif // _CSP_KERNEL_ValueOH_H

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

---