Revision bsp schedule (#73)

* revision Ibsp schedule and set schedule

* member encapsulation

* setschedule revision

* satisfiesLocalConstraint revision

* removed local_in_out memconstraint

Author: tonibohnlein

include/osp/bsp/model/BspArchitecture.hpp

@@ -46,7 +46,6 @@ enum class MemoryConstraintType {
     GLOBAL, /** The memory bounds apply to the sum of memory weights of the nodes assigned to the same processor. */
     PERSISTENT_AND_TRANSIENT, /** Memory bounds apply to the sum of memory weights of nodes assigned to the same processor plus
                                  the maximum communication weight of a node assigned to a processor. */
-    LOCAL_IN_OUT,             /** Memory constraints are local in-out. Experimental. */
     LOCAL_INC_EDGES,          /** Memory constraints are local incident edges. Experimental. */
     LOCAL_SOURCES_INC_EDGES   /** Memory constraints are local source incident edges. Experimental. */
 };
@@ -65,8 +64,6 @@ inline const char *ToString(MemoryConstraintType type) {
             return "GLOBAL";
         case MemoryConstraintType::PERSISTENT_AND_TRANSIENT:
             return "PERSISTENT_AND_TRANSIENT";
-        case MemoryConstraintType::LOCAL_IN_OUT:
-            return "LOCAL_IN_OUT";
         case MemoryConstraintType::LOCAL_INC_EDGES:
             return "LOCAL_INC_EDGES";
         case MemoryConstraintType::LOCAL_SOURCES_INC_EDGES:

include/osp/bsp/model/BspSchedule.hpp

@@ -457,9 +457,6 @@ class BspSchedule : public IBspSchedule<GraphT>, public IBspScheduleEval<GraphT>
             case MemoryConstraintType::GLOBAL:
                 return SatisfiesGlobalMemoryConstraints();
 
-            case MemoryConstraintType::LOCAL_IN_OUT:
-                return SatisfiesLocalInOutMemoryConstraints();
-
             case MemoryConstraintType::LOCAL_INC_EDGES:
                 return SatisfiesLocalIncEdgesMemoryConstraints();
 
@@ -605,16 +602,17 @@ class BspSchedule : public IBspSchedule<GraphT>, public IBspScheduleEval<GraphT>
      * @return True if local memory constraints are satisfied, false otherwise.
      */
     bool SatisfiesLocalMemoryConstraints() const {
-        SetSchedule setSchedule = SetSchedule(*this);
+        std::vector<std::vector<VMemwT<GraphT>>> memory(numberOfSupersteps_,
+                                                        std::vector<VMemwT<GraphT>>(instance_->NumberOfProcessors(), 0));
+
+        for (const auto &node : instance_->Vertices()) {
+            memory[nodeToSuperstepAssignment_[node]][nodeToProcessorAssignment_[node]]
+                += instance_->GetComputationalDag().VertexMemWeight(node);
+        }
 
         for (unsigned step = 0; step < numberOfSupersteps_; step++) {
             for (unsigned proc = 0; proc < instance_->NumberOfProcessors(); proc++) {
-                VMemwT<GraphT> memory = 0;
-                for (const auto &node : setSchedule.stepProcessorVertices_[step][proc]) {
-                    memory += instance_->GetComputationalDag().VertexMemWeight(node);
-                }
-
-                if (memory > instance_->GetArchitecture().MemoryBound(proc)) {
+                if (memory[step][proc] > instance_->GetArchitecture().MemoryBound(proc)) {
                     return false;
                 }
             }
@@ -671,32 +669,6 @@ class BspSchedule : public IBspSchedule<GraphT>, public IBspScheduleEval<GraphT>
         return true;
     }
 
-    bool SatisfiesLocalInOutMemoryConstraints() const {
-        SetSchedule setSchedule = SetSchedule(*this);
-
-        for (unsigned step = 0; step < numberOfSupersteps_; step++) {
-            for (unsigned proc = 0; proc < instance_->NumberOfProcessors(); proc++) {
-                VMemwT<GraphT> memory = 0;
-                for (const auto &node : setSchedule.stepProcessorVertices_[step][proc]) {
-                    memory += instance_->GetComputationalDag().VertexMemWeight(node)
-                              + instance_->GetComputationalDag().VertexCommWeight(node);
-
-                    for (const auto &parent : instance_->GetComputationalDag().Parents(node)) {
-                        if (nodeToProcessorAssignment_[parent] == proc && nodeToSuperstepAssignment_[parent] == step) {
-                            memory -= instance_->GetComputationalDag().VertexCommWeight(parent);
-                        }
-                    }
-                }
-
-                if (memory > instance_->GetArchitecture().MemoryBound(proc)) {
-                    return false;
-                }
-            }
-        }
-
-        return true;
-    }
-
     bool SatisfiesLocalIncEdgesMemoryConstraints() const {
         SetSchedule setSchedule = SetSchedule(*this);
 
@@ -705,7 +677,7 @@ class BspSchedule : public IBspSchedule<GraphT>, public IBspScheduleEval<GraphT>
                 std::unordered_set<VertexIdxT<GraphT>> nodesWithIncomingEdges;
 
                 VMemwT<GraphT> memory = 0;
-                for (const auto &node : setSchedule.stepProcessorVertices_[step][proc]) {
+                for (const auto &node : setSchedule.GetProcessorStepVertices()[step][proc]) {
                     memory += instance_->GetComputationalDag().VertexCommWeight(node);
 
                     for (const auto &parent : instance_->GetComputationalDag().Parents(node)) {
@@ -735,7 +707,7 @@ class BspSchedule : public IBspSchedule<GraphT>, public IBspScheduleEval<GraphT>
                 std::unordered_set<VertexIdxT<GraphT>> nodesWithIncomingEdges;
 
                 VMemwT<GraphT> memory = 0;
-                for (const auto &node : setSchedule.stepProcessorVertices_[step][proc]) {
+                for (const auto &node : setSchedule.GetProcessorStepVertices()[step][proc]) {
                     if (IsSource(node, instance_->GetComputationalDag())) {
                         memory += instance_->GetComputationalDag().VertexMemWeight(node);
                     }

include/osp/bsp/model/IBspSchedule.hpp

@@ -22,43 +22,77 @@ limitations under the License.
 
 namespace osp {
 
-/// @class IBspSchedule
-/// @brief Interface for a BSP (Bulk Synchronous Parallel) schedule.
+/**
+ * @class IBspSchedule
+ * @brief Pure interface class to organize the interaction with a BSP schedule.
+ *
+ * A BSP schedule assigns nodes to processors and supersteps, is based on an instance, and has a number of supersteps.
+ * It provides unified access for different data implementations.
+ *
+ * - The class `BspSchedule` implements the assignments as vectors.
+ * - The class `SetBspSchedule` implements containers that contain all nodes assigned to a pair of processor and superstep.
+ *
+ * @tparam GraphT The type of the computational DAG, which must satisfy `is_computational_dag_v`.
+ * @see BspInstance
+ * @see BspSchedule
+ * @see SetBspSchedule
+ */
 template <typename GraphT>
 class IBspSchedule {
     using VertexIdx = VertexIdxT<GraphT>;
 
+    static_assert(isComputationalDagV<GraphT>, "IBspSchedule can only be used with computational DAGs.");
+
   public:
-    /// @brief Destructor.
     virtual ~IBspSchedule() = default;
 
-    virtual const BspInstance<GraphT> &GetInstance() const = 0;
-
-    /// @brief Set the assigned superstep for a node.
-    /// @param node The node index.
-    /// @param superstep The assigned superstep.
+    /**
+     * @brief Get the BSP instance associated with this schedule.
+     *
+     * @return The BSP instance.
+     */
+    [[nodiscard]] virtual const BspInstance<GraphT> &GetInstance() const = 0;
+
+    /**
+     * @brief Set the assigned superstep for a node.
+     *
+     * @param node The node index.
+     * @param superstep The assigned superstep.
+     */
     virtual void SetAssignedSuperstep(VertexIdx node, unsigned int superstep) = 0;
 
-    /// @brief Set the assigned processor for a node.
-    /// @param node The node index.
-    /// @param processor The assigned processor.
+    /**
+     * @brief Set the assigned processor for a node.
+     *
+     * @param node The node index.
+     * @param processor The assigned processor.
+     */
     virtual void SetAssignedProcessor(VertexIdx node, unsigned int processor) = 0;
 
-    /// @brief Get the assigned superstep of a node.
-    /// @param node The node index.
-    /// @return The assigned superstep of the node.
-    ///         If the node is not assigned to a superstep, this.NumberOfSupersteps() is returned.
-    virtual unsigned AssignedSuperstep(VertexIdx node) const = 0;
-
-    /// @brief Get the assigned processor of a node.
-    /// @param node The node index.
-    /// @return The assigned processor of the node.
-    ///         If the node is not assigned to a processor, this.GetInstance().NumberOfProcessors() is returned.
-    virtual unsigned AssignedProcessor(VertexIdx node) const = 0;
-
-    /// @brief Get the number of supersteps in the schedule.
-    /// @return The number of supersteps in the schedule.
-    virtual unsigned NumberOfSupersteps() const = 0;
+    /**
+     * @brief Get the assigned superstep of a node.
+     *
+     * @param node The node index.
+     * @return The assigned superstep of the node.
+     *         If the node is not assigned to a superstep, this.NumberOfSupersteps() is returned.
+     */
+    [[nodiscard]] virtual unsigned AssignedSuperstep(VertexIdx node) const = 0;
+
+    /**
+     * @brief Get the assigned processor of a node.
+     *
+     * @param node The node index.
+     * @return The assigned processor of the node.
+     *         If the node is not assigned to a processor, this.GetInstance().NumberOfProcessors() is returned.
+     */
+    [[nodiscard]] virtual unsigned AssignedProcessor(VertexIdx node) const = 0;
+
+    /**
+     * @brief Get the number of supersteps in the schedule.
+     *
+     * @return The number of supersteps in the schedule.
+     */
+    [[nodiscard]] virtual unsigned NumberOfSupersteps() const = 0;
 };
 
 }    // namespace  osp