SuanShu, a Java numerical and statistical library

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

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

public class Max
extends java.lang.Object
implements Statistic

The maximum of a sample is the biggest value in the sample.

The R equivalent function is max.

See Also:
Wikipedia: Maximum

Constructor Summary
Max()
          Construct an empty Max calculator.
Max(double[] data)
          Construct a Max calculator, initialized with a sample.
Max(Max 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

Max

public Max()
Construct an empty Max calculator.


Max

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

Parameters:
data - a sample

Max

public Max(Max that)
Copy constructor.

Parameters:
that - another Max 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.