be.ac.ulb.mlg.utils
Interface Renormalizer

All Known Implementing Classes:
DefaultRenormalizer, TaxonRenormalizer

public interface Renormalizer

Version:
1.00, 24/06/2013
Author:
Jean-Sebastien Lerat (Jean-Sebastien.Lerat@ulb.ac.be)

Method Summary
 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(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(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(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:
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(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:
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)