Package org.anchoranalysis.feature.calculate.bound

Class FeatureCalculatorMultiChangeInput<T extends FeatureInput>

Object

FeatureCalculatorMultiChangeInput<T>

Type Parameters:

T - feature-input-type

All Implemented Interfaces:

FeatureCalculatorMulti<T>

public class FeatureCalculatorMultiChangeInput<T extends FeatureInput>
extends Object
implements FeatureCalculatorMulti<T>

A FeatureCalculatorMulti but changes the input before calculation.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
FeatureCalculatorMultiChangeInput(FeatureCalculatorMulti<T> calculator, Consumer<T> change)	Creates a new FeatureCalculatorMultiChangeInput instance.

Method Summary

Modifier and Type	Method	Description
ResultsVector	calculate(T input)	Calculate the results of the features with a particular input.
ResultsVector	calculate(T input, FeatureList<T> featuresSubset)	Calculates the results of a subset of the features with a particular input.
ResultsVector	calculateSuppressErrors(T input, ErrorReporter errorReporter)	Calculates the results for an input recording the error to an ErrorReporter if anything goes wrong, but throwing no exception.
int	sizeFeatures()	The number of features that is calculated on each call to FeatureCalculatorMulti.calculate(T), and therefore the size of the returned ResultsVector.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.anchoranalysis.feature.calculate.bound.FeatureCalculatorMulti

calculate

Constructor Details

FeatureCalculatorMultiChangeInput

public FeatureCalculatorMultiChangeInput(FeatureCalculatorMulti<T> calculator,
 Consumer<T> change)

Creates a new FeatureCalculatorMultiChangeInput instance.

Parameters:

calculator - Delegate that is called after an input is changed.

change - A function that is applied to change the input before being passed to the delegate.

Method Details

calculate

public ResultsVector calculate(T input)
                        throws NamedFeatureCalculateException

Description copied from interface: FeatureCalculatorMulti

Calculate the results of the features with a particular input.

Specified by:

calculate in interface FeatureCalculatorMulti<T extends FeatureInput>

Parameters:

input - the input to calculate.

Returns:

the results of the calculation.

Throws:

NamedFeatureCalculateException - if any feature cannot be successfully calculated.

calculate

public ResultsVector calculate(T input,
 FeatureList<T> featuresSubset)
                        throws NamedFeatureCalculateException

Description copied from interface: FeatureCalculatorMulti

Calculates the results of a subset of the features with a particular input.

Specified by:

calculate in interface FeatureCalculatorMulti<T extends FeatureInput>

Parameters:

input - the input to calculate.

featuresSubset - the subset of features (from those bound to the current instance) to calculate with.

Returns:

the results of the calculation.

Throws:

NamedFeatureCalculateException - if any feature cannot be successfully calculated.

calculateSuppressErrors

public ResultsVector calculateSuppressErrors(T input,
 ErrorReporter errorReporter)

Description copied from interface: FeatureCalculatorMulti

Calculates the results for an input recording the error to an ErrorReporter if anything goes wrong, but throwing no exception.

Specified by:

calculateSuppressErrors in interface FeatureCalculatorMulti<T extends FeatureInput>

Parameters:

input - the input to calculate.

errorReporter - where errors are recorded.

Returns:

the results of the calculation.

sizeFeatures

public int sizeFeatures()

Description copied from interface: FeatureCalculatorMulti

The number of features that is calculated on each call to FeatureCalculatorMulti.calculate(T), and therefore the size of the returned ResultsVector.

Specified by:

sizeFeatures in interface FeatureCalculatorMulti<T extends FeatureInput>

Returns:

the number of features.