Module org.scijava.ops.api

Package org.scijava.ops.api

Class OpBuilder.Arity2_IV_OT<I1,I2,O>

java.lang.Object

org.scijava.ops.api.OpBuilder.Arity2_IV_OT<I1,I2,O>

Type Parameters:

I1 - The type of input 1.

I2 - The type of input 2.

O - The type of the output.

Enclosing class:

OpBuilder

public final class OpBuilder.Arity2_IV_OT<I1,I2,O>
extends Object

Builder with arity 2, input value given, output type given.

Author:

Curtis Rueden

Constructor Summary

Constructors

Constructor	Description
Arity2_IV_OT(I1 in1, I2 in2, Nil<O> outType)

Method Summary

Modifier and Type	Method	Description
O	apply()	Match then immediately run a Functions op and get its output.
Computers.Arity2<I1,I2,O>	computer()	Match a Computers op, based on the choices made with this builder, for operating on pre-allocated output.
BiFunction<I1,I2,O>	function()	Match a Functions op based on the choices made with this builder.
String	help()	Finds all Ops matching the current partial OpBuilder request
String	helpVerbose()	Finds all Ops matching the current partial OpBuilder request

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Arity2_IV_OT

public Arity2_IV_OT(I1 in1,
                    I2 in2,
                    Nil<O> outType)

Method Detail

function

public BiFunction<I1,I2,O> function()

Match a Functions op based on the choices made with this builder.

Returns:

An instance of the matched op, e.g. for reuse.

Throws:

OpMatchingException - if the Op request cannot be satisfied.

See Also:

To match then immediately run a Function Op using the input values provided to this builder., For a reusable Op to process pre-allocated outputs without re-matching.

computer

public Computers.Arity2<I1,I2,O> computer()

Match a Computers op, based on the choices made with this builder, for operating on pre-allocated output.

Returns:

An instance of the matched op, e.g. for reuse.

Throws:

OpMatchingException - if the Op request cannot be satisfied.

See Also:

To match then immediately run a Function Op using the input values provided to this builder., For a reusable Op that generates output instances based on its inputs.

apply

public O apply()

Match then immediately run a Functions op and get its output.

Returns:

The output of this function

Throws:

OpMatchingException - if the Op request cannot be satisfied.

See Also:

For a reusable Op to process pre-allocated outputs without re-matching., For a reusable Op that generates output instances based on its inputs.

help

public String help()

Finds all Ops matching the current partial OpBuilder request

Returns:

a String with a simple entry for each Op satisfying the partial request

helpVerbose

public String helpVerbose()

Finds all Ops matching the current partial OpBuilder request

Returns:

a String with a verbose entry for each Op satisfying the partial request