com.github.jessemull.microflexinteger.stat

Class SampleVariance

java.lang.Object

com.github.jessemull.microflexinteger.stat.DescriptiveStatistic

com.github.jessemull.microflexinteger.stat.DescriptiveStatisticWeights

com.github.jessemull.microflexinteger.stat.SampleVariance

public class SampleVariance
extends DescriptiveStatisticWeights

This class calculates the sample variance of integer plate stacks, plates, wells and well sets as the sum of the second moment divided by the number of values less one.

From wikipedia: a weight function is a mathematical device used when performing a sum, integral, or average to give some elements more "weight" or influence on the result than other elements in the same set. In statistics a weighted function is often used to correct bias. The weighted statistic class implements a weighted function by accepting an array of values as weights. The values in each well of the stack, plate, set or well are multiplied by the values within the double array prior to the statistical calculation.

Weighted statistical operations can be performed on stacks, plates, sets and wells using standard or aggregated functions. Standard functions calculate the desired statistic for each well in the stack, plate or set. Aggregated functions aggregate the values from all the wells in the stack, plate or set and perform the weighted statistical operation on the aggregated values. Both standard and aggregated functions can be performed on a subset of data within the stack, plate, set or well.

The methods within the MicroFlex library are meant to be flexible and the descriptive statistic object supports operations using a single stack, plate, set or well as well as collections and arrays of stacks, plates, sets or wells.

Operation	Beginning Index	Length of Subset	Input/Output
Standard	+/-	+/-	Accepts a single well, set, plate or stack and an array of weights as input Multiplies the values in each well of a well, set, plate or stack by the values in the weights array then calculates the statistic using the weighted values
Aggregated	+/-	+/-	Accepts a single well/set/plate/stack or a collection/array of wells/sets/plates/stacks and an array of weights as input Multiplies the values in each well of a well, set, plate or stack by the values in the weights array, aggregates the data from all the wells in the well/set/plate/stack then calculates the statistic using the aggregated weighted values

Author:

Jesse L. Mull

Constructor Summary

Constructors

Constructor and Description
SampleVariance()

Method Summary

Modifier and Type	Method and Description
double	calculate(List<Double> list) Calculates the sample variance.
double	calculate(List<Double> list, double[] weights) Calculates the weighted sample variance.
double	calculate(List<Double> list, double[] weights, int begin, int length) Calculates the weighted sample variance of the values between the beginning and ending indices.
double	calculate(List<Double> list, int begin, int length) Calculates the sample variance of the values between the beginning and ending indices.
double	mean(List<Double> list) Calculates the mean.

Methods inherited from class com.github.jessemull.microflexinteger.stat.DescriptiveStatisticWeights

plate, plate, platesAggregated, platesAggregated, platesAggregated, platesAggregated, platesAggregated, platesAggregated, set, set, setsAggregated, setsAggregated, setsAggregated, setsAggregated, setsAggregated, setsAggregated, well, well

Methods inherited from class com.github.jessemull.microflexinteger.stat.DescriptiveStatistic

plate, plate, platesAggregated, platesAggregated, platesAggregated, platesAggregated, platesAggregated, platesAggregated, set, set, setsAggregated, setsAggregated, setsAggregated, setsAggregated, setsAggregated, setsAggregated, well, well

Methods inherited from class java.lang.Object

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

Constructor Detail

SampleVariance

public SampleVariance()

Method Detail

calculate

public double calculate(List<Double> list)

Calculates the sample variance.

Specified by:

calculate in class DescriptiveStatistic

Parameters:

List - the list

Returns:

the result

calculate

public double calculate(List<Double> list,
                        double[] weights)

Calculates the weighted sample variance.

Specified by:

calculate in class DescriptiveStatisticWeights

Parameters:

List - the list

double[] - weights for the data set

Returns:

the result

calculate

public double calculate(List<Double> list,
                        int begin,
                        int length)

Calculates the sample variance of the values between the beginning and ending indices.

Specified by:

calculate in class DescriptiveStatistic

Parameters:

List - the list

int - beginning index of subset

int - length of subset

Returns:

the result

calculate

public double calculate(List<Double> list,
                        double[] weights,
                        int begin,
                        int length)

Calculates the weighted sample variance of the values between the beginning and ending indices.

Specified by:

calculate in class DescriptiveStatisticWeights

Parameters:

List - the list

double[] - weights of the data set

int - beginning index of subset

int - length of subset

Returns:

the result

mean

public double mean(List<Double> list)

Calculates the mean.

Parameters:

List - the list

Returns:

the result