edu.ucla.sspace.matrix

Class Statistics

java.lang.Object

edu.ucla.sspace.matrix.Statistics

public class Statistics
extends Object

This class provides some simple statistical evaluation methods over a matrix. The average and standard devation of a matrix can be computed for either all values, all values in a each row, or all values in each column. This is models after the statstics methods provided by NumPy.

Author:

Keith Stevens

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Statistics.Dimension The dimension over which the statistic should be evaluated.

Constructor Summary

Constructors

Constructor and Description
Statistics()

Method Summary

Methods

Modifier and Type	Method and Description
static Matrix	average(Matrix m, Statistics.Dimension dim) Return a matrix containing the averages for the dimension specificed.
static Matrix	average(Matrix m, Statistics.Dimension dim, int errorCode) Return a matrix containing the averages for the dimension specificed.
static Matrix	std(Matrix m, Matrix average, Statistics.Dimension dim) Return a matrix containing the standard deviation for the dimension specificed.
static Matrix	std(Matrix m, Matrix average, Statistics.Dimension dim, int errorCode) Return a matrix containing the standard deviation for the dimension specificed.

Methods inherited from class java.lang.Object

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

Constructor Detail

Statistics

public Statistics()

Method Detail

std

public static Matrix std(Matrix m,
         Matrix average,
         Statistics.Dimension dim)

Return a matrix containing the standard deviation for the dimension specificed. If average is null, the average will be computed first. Otherwise it is checked that the average the required dimension size

Parameters:

m - The matrix containing values to evaluate.

average - The matrix of average values along dim

dim - The dimension across which analysis should take place.

Returns:

A matrix of the standard deviations.

Throws:

IllegalArgumentException - if average is not formatted such that it matches the requested dimension to compute over.

average

public static Matrix average(Matrix m,
             Statistics.Dimension dim)

Return a matrix containing the averages for the dimension specificed.

Parameters:

m - The matrix containing values to evaluate.

dim - The dimension across which analysis should take place.

Returns:

A matrix of the averages.

std

public static Matrix std(Matrix m,
         Matrix average,
         Statistics.Dimension dim,
         int errorCode)

Return a matrix containing the standard deviation for the dimension specificed. If average is null, the average will be computed first. Otherwise it is checked that the average the required dimension size

Parameters:

m - The matrix containing values to evaluate.

average - The matrix of average values along dim

dim - The dimension across which analysis should take place.

errorCode - If values equal this value they will not be counted.

Returns:

A matrix of the standard deviations.

average

public static Matrix average(Matrix m,
             Statistics.Dimension dim,
             int errorCode)

Return a matrix containing the averages for the dimension specificed.

Parameters:

m - The matrix containing values to evaluate.

dim - The dimension across which analysis should take place.

errorCode - If values equal this value they will not be counted.

Returns:

A matrix of the averages.