Module org.scijava.ops.engine

Package org.scijava.ops.engine.matcher.convert

Class ConvertedOpInfo

java.lang.Object

org.scijava.ops.engine.matcher.convert.ConvertedOpInfo

All Implemented Interfaces:

Comparable<OpInfo>, OpInfo

public class ConvertedOpInfo
extends Object
implements OpInfo

An OpInfo whose input and output types are transformed through the use of engine.convert Function Ops. Op instances created by this OpInfo utilize a engine.convert "preconverter" Op to coerce each provided input to the type expected by the Op, and after execution use a engine.convert "postconverter" Op to coerce the output back into the type expected by the user. If the Op defines a preallocated output buffer, a engine.copy Computers.Arity1 Op is used to place the computational results of the Op back into the passed output buffer.

As an example, consider a Function<Double, Double>. If we have a engine.convert Op that goes from Integer to Double and a engine.convert Op that goes from Double to Integer then we can construct a Function<Integer, Integer> Op. At runtime, we will utilize the former engine.convert Op to preconvert the input Integer into a Double, invoke the Function<Double, Double>, and then postconvert the Double into an Integer using the latter engine.convert Op, which is returned to the user.

Author:

Gabriel Selzer

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	IMPL_DECLARATION	Identifiers for declaring a conversion in an Op signature
protected static String	ORIGINAL_INFO
protected static String	OUTPUT_COPIER_DELIMITER
protected static String	POSTCONVERTER_DELIMITER
protected static String	PRECONVERTER_DELIMITER

Constructor Summary

Constructors

Constructor	Description
ConvertedOpInfo(OpInfo info, Type opType, List<RichOp<Function<?,?>>> preconverters, List<Type> reqInputs, RichOp<Function<?,?>> postconverter, Type reqOutput, RichOp<Computers.Arity1<?,?>> copyOp, OpEnvironment env, Map<TypeVariable<?>,Type> typeVarAssigns)
ConvertedOpInfo(OpInfo info, List<RichOp<Function<?,?>>> preconverters, RichOp<Function<?,?>> postconverter, RichOp<Computers.Arity1<?,?>> copyOp, OpEnvironment env)

Method Summary

Modifier and Type	Method	Description
int	compareTo(OpInfo that)
StructInstance<?>	createOpInstance(List<?> dependencies)	Creates a converted version of the original Op, whose parameter types are dictated by the input types of this info's preconverters.
Hints	declaredHints()
String	description()
AnnotatedElement	getAnnotationBearer()
String	id()	For a converted Op, we define the implementation as the concatenation of: The signature of all preconverters The signature of the postconverter The signature of the output copier The id of the source Op
String	implementationName()
List<String>	names()
Type	opType()
double	priority()
OpInfo	srcInfo()
Struct	struct()
String	toString()
Map<TypeVariable<?>,Type>	typeVarAssigns()
String	version()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.scijava.ops.api.OpInfo

inputs, inputTypes, output, outputs, outputType

Field Detail

IMPL_DECLARATION

protected static final String IMPL_DECLARATION

Identifiers for declaring a conversion in an Op signature

See Also:

Constant Field Values

PRECONVERTER_DELIMITER

protected static final String PRECONVERTER_DELIMITER

See Also:

Constant Field Values

POSTCONVERTER_DELIMITER

protected static final String POSTCONVERTER_DELIMITER

See Also:

Constant Field Values

OUTPUT_COPIER_DELIMITER

protected static final String OUTPUT_COPIER_DELIMITER

See Also:

Constant Field Values

ORIGINAL_INFO

protected static final String ORIGINAL_INFO

See Also:

Constant Field Values

Constructor Detail

ConvertedOpInfo

public ConvertedOpInfo(OpInfo info,
                       List<RichOp<Function<?,?>>> preconverters,
                       RichOp<Function<?,?>> postconverter,
                       RichOp<Computers.Arity1<?,?>> copyOp,
                       OpEnvironment env)

ConvertedOpInfo

public ConvertedOpInfo(OpInfo info,
                       Type opType,
                       List<RichOp<Function<?,?>>> preconverters,
                       List<Type> reqInputs,
                       RichOp<Function<?,?>> postconverter,
                       Type reqOutput,
                       RichOp<Computers.Arity1<?,?>> copyOp,
                       OpEnvironment env,
                       Map<TypeVariable<?>,Type> typeVarAssigns)

Method Detail

srcInfo

public OpInfo srcInfo()

names

public List<String> names()

Specified by:

names in interface OpInfo

description

public String description()

Specified by:

description in interface OpInfo

opType

public Type opType()

Specified by:

opType in interface OpInfo

declaredHints

public Hints declaredHints()

Specified by:

declaredHints in interface OpInfo

struct

public Struct struct()

Specified by:

struct in interface OpInfo

implementationName

public String implementationName()

Specified by:

implementationName in interface OpInfo

getAnnotationBearer

public AnnotatedElement getAnnotationBearer()

Specified by:

getAnnotationBearer in interface OpInfo

createOpInstance

public StructInstance<?> createOpInstance(List<?> dependencies)

Creates a converted version of the original Op, whose parameter types are dictated by the input types of this info's preconverters. The resulting Op uses those preconverters to convert the inputs. After invoking the original Op, this Op will use this info's postconverters to convert the output into the type requested by the user. If the request defines a preallocated output buffer, this Op will also take care to copy the postconverted output back into the user-provided output buffer.

Specified by:

createOpInstance in interface OpInfo

Parameters:

dependencies - - this Op's dependencies

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(OpInfo that)

Specified by:

compareTo in interface Comparable<OpInfo>

Specified by:

compareTo in interface OpInfo

version

public String version()

Specified by:

version in interface OpInfo

id

public String id()

For a converted Op, we define the implementation as the concatenation of:

1. The signature of all preconverters
2. The signature of the postconverter
3. The signature of the output copier
4. The id of the source Op

Specified by:

id in interface OpInfo

priority

public double priority()

Specified by:

priority in interface OpInfo

typeVarAssigns

public Map<TypeVariable<?>,Type> typeVarAssigns()