BranchingFactors.h

// BranchingFactors.h -- The interface to a cache of branching factors.

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

#ifndef _CSP_CACHES_BranchingFactors_H
#define _CSP_CACHES_BranchingFactors_H


CSP_NAMESPACE_BEGIN(csp);
CSP_NAMESPACE_BEGIN(caches);


class CSP_API BranchingFactors
{
  public:
    enum Preference
    {
        Minimum,

        Maximum
    };

    BranchingFactors(
        Decomposition& decomposition,
        Preference /*preference*/ = Minimum) :
        m_decomposition(decomposition),
        m_variable(0) {}

    void init(const vlist_type& uninstantiatedVariables);

    void init(Variable& variable, Domain& domain);

    void done();

    void setVariable(const Variable& variable)
    {
        m_variable = &variable;
    }

    size_t branchingFactor(const Value& value) const;

    const hash_map<const Value*, size_t>& branchingFactors(
        const Variable& variable) const;

    bool contains(const Variable& variable) const
    {
        return m_branchingFactors.find(&variable) != m_branchingFactors.end();
    }

    void clear() { m_branchingFactors.clear(); }

    bool empty() { return m_branchingFactors.empty(); }

  private:
    BranchingFactors(const BranchingFactors&);

    BranchingFactors& operator=(const BranchingFactors&);

    typedef hash_map<const Variable*, hash_map<const Value*, size_t> > bf_type;

    Preference m_preference;

    Decomposition& m_decomposition;

    bf_type m_branchingFactors;

    const Variable* m_variable;
};


CSP_NAMESPACE_END(caches);
CSP_NAMESPACE_END(csp);


#endif // _CSP_KERNEL_BranchingFactors_H

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

---