tempest/src/storm/storage/dd/Dd.h

#ifndef STORM_STORAGE_DD_DD_H_
#define STORM_STORAGE_DD_DD_H_

#include <vector>
#include <string>
#include <set>

#include "storm/storage/dd/DdType.h"
#include "storm/storage/expressions/Variable.h"

namespace storm {
    namespace dd {
        // Forward-declare some classes.
        template<DdType LibraryType>
        class DdManager;
        
        template<DdType LibraryType>
        class Bdd;

        template<DdType LibraryType>
        class Dd {
        public:
            // Declare the DdManager so it can access the internals of a DD.
            friend class DdManager<LibraryType>;
            
            // Instantiate all copy/move constructors/assignments with the default implementation.
            Dd() = default;
            Dd(Dd<LibraryType> const& other) = default;
            Dd& operator=(Dd<LibraryType> const& other) = default;
            Dd(Dd<LibraryType>&& other) = default;
            Dd& operator=(Dd<LibraryType>&& other) = default;
            
            virtual ~Dd() = default;
            
            /*!
             * Retrieves the support of the current DD.
             *
             * @return The support represented as a BDD.
             */
            virtual Bdd<LibraryType> getSupport() const = 0;
            
            /*!
             * Retrieves the number of encodings that are mapped to a non-zero value.
             *
             * @return The number of encodings that are mapped to a non-zero value.
             */
            virtual uint_fast64_t getNonZeroCount() const = 0;
            
            /*!
             * Retrieves the number of leaves of the DD.
             *
             * @return The number of leaves of the DD.
             */
            virtual uint_fast64_t getLeafCount() const = 0;
            
            /*!
             * Retrieves the number of nodes necessary to represent the DD.
             *
             * @return The number of nodes in this DD.
             */
            virtual uint_fast64_t getNodeCount() const = 0;
            
            /*!
             * Retrieves the index of the topmost variable in the DD.
             *
             * @return The index of the topmost variable in DD.
             */
            virtual uint_fast64_t getIndex() const = 0;
            
            /*!
             * Retrieves the level of the topmost variable in the DD.
             *
             * @return The level of the topmost variable in DD.
             */
            virtual uint_fast64_t getLevel() const = 0;
            
            /*!
             * Retrieves whether the given meta variable is contained in the DD.
             *
             * @param metaVariable The meta variable for which to query membership.
             * @return True iff the meta variable is contained in the DD.
             */
            bool containsMetaVariable(storm::expressions::Variable const& metaVariable) const;
            
            /*!
             * Retrieves whether the given meta variables are all contained in the DD.
             *
             * @param metaVariables The meta variables for which to query membership.
             * @return True iff all meta variables are contained in the DD.
             */
            bool containsMetaVariables(std::set<storm::expressions::Variable> const& metaVariables) const;
            
            /*!
             * Retrieves the set of all meta variables contained in the DD.
             *
             * @return The set of all meta variables contained in the DD.
             */
            std::set<storm::expressions::Variable> const& getContainedMetaVariables() const;
            
            /*!
             * Exports the DD to the given file in the dot format.
             *
             * @param filename The name of the file to which the DD is to be exported.
             */
            virtual void exportToDot(std::string const& filename) const = 0;
            
            /*!
             * Retrieves the manager that is responsible for this DD.
             *
             * A pointer to the manager that is responsible for this DD.
             */
            DdManager<LibraryType>& getDdManager() const;
            
            /*!
             * Retrieves the set of all meta variables contained in the DD.
             *
             * @return The set of all meta variables contained in the DD.
             */
            std::set<storm::expressions::Variable>& getContainedMetaVariables();
            
            /*!
             * Adds the given set of meta variables to the DD.
             *
             * @param metaVariables The set of meta variables to add.
             */
            void addMetaVariables(std::set<storm::expressions::Variable> const& metaVariables);
            
            /*!
             * Adds the given meta variable to the set of meta variables that are contained in this DD.
             *
             * @param metaVariable The name of the meta variable to add.
             */
            void addMetaVariable(storm::expressions::Variable const& metaVariable);
            
            /*!
             * Removes the given meta variable to the set of meta variables that are contained in this DD.
             *
             * @param metaVariable The name of the meta variable to remove.
             */
            void removeMetaVariable(storm::expressions::Variable const& metaVariable);
            
            /*!
             * Removes the given set of meta variables from the DD.
             *
             * @param metaVariables The set of meta variables to remove.
             */
            void removeMetaVariables(std::set<storm::expressions::Variable> const& metaVariables);
            
        protected:
            /*!
             * Retrieves the (sorted) list of the variable indices of DD variables contained in this DD.
             *
             * @return The sorted list of variable indices.
             */
            std::vector<uint_fast64_t> getSortedVariableIndices() const;
            
            /*!
             * Creates a DD with the given manager and meta variables.
             *
             * @param ddManager The manager responsible for this DD.
             * @param containedMetaVariables The meta variables that appear in the DD.
             */
            Dd(DdManager<LibraryType> const& ddManager, std::set<storm::expressions::Variable> const& containedMetaVariables = std::set<storm::expressions::Variable>());
            
            /*!
             * Retrieves the set of meta variables contained in both DDs.
             *
             * @param first The first DD.
             * @param second The second DD.
             * @return The set of all contained meta variables.
             */
            static std::set<storm::expressions::Variable> joinMetaVariables(storm::dd::Dd<LibraryType> const& first, storm::dd::Dd<LibraryType> const& second);
            
            /*!
             * Retrieves the set of meta variables that are contained in the first but not the second DD.
             *
             * @param first The first DD.
             * @param second The second DD.
             * @return The resulting set of meta variables.
             */
            static std::set<storm::expressions::Variable> subtractMetaVariables(storm::dd::Dd<LibraryType> const& first, storm::dd::Dd<LibraryType> const& second);
            
        private:
            // A pointer to the manager responsible for this DD.
            DdManager<LibraryType>* ddManager;
            
            // The meta variables that appear in this DD.
            std::set<storm::expressions::Variable> containedMetaVariables;
        };
    }
}

#endif /* STORM_STORAGE_DD_DD_H_ */