be.ac.ulb.mlg.utils

Interface Renormalizer<RenormalizerState>

All Known Implementing Classes:

DefaultRenormalizer, TaxonRenormalizer

public interface Renormalizer<RenormalizerState>

Version:

1.2, 18/08/2015

Author:

Jean-Sébastien Lerat

Method Summary

Modifier and Type	Method and Description
RenormalizerState	cloneState() Avoid concurrent modification and inconsistent results when multi-threading is enabled.
boolean	hasNativeImplementation() Know if the current renormalizer owns a native implementation
double[][]	normalizeInput(double[][] input) Apply the normalization process on the given vector of data vectors
double[][]	normalizeOutput(double[][] input, double[][] output, Measure measure) Apply the normalization process on the given vector of data vectors and result measures
boolean	processInput() Know if the renormalizer can handle input (call normalizeInput has effect)
boolean	processOutput() Know if the renormalizer can handle output (call normalizeOutput has effect)
boolean	shufflePair() Know if the measurer use pre-shuffle
void	simulateRenormalization(RenormalizerState state, double[] shuffledFirst, double[] shuffledSecond, int first, int second) Method called when pairwise renormalization is used in order to obtain a normalized version of the shuffled vector as if it was in the original input matrix
void	updateRenormalization(RenormalizerState state, double[] vect, int index, boolean ignore) Method called when pairwise renormalization is used in order to ignore or not a row from the original input matrix

Method Detail

normalizeInput

double[][] normalizeInput(double[][] input)

Apply the normalization process on the given vector of data vectors

Parameters:

input - The given vector of data vectors

Returns:

the input array

normalizeOutput

double[][] normalizeOutput(double[][] input,
                           double[][] output,
                           Measure measure)

Apply the normalization process on the given vector of data vectors and result measures

Parameters:

input - The given vector of data vectors

output - The result vector (measures of data vectors)

measure - The corresponding measure

Returns:

the output array

hasNativeImplementation

boolean hasNativeImplementation()

Know if the current renormalizer owns a native implementation

Returns:

true if the native implementation exists

processInput

boolean processInput()

Know if the renormalizer can handle input (call normalizeInput has effect)

Returns:

true if it can handle

processOutput

boolean processOutput()

Know if the renormalizer can handle output (call normalizeOutput has effect)

Returns:

true if it can handle

shufflePair

boolean shufflePair()

Know if the measurer use pre-shuffle

Returns:

true if pair will be shuffled, false otherwise

simulateRenormalization

void simulateRenormalization(RenormalizerState state,
                             double[] shuffledFirst,
                             double[] shuffledSecond,
                             int first,
                             int second)

Method called when pairwise renormalization is used in order to obtain a normalized version of the shuffled vector as if it was in the original input matrix

Parameters:

state - The state on which modifications will be applied

shuffledFirst - The first vector of the pairwise comparison (shuffled version)

shuffledSecond - The second vector of the pairwise comparison (shuffled version)

first - The index of the first vector from the original input matrix

second - The index of the second vector from the original input matrix

updateRenormalization

void updateRenormalization(RenormalizerState state,
                           double[] vect,
                           int index,
                           boolean ignore)

Method called when pairwise renormalization is used in order to ignore or not a row from the original input matrix

Parameters:

state - The state on which modifications will be applied

vect - A vector which is considerate as a row from the original input matrix corresponding to the row at the given index

index - The index of the vector to map it into the original matrix at this index

ignore - A boolean to tell if the values of the vector must be ignored (typically remove these values from the normalization process as if it was the row "index" from the original input matrix) with the true value (typically false to add it into renormalization)

cloneState

RenormalizerState cloneState()

Avoid concurrent modification and inconsistent results when multi-threading is enabled. This methode clone the current inner state of the renormalizer in ordre to apply modications (like removing a vector data from the renormilizer) into the cloned state of the current thread

Returns:

The current inner state of the renormalizer