FastCursorLoops

java.lang.Object
- net.imglib2.loops.FastCursorLoops

```
public final class FastCursorLoops
extends java.lang.Object
```
A package-private utility class that's used by LoopBuilder.

See Also:

createLoop(Object, List)

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`FastCursorLoops.FiveCursorLoop<A,B,C,D,E>`
`static class`	`FastCursorLoops.FourCursorLoop<A,B,C,D>`
`static class`	`FastCursorLoops.OneCursorLoop<A>`
`static class`	`FastCursorLoops.SixCursorLoop<A,B,C,D,E,F>`
`static class`	`FastCursorLoops.ThreeCursorLoop<A,B,C>`
`static class`	`FastCursorLoops.TwoCursorLoop<A,B>`

Field Summary

Fields
Modifier and Type Field Description

private static java.util.List<ClassCopyProvider<java.util.function.LongConsumer>> factories

Constructor Summary

Constructors
Modifier Constructor Description

private FastCursorLoops()

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static java.util.function.LongConsumer`	`createLoop(java.lang.Object action, java.util.List<? extends Cursor<?>> cursors)`	For example.: Given a BiConsumer and two Cursors:

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - factories
```
private static final java.util.List<ClassCopyProvider<java.util.function.LongConsumer>> factories
```
- Constructor Detail
  - FastCursorLoops
```
private FastCursorLoops()
```
- Method Detail
  - createLoop
```
public static java.util.function.LongConsumer createLoop(java.lang.Object action,
                                                         java.util.List<? extends Cursor<?>> cursors)
```
    For example.: Given a BiConsumer and two Cursors:
    BiConsumer<A, B> biConsumer = ... ; Cursor<A> cursorA = ... ; Cursor<B> cursorB = ... ;
    This method createLoop(biConsumer, Arrays.asList(cursorA, cursorB)) will return a LongConsumer that is functionally equivalent to:
    LongConsumer loop = n -> { for ( long i = 0; i < n; i++ ) biConsumer.accept( cursorA.next(), cursorB.next() ); };
    The returned LongConsumer is created in a way, that it can be gracefully optimised by the Java just-in-time compiler.
    Parameters:
    
    action - This must be an instance of Consumer, BiConsumer, LoopBuilder.TriConsumer, LoopBuilder.FourConsumer, LoopBuilder.FiveConsumer or LoopBuilder.SixConsumer.
    
    cursors - A list of Cursor, the size of the list must fit given action.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the number of cursor does not fit the given consumer.