ItemLabeling.h

Go to the documentation of this file.

#pragma once
 
#include <iostream>
#include <set>
#include <string>
#include <unordered_map>
 
#include "storm/storage/BitVector.h"
#include "storm/utility/OsDetection.h"
 
namespace storm {
namespace models {
namespace sparse {
 
class StateLabeling;
class ChoiceLabeling;
 
class ItemLabeling {
   public:
    explicit ItemLabeling(uint64_t itemCount = 0);
 
    ItemLabeling(ItemLabeling const& other) = default;
    ItemLabeling& operator=(ItemLabeling const& other) = default;
 
    virtual ~ItemLabeling() = default;
 
    virtual bool isStateLabeling() const;
    virtual bool isChoiceLabeling() const;
 
    StateLabeling const& asStateLabeling() const;
    StateLabeling& asStateLabeling();
    ChoiceLabeling const& asChoiceLabeling() const;
    ChoiceLabeling& asChoiceLabeling();
 
    bool operator==(ItemLabeling const& other) const;
 
    void addLabel(std::string const& label);
 
    void removeLabel(std::string const& label);
 
    std::set<std::string> getLabels() const;
 
    void addLabel(std::string const& label, storage::BitVector const& labeling);
 
    void addLabel(std::string const& label, storage::BitVector&& labeling);
 
    std::string addUniqueLabel(std::string const& prefix, storage::BitVector const& labeling);
 
    std::string addUniqueLabel(std::string const& prefix, storage::BitVector const&& labeling);
 
    void join(ItemLabeling const& other);
 
    bool containsLabel(std::string const& label) const;
 
    std::size_t getNumberOfLabels() const;
 
    std::size_t getNumberOfItems() const;
 
    void permuteItems(std::vector<uint64_t> const& inversePermutation);
 
    virtual std::size_t hash() const;
 
    void printLabelingInformationToStream(std::ostream& out = std::cout) const;
 
    void printCompleteLabelingInformationToStream(std::ostream& out = std::cout) const;
 
    friend std::ostream& operator<<(std::ostream& out, ItemLabeling const& labeling);
 
   protected:
    ItemLabeling getSubLabeling(storm::storage::BitVector const& items) const;
 
    virtual std::set<std::string> getLabelsOfItem(uint64_t item) const;
 
    virtual bool getItemHasLabel(std::string const& label, uint64_t item) const;
 
    virtual storm::storage::BitVector const& getItems(std::string const& label) const;
 
    virtual void setItems(std::string const& label, storage::BitVector const& labeling);
 
    virtual void setItems(std::string const& label, storage::BitVector&& labeling);
 
    virtual void addLabelToItem(std::string const& label, uint64_t item);
 
    virtual void removeLabelFromItem(std::string const& label, uint64_t item);
 
    // The number of items for which this object can hold the labeling.
    uint64_t itemCount;
 
    // A mapping from labels to the index of the corresponding bit vector in the vector.
    std::unordered_map<std::string, uint64_t> nameToLabelingIndexMap;
 
    // A vector that holds the labeling for all known labels.
    std::vector<storm::storage::BitVector> labelings;
 
    std::string generateUniqueLabel(const std::string& prefix) const;
};
 
}  // namespace sparse
}  // namespace models
}  // namespace storm