Opify util package

imglib · Dec 21, 2023 · f83c181 · f83c181
1 parent 0785d40
commit f83c181
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/src/main/java/net/imglib2/algorithm/util/Grids.java b/src/main/java/net/imglib2/algorithm/util/Grids.java
@@ -213,6 +213,7 @@ public static void forEachOffset(
 	 * Get all blocks of size {@code blockSize} contained within an interval
 	 * specified by {@code dimensions} and their positions within a cell grid.
 	 *
+	 * @implNote op name='collectAllContainedIntervalsWithGridPositions', type='java.util.function.BiFunction'
 	 * @param dimensions
 	 * @param blockSize
 	 * @return list of blocks as specified by {@link Interval} and the position
@@ -229,6 +230,7 @@ public static List< Pair< Interval, long[] > > collectAllContainedIntervalsWithG
 	 * specified by {@code min}, {@code max} and their positions within a cell
 	 * grid.
 	 *
+	 * @implNote op name='collectAllContainedIntervalsWithGridPositions', type='org.scijava.function.Functions.Arity3'
 	 * @param min
 	 * @param max
 	 * @param blockSize
@@ -245,6 +247,7 @@ public static List< Pair< Interval, long[] > > collectAllContainedIntervalsWithG
 	 * Get all blocks of size {@code blockSize} contained within an interval
 	 * specified by {@code dimensions} and their positions within a cell grid.
 	 *
+	 * @implNote op name='collectAllContainedIntervals', type='java.util.function.BiFunction'
 	 * @param dimensions
 	 * @param blockSize
 	 * @return list of blocks as specified by {@link Interval}
@@ -260,6 +263,7 @@ public static List< Interval > collectAllContainedIntervals( final long[] dimens
 	 * specified by {@code min}, {@code max} and their positions within a cell
 	 * grid.
 	 *
+	 * @implNote op name='collectAllContainedIntervals', type='org.scijava.function.Functions.Arity3'
 	 * @param min
 	 * @param max
 	 * @param blockSize
@@ -275,6 +279,7 @@ public static List< Interval > collectAllContainedIntervals( final long[] min, f
 	 * Get all blocks of size {@code blockSize} contained within an interval
 	 * specified by {@code dimensions}.
 	 *
+	 * @implNote op name='collectAllOffsets', type='java.util.function.BiFunction'
 	 * @param dimensions
 	 * @param blockSize
 	 * @return list of blocks defined by minimum
@@ -289,6 +294,7 @@ public static List< long[] > collectAllOffsets( final long[] dimensions, final i
 	 * Get all blocks of size {@code blockSize} contained within an interval
 	 * specified by {@code dimensions}.
 	 *
+	 * @implNote op name='collectAllOffsets', type='org.scijava.function.Functions.Arity3'
 	 * @param dimensions
 	 * @param blockSize
 	 * @param func
@@ -306,6 +312,7 @@ public static < T > List< T > collectAllOffsets( final long[] dimensions, final
 	 * Get all blocks of size {@code blockSize} contained within an interval
 	 * specified by {@code min} and {@code max}.
 	 *
+	 * @implNote op name='collectAllOffsets', type='org.scijava.function.Functions.Arity3'
 	 * @param min
 	 * @param max
 	 * @param blockSize
@@ -321,6 +328,7 @@ public static List< long[] > collectAllOffsets( final long[] min, final long[] m
 	 * Get all blocks of size {@code blockSize} contained within an interval
 	 * specified by {@code min} and {@code max}.
 	 *
+	 * @implNote op name='collectAllOffsets', type='org.scijava.function.Functions.Arity4'
 	 * @param min
 	 * @param max
 	 * @param blockSize
@@ -466,6 +474,7 @@ public static Function< long[], Pair< Interval, long[] > > croppedIntervalAndGri
 	 * into a {@link Pair} of {@link Interval} and {@link long[]} that specify
 	 * the block and its position in grid coordinates.
 	 *
+	 * @implNote op name='croppedIntervalAndGridPosition', type='org.scijava.function.Functions.Arity3'
 	 * @param min
 	 *            minimum of the grid
 	 * @param max

diff --git a/src/main/java/net/imglib2/algorithm/util/ParallelizeOverBlocks.java b/src/main/java/net/imglib2/algorithm/util/ParallelizeOverBlocks.java
@@ -61,6 +61,7 @@ public class ParallelizeOverBlocks
 	 *
 	 * Submit blocked tasks and wait for execution.
 	 *
+	 * @implNote op name='parallelizeAndWait', type='org.scijava.function.Functions.Arity5'
 	 * @param func
 	 *            {@link Function} to be applied to each block as specified by
 	 *            first parameter {@link Interval}.
@@ -88,6 +89,7 @@ public static < T > List< T > parallelizeAndWait(
 	 *
 	 * Submit blocked tasks and wait for execution.
 	 *
+	 * @implNote op name='parallelize', type='org.scijava.function.Functions.Arity5'
 	 * @param func
 	 *            {@link Function} to be applied to each block as specified by
 	 *            first parameter {@link Interval}.
@@ -112,6 +114,7 @@ public static < T > List< Future< List< T > > > parallelize(
 	 *
 	 * Submit blocked tasks and wait for execution.
 	 *
+	 * @implNote op name='parallelizeAndWait', type='org.scijava.function.Functions.Arity6'
 	 * @param func
 	 *            {@link Function} to be applied to each block as specified by
 	 *            first parameter {@link Interval}.
@@ -145,6 +148,7 @@ public static < T > List< T > parallelizeAndWait(
 	 *
 	 * Submit blocked tasks and wait for execution.
 	 *
+	 * @implNote op name='parallelize', type='org.scijava.function.Functions.Arity6'
 	 * @param func
 	 *            {@link Function} to be applied to each block as specified by
 	 *            first parameter {@link Interval}.
@@ -177,6 +181,7 @@ public static < T > List< Future< List< T > > > parallelize(
 	 *
 	 * Submit blocked tasks and wait for execution.
 	 *
+	 * @implNote op name='parallelizeAndWait', type='org.scijava.function.Functions.Arity4'
 	 * @param func
 	 *            {@link Function} to be applied to each block as specified by
 	 *            first parameter {@link Interval}.
@@ -206,6 +211,7 @@ public static < T > List< T > parallelizeAndWait(
 	 *
 	 * Submit blocked tasks and wait for execution.
 	 *
+	 * @implNote op name='parallelize', type='org.scijava.function.Functions.Arity4'
 	 * @param func
 	 *            {@link Function} to be applied to each block as specified by
 	 *            first parameter {@link Interval}.