include/dlvhex2/Interpretation.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 INTERPRETATION_HPP_INCLUDED__08112010
#define INTERPRETATION_HPP_INCLUDED__08112010

#include "dlvhex2/PlatformDefinitions.h"
#include "dlvhex2/fwd.h"
#include "dlvhex2/ModelGenerator.h"
#include "dlvhex2/ID.h"
#include "dlvhex2/Registry.h"
#include <bm/bm.h>
#include <boost/function.hpp>
#include <boost/shared_ptr.hpp>

DLVHEX_NAMESPACE_BEGIN

class DLVHEX_EXPORT Interpretation:
public InterpretationBase,
public ostream_printable<Interpretation>
{
    // types
    public:
        typedef boost::shared_ptr<Interpretation> Ptr;
        typedef boost::shared_ptr<const Interpretation> ConstPtr;
        typedef bm::bvector<> Storage;
        typedef boost::function<bool (IDAddress)> FilterCallback;
        typedef Storage::enumerator TrueBitIterator;

        // storage
    protected:
        RegistryPtr registry;
        Storage bits;

        // \brief Specifies whether Interpretation::myHash is up-to-date.
        mutable bool hashUpdated;

        // \brief Hash value of this interpretation.
        mutable std::size_t myHash;
        // members
    public:
        inline Interpretation(){};
        Interpretation(RegistryPtr registry);
        virtual ~Interpretation();
        // TODO: bitset stuff with bitmagic

        virtual unsigned filter(FilterCallback callback);

        virtual std::ostream& print(std::ostream& o, const char* first, const char* sep, const char* last) const;

        virtual std::ostream& printWithoutPrefix(std::ostream& o, const char* first, const char* sep, const char* last) const;

        virtual std::ostream& printAsNumber(std::ostream& o, const char* first, const char* sep, const char* last) const;

        virtual std::ostream& print(std::ostream& o) const;

        virtual std::ostream& printWithoutPrefix(std::ostream& o) const;

        virtual std::ostream& printAsNumber(std::ostream& o) const;

        virtual std::ostream& printAsFacts(std::ostream& o) const;

        void add(const Interpretation& other);

        void bit_and(const Interpretation& other);

        Ptr getInterpretationWithoutExternalAtomAuxiliaries() const;

        inline void setFact(IDAddress id)
            { bits.set(id); hashUpdated = false; }

        inline void clearFact(IDAddress id)
            { bits.clear_bit(id); hashUpdated = false; }

        inline bool getFact(IDAddress id) const
            { return bits.get_bit(id); }

        const Storage& getStorage() const { return bits; }
        Storage& getStorage() { return bits; }

        std::pair<TrueBitIterator, TrueBitIterator> trueBits() const
            { return std::make_pair(bits.first(), bits.end()); }

        const OrdinaryAtom& getAtomToBit(IDAddress addr) const
            { return registry->ogatoms.getByAddress(addr); }

        const OrdinaryAtom& getAtomToBit(TrueBitIterator it) const
            { return registry->ogatoms.getByAddress(*it); }

        RegistryPtr getRegistry() const { return registry; }

        // TODO why does this exist? it should not!
        void setRegistry(RegistryPtr registry1) { registry = registry1; }

        inline bool isClear() const
            {  return bits.none();  }

        inline void clear()
            {  bits.clear(); hashUpdated = false; }

        bool operator==(const Interpretation& other) const;

        bool operator!=(const Interpretation& other) const;

        bool operator<(const Interpretation& other) const;

        std::size_t getHash() const;
};

typedef Interpretation::Ptr InterpretationPtr;
typedef Interpretation::ConstPtr InterpretationConstPtr;

DLVHEX_EXPORT std::size_t hash_value(const Interpretation& intr);

// TODO perhaps we want to have something like this for (manual) joins
// (see https://dlvhex.svn.sourceforge.net/svnroot/dlvhex/dlvhex/branches/dlvhex-depgraph-refactoring@1555)
//void multiplyInterpretations(
//      const std::vector<InterpretationPtr>& i1,
//      const std::vector<InterpretationPtr>& i2,
//      std::vector<InterpretationPtr>& result);

DLVHEX_NAMESPACE_END
#endif                           // INTERPRETATION_HPP_INCLUDED__08112010

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