repicea.stats.estimates

Class CorrelationEstimate

java.lang.Object

repicea.stats.RandomVariable<D>

repicea.stats.estimates.Estimate<UnknownDistribution>

repicea.stats.estimates.SimpleEstimate

repicea.stats.estimates.CorrelationEstimate

All Implemented Interfaces:

java.io.Serializable, CentralMomentsGettable, CentralMomentsSettable

public class CorrelationEstimate
extends SimpleEstimate

The CorrelationEstimate class represents a Pearson's correlation estimate.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class repicea.stats.estimates.Estimate

Estimate.EstimatorType

Field Summary

Fields inherited from class repicea.stats.estimates.Estimate

estimatorType, rowIndex

Constructor Summary

Constructors

Constructor and Description
CorrelationEstimate(double mean, int sampleSize) Constructor.

Method Summary

Modifier and Type	Method and Description
int	getSampleSize() This method return the sample size.
double	getStudentT() This method returns the t value under the assumption that the true correlation is null.

Methods inherited from class repicea.stats.estimates.SimpleEstimate

getConfidenceIntervalBounds, setMean, setVariance

Methods inherited from class repicea.stats.estimates.Estimate

getDifferenceEstimate, getEstimatorType, getProductEstimate, getProductEstimate, getProductOfManyEstimates, getRandomDeviate, getRowIndex, getSumEstimate, isMergeableEstimate, setRowIndex

Methods inherited from class repicea.stats.RandomVariable

getDistribution, getMean, getVariance

Methods inherited from class java.lang.Object

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

Constructor Detail

CorrelationEstimate

public CorrelationEstimate(double mean,
                           int sampleSize)

Constructor.

Parameters:

mean - the mean correlation

sampleSize - the sample size

Method Detail

getStudentT

public double getStudentT()

This method returns the t value under the assumption that the true correlation is null.

Returns:

a double

getSampleSize

public int getSampleSize()

This method return the sample size.

Returns:

an integer