include/dlvhex2/ModelGenerator.h

Go to the documentation of this file.

/* dlvhex -- Answer-Set Programming with external interfaces.
 * Copyright (C) 2005-2007 Roman Schindlauer
 * Copyright (C) 2006-2015 Thomas Krennwallner
 * Copyright (C) 2009-2016 Peter Schüller
 * Copyright (C) 2011-2016 Christoph Redl
 * Copyright (C) 2015-2016 Tobias Kaminski
 * Copyright (C) 2015-2016 Antonius Weinzierl
 *
 * This file is part of dlvhex.
 *
 * dlvhex 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.1 of
 * the License, or (at your option) any later version.
 *
 * dlvhex 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 dlvhex; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA.
 */

#ifndef MODEL_GENERATOR_HPP_INCLUDED__30082010
#define MODEL_GENERATOR_HPP_INCLUDED__30082010

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif                           // HAVE_CONFIG_H

#include "dlvhex2/PlatformDefinitions.h"
#include "dlvhex2/Logger.h"
#include "dlvhex2/Printhelpers.h"

#include <boost/shared_ptr.hpp>
#include <boost/concept/assert.hpp>
#include <boost/concept_check.hpp>

#include <ostream>

DLVHEX_NAMESPACE_BEGIN

class DLVHEX_EXPORT InterpretationBase:
public ostream_printable<InterpretationBase>

{
    public:
        // debug
        std::ostream& print(std::ostream& o) const
            { return o << "InterpretationBase::print() not overloaded"; }
};

class Nogood; // fwd definition
template<typename InterpretationT>
class ModelGeneratorBase:
public ostream_printable<ModelGeneratorBase<InterpretationT> >
{
    // types
    public:
        BOOST_CONCEPT_ASSERT((boost::Convertible<InterpretationT, InterpretationBase>));

        typedef InterpretationT Interpretation;
        // those typedefs are just to remove the 'typename's from the interface
        typedef typename Interpretation::ConstPtr InterpretationConstPtr;
        typedef typename Interpretation::Ptr InterpretationPtr;
        typedef boost::shared_ptr<ModelGeneratorBase<Interpretation> > Ptr;

        // storage
    protected:
        InterpretationConstPtr input;

        // members
    public:
        ModelGeneratorBase(InterpretationConstPtr input):
        input(input) {}
        virtual ~ModelGeneratorBase() {}

        virtual InterpretationPtr generateNextModel() = 0;

        virtual const Nogood* getInconsistencyCause() { return 0; }
        
        virtual void addNogood(const Nogood* ng) {}

        // debug output
        virtual std::ostream& print(std::ostream& o) const
            { return o << "ModelGeneratorBase::print() not overloaded"; }
};

template<typename InterpretationT>
class ModelGeneratorFactoryBase:
public ostream_printable<ModelGeneratorFactoryBase<InterpretationT> >
{
    // types
    public:
        typedef InterpretationT Interpretation;

    public:
        typedef boost::shared_ptr<
            ModelGeneratorFactoryBase<InterpretationT> > Ptr;

        typedef ModelGeneratorBase<InterpretationT> MyModelGeneratorBase;
        typedef typename MyModelGeneratorBase::Ptr ModelGeneratorPtr;
        typedef typename MyModelGeneratorBase::InterpretationConstPtr
            InterpretationConstPtr;

        // methods
    public:
        ModelGeneratorFactoryBase() {}
        virtual ~ModelGeneratorFactoryBase() {}
        
        virtual void addInconsistencyCauseFromSuccessor(const Nogood* cause) {}

        virtual ModelGeneratorPtr createModelGenerator(
            InterpretationConstPtr input) = 0;
        virtual std::ostream& print(std::ostream& o) const
            { return o << "ModelGeneratorFactoryBase::print() not overloaded"; }
};

template<typename InterpretationT>
struct EvalUnitModelGeneratorFactoryProperties:
public ostream_printable<EvalUnitModelGeneratorFactoryProperties<InterpretationT> >
{
    BOOST_CONCEPT_ASSERT((boost::Convertible<InterpretationT, InterpretationBase>));
    typedef InterpretationT Interpretation;

    // aka model generator factory
    typename ModelGeneratorFactoryBase<InterpretationT>::Ptr
        mgf;                     // aka model generator factory

    public:
        virtual std::ostream& print(std::ostream& o) const
        {
            if( mgf )
                return o << *mgf;
            else
                return o << "(no ModelGeneratorFactory)";
        }
};

DLVHEX_NAMESPACE_END
#endif                           //MODEL_GENERATOR_HPP_INCLUDED__30082010

// vim:expandtab:ts=4:sw=4:
// mode: C++
// End: