add documentation for when TooManyIterationsException is thrown

computablee · Nov 21, 2023 · e6cb304 · e6cb304
1 parent 7e98702
commit e6cb304
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/DotMP/Parallel.cs b/DotMP/Parallel.cs
@@ -204,6 +204,7 @@ public static void For(int start, int end, Action<int> action, IScheduler schedu
         /// <exception cref="NotInParallelRegionException">Thrown when not in a parallel region.</exception>
         /// <exception cref="CannotPerformNestedWorksharingException">Thrown when nested inside another worksharing region.</exception>
         /// <exception cref="InvalidArgumentsException">Thrown if any provided arguments are invalid.</exception>
+        /// <exception cref="TooManyIterationsException">Thrown if there are too many iterations to handle.</exception> 
         public static void ForCollapse((int, int) firstRange, (int, int) secondRange, Action<int, int> action, IScheduler schedule = null, uint? chunk_size = null)
         {
             ForAction<object> forAction = new ForAction<object>(action, new (int, int)[] { firstRange, secondRange });
@@ -231,6 +232,7 @@ public static void ForCollapse((int, int) firstRange, (int, int) secondRange, Ac
         /// <exception cref="NotInParallelRegionException">Thrown when not in a parallel region.</exception>
         /// <exception cref="CannotPerformNestedWorksharingException">Thrown when nested inside another worksharing region.</exception>
         /// <exception cref="InvalidArgumentsException">Thrown if any provided arguments are invalid.</exception>
+        /// <exception cref="TooManyIterationsException">Thrown if there are too many iterations to handle.</exception>
         public static void ForCollapse((int, int) firstRange, (int, int) secondRange, (int, int) thirdRange, Action<int, int, int> action, IScheduler schedule = null, uint? chunk_size = null)
         {
             ForAction<object> forAction = new ForAction<object>(action, new (int, int)[] { firstRange, secondRange, thirdRange });
@@ -260,6 +262,7 @@ public static void ForCollapse((int, int) firstRange, (int, int) secondRange, (i
         /// <exception cref="NotInParallelRegionException">Thrown when not in a parallel region.</exception>
         /// <exception cref="CannotPerformNestedWorksharingException">Thrown when nested inside another worksharing region.</exception>
         /// <exception cref="InvalidArgumentsException">Thrown if any provided arguments are invalid.</exception>
+        /// <exception cref="TooManyIterationsException">Thrown if there are too many iterations to handle.</exception>
         public static void ForCollapse((int, int) firstRange, (int, int) secondRange, (int, int) thirdRange, (int, int) fourthRange, Action<int, int, int, int> action, IScheduler schedule = null, uint? chunk_size = null)
         {
             ForAction<object> forAction = new ForAction<object>(action, new (int, int)[] { firstRange, secondRange, thirdRange, fourthRange });
@@ -287,6 +290,7 @@ public static void ForCollapse((int, int) firstRange, (int, int) secondRange, (i
         /// <exception cref="NotInParallelRegionException">Thrown when not in a parallel region.</exception>
         /// <exception cref="CannotPerformNestedWorksharingException">Thrown when nested inside another worksharing region.</exception>
         /// <exception cref="InvalidArgumentsException">Thrown if any provided arguments are invalid.</exception>
+        /// <exception cref="TooManyIterationsException">Thrown if there are too many iterations to handle.</exception>
         public static void ForCollapse((int, int)[] ranges, Action<int[]> action, IScheduler schedule = null, uint? chunk_size = null)
         {
             ForAction<object> forAction = new ForAction<object>(action, ranges);
@@ -394,6 +398,7 @@ public static void ForReduction<T>(int start, int end, Operations op, ref T redu
         /// <exception cref="NotInParallelRegionException">Thrown when not in a parallel region.</exception>
         /// <exception cref="CannotPerformNestedWorksharingException">Thrown when nested inside another worksharing region.</exception>
         /// <exception cref="InvalidArgumentsException">Thrown if any provided arguments are invalid.</exception>
+        /// <exception cref="TooManyIterationsException">Thrown if there are too many iterations to handle.</exception>
         public static void ForReductionCollapse<T>((int, int) firstRange, (int, int) secondRange, Operations op, ref T reduce_to, ActionRef2<T> action, IScheduler schedule = null, uint? chunk_size = null)
         {
             ForAction<T> forAction = new ForAction<T>(action, new (int, int)[] { firstRange, secondRange });
@@ -426,6 +431,7 @@ public static void ForReductionCollapse<T>((int, int) firstRange, (int, int) sec
         /// <exception cref="NotInParallelRegionException">Thrown when not in a parallel region.</exception>
         /// <exception cref="CannotPerformNestedWorksharingException">Thrown when nested inside another worksharing region.</exception>
         /// <exception cref="InvalidArgumentsException">Thrown if any provided arguments are invalid.</exception>
+        /// <exception cref="TooManyIterationsException">Thrown if there are too many iterations to handle.</exception>
         public static void ForReductionCollapse<T>((int, int) firstRange, (int, int) secondRange, (int, int) thirdRange, Operations op, ref T reduce_to, ActionRef3<T> action, IScheduler schedule = null, uint? chunk_size = null)
         {
             ForAction<T> forAction = new ForAction<T>(action, new (int, int)[] { firstRange, secondRange, thirdRange });
@@ -460,6 +466,7 @@ public static void ForReductionCollapse<T>((int, int) firstRange, (int, int) sec
         /// <exception cref="NotInParallelRegionException">Thrown when not in a parallel region.</exception>
         /// <exception cref="CannotPerformNestedWorksharingException">Thrown when nested inside another worksharing region.</exception>
         /// <exception cref="InvalidArgumentsException">Thrown if any provided arguments are invalid.</exception>
+        /// <exception cref="TooManyIterationsException">Thrown if there are too many iterations to handle.</exception>
         public static void ForReductionCollapse<T>((int, int) firstRange, (int, int) secondRange, (int, int) thirdRange, (int, int) fourthRange, Operations op, ref T reduce_to, ActionRef4<T> action, IScheduler schedule = null, uint? chunk_size = null)
         {
             ForAction<T> forAction = new ForAction<T>(action, new (int, int)[] { firstRange, secondRange, thirdRange, fourthRange });
@@ -492,6 +499,7 @@ public static void ForReductionCollapse<T>((int, int) firstRange, (int, int) sec
         /// <exception cref="NotInParallelRegionException">Thrown when not in a parallel region.</exception>
         /// <exception cref="CannotPerformNestedWorksharingException">Thrown when nested inside another worksharing region.</exception>
         /// <exception cref="InvalidArgumentsException">Thrown if any provided arguments are invalid.</exception>
+        /// <exception cref="TooManyIterationsException">Thrown if there are too many iterations to handle.</exception>
         public static void ForReductionCollapse<T>((int, int)[] ranges, Operations op, ref T reduce_to, ActionRefN<T> action, IScheduler schedule = null, uint? chunk_size = null)
         {
             ForAction<T> forAction = new ForAction<T>(action, ranges);