SuanShu, a Java numerical and statistical library

com.numericalmethod.suanshu.stats.descriptive.rank
Class Min

java.lang.Object
  extended by com.numericalmethod.suanshu.stats.descriptive.rank.Min
All Implemented Interfaces:
Statistic

public class Min
extends java.lang.Object
implements Statistic

The minimum of a sample is the smallest value in the sample.

The R equivalent function is min.

See Also:
Wikipedia: Minimum

Constructor Summary
Min()
          Construct an empty Min calculator.
Min(double[] data)
          Construct a Min calculator, initialized with a sample.
Min(Min that)
          Copy constructor.
 
Method Summary
 void addData(double... data)
          Recompute the statistic, incrementally if possible.
 long N()
          Get the size of the sample.
 java.lang.String toString()
           
 double value()
          Get the value of the statistic.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Min

public Min()
Construct an empty Min calculator.


Min

public Min(double[] data)
Construct a Min calculator, initialized with a sample.

Parameters:
data - a sample

Min

public Min(Min that)
Copy constructor.

Parameters:
that - another Min object
Method Detail

addData

public void addData(double... data)
Description copied from interface: Statistic
Recompute the statistic, incrementally if possible.

Specified by:
addData in interface Statistic
Parameters:
data - an array of new items

value

public double value()
Description copied from interface: Statistic
Get the value of the statistic.

Specified by:
value in interface Statistic
Returns:
the statistic

N

public long N()
Description copied from interface: Statistic
Get the size of the sample.

Specified by:
N in interface Statistic
Returns:
the sample size

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

SuanShu, a Java numerical and statistical library

Copyright © 2011 Numerical Method Inc. Ltd. All Rights Reserved.