sbrt.kernel.math.stat.proc
Class MultipleCorrelationAnalysis<V,T extends CorrResult>

java.lang.Object
  extended by sbrt.kernel.math.stat.proc.MultipleCorrelationAnalysis<V,T>
Type Parameters:
V - the variable type.
T - the correlation result type.
All Implemented Interfaces:
KernelProcess<T>, MonitoredProcess<T>

public class MultipleCorrelationAnalysis<V,T extends CorrResult>
extends java.lang.Object
implements MonitoredProcess<T>

This class is used to perform multiple correlation analyses.

Author:
This class was written and documented by Jeremiah Wright while in the Wagner lab.

Constructor Summary
MultipleCorrelationAnalysis(Correlator<V,T> correlator)
          Constructs a new correlation process.
 
Method Summary
 ProgressMonitor getProgress()
          Returns a progress monitor for this process.
 void run(ResultsManager<T> resultsManager)
          Computes the correlation statistic between the x and y values, and adds the results to the provided results manager.
 void setXValues(java.util.Map<? extends V,java.lang.Double> xValues)
          Sets the x values.
 void setYValues(java.lang.Iterable<java.util.Map<V,java.lang.Double>> yValues)
          Sets the source of y values.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MultipleCorrelationAnalysis

public MultipleCorrelationAnalysis(Correlator<V,T> correlator)
Constructs a new correlation process.

Parameters:
correlator - the correlator with which all computations will be performed.
Method Detail

setXValues

public void setXValues(java.util.Map<? extends V,java.lang.Double> xValues)
Sets the x values.

Parameters:
xValues - variables mapped to their respective values.

setYValues

public void setYValues(java.lang.Iterable<java.util.Map<V,java.lang.Double>> yValues)
Sets the source of y values.

Parameters:
yValues - a source of variables mapped to their respective values.

run

public void run(ResultsManager<T> resultsManager)
Computes the correlation statistic between the x and y values, and adds the results to the provided results manager.

Specified by:
run in interface KernelProcess<T extends CorrResult>
Parameters:
resultsManager - the results manager to which the computed results are to be added.

getProgress

public ProgressMonitor getProgress()
Returns a progress monitor for this process.

Specified by:
getProgress in interface MonitoredProcess<T extends CorrResult>
Returns:
a progress monitor for this process.