Problem.h

// Problem.h -- The interface to the super class of all the Constraint
// Satisfaction Problems.

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

#ifndef _CSP_KERNEL_Problem_H
#define _CSP_KERNEL_Problem_H


CSP_NAMESPACE_BEGIN(csp);


class CSP_API Problem
{
  public:
    typedef vhash_type::const_iterator variable_iterator;
    typedef chash_type::const_iterator constraint_iterator;
    typedef shash_type::const_iterator solution_iterator;

#ifdef _MSC_VER
// No warnings about unknown warnings.
#pragma warning(disable: 4615)
// No warnings about using `this' in base member initializer list.
#pragma warning(disable: 4355)
#endif

    Problem(RandomSequence& randomSequence);

#ifdef _MSC_VER
#pragma warning(enable: 4355)
#pragma warning(enable: 4615)
#endif

    virtual ~Problem();

    virtual wstring name() const { return L"Problem"; }

    virtual wstring signature() const;

    size_t variables() const { return m_variables.size(); }

    size_t constraints() const { return m_constraints.size(); }

    size_t solutions() const { return m_solutions.size(); }

    const variable_iterator beginVariables() const
    {
        return m_variables.begin();
    }

    const variable_iterator endVariables() const
    {
        return m_variables.end();
    }

    const constraint_iterator beginConstraints() const
    {
        return m_constraints.begin();
    }

    const constraint_iterator endConstraints() const
    {
        return m_constraints.end();
    }

    const solution_iterator beginSolutions() const
    {
        return m_solutions.begin();
    }

    const solution_iterator endSolutions() const
    {
        return m_solutions.end();
    }

    Variable& variable(id_t id);

    const Variable& variable(id_t id) const;

    Constraint& constraint(id_t id);

    const Constraint& constraint(id_t id) const;

    virtual bool isSolution() const;

    bool isInternallyConsistent() const;

    bool isArcConsistent() const;

    virtual wostream& printSolution(wostream& wos) const;

    virtual void init();

    virtual void done();

    size_t maxDomainSize() const;

    RandomSequence& randomSequence() const { return m_randomSequence; }

    virtual wostream& print(wostream& wos) const;

    virtual void generateGraph(wostream& wos) const;

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

    virtual void save(wofstream& wofs) const;

    virtual void saveSolution(wofstream& wofs) const;

    variable_iterator add(Variable& variable);

    void remove(Variable& variable);

    constraint_iterator add(Constraint& constraint);

    void remove(Constraint& constraint);

    ulonglong totalCCKS() const;

    ulonglong failedCCKS() const;

  protected:
    Problem(const Problem& problem);

    void add(Solution& solution);

    int nextRandomNumber(int limit);

  private:
    Problem& operator=(const Problem&);

    template<class T>
#if defined(__GNUG__)
    void delete_hash(hash_set<T*, hash_id<T*>, equal_id<T*> >& container)
#elif defined(_MSC_VER)
    void delete_hash(hash_set<T*, hash_compare<T*, less_id<T*> > >& container)
#endif
    {
#if defined(__GNUG__)
        typename hash_set<T*, hash_id<T*>, equal_id<T*> >::iterator
            ci, next;
#elif defined(_MSC_VER)
        typename hash_set<T*, hash_compare<T*, less_id<T*> > >::iterator
            ci, next;
#endif
        for (ci = container.begin(); !container.empty(); ci = next)
        {
            next = ci;
            ++next;
            T* p = *ci;
            container.erase(ci);
            delete p;
        }
    }

    template<class T>
    void delete_vector(vector<T*>& container)
    {
        typename vector<T*>::iterator ci = container.begin();
        for (; ci != container.end(); ++ci)
            delete *ci;
        container.resize(0);
    }

    vhash_type m_variables;

    chash_type m_constraints;

    shash_type m_solutions;

    id_t m_nextVariableId;

    id_t m_nextConstraintId;

    id_t m_nextSolutionId;

    RandomSequence& m_randomSequence;
};


CSP_NAMESPACE_END(csp);


#endif // _CSP_KERNEL_Problem_H

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

---