MeanScale (anchor-math 0.2.1 API)

org.anchoranalysis.math.statistics.MeanScale

public class MeanScale
extends Object

Stores the mean and scale for a distribution.

The scale is often the standard-deviation.

Author:: Owen Feehan

Constructor Summary

Constructors

Constructor Description

MeanScale()

MeanScale(double mean, double scale)

Method Summary

Modifier and Type	Method	Description
`protected boolean`	`canEqual(Object other)`
`boolean`	`equals(Object o)`
`double`	`getMean()`	The mean.
`double`	`getScale()`	The scale, typically the standard-deviation.
`int`	`hashCode()`
`void`	`setMean(double mean)`	The mean.
`void`	`setScale(double scale)`	The scale, typically the standard-deviation.
`String`	`toString()`
`double`	`zScore(double value)`	Converts a value to a z-score given the parameterization in this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details
- MeanScale
  
  public MeanScale(double mean, double scale)
- MeanScale
  
  public MeanScale()
Method Details
- zScore
  
  public double zScore(double value)
  
  Converts a value to a z-score given the parameterization in this object.
  See Standard score on Wikipedia.
  
  Parameters:
  
  value - the value to convert.
  
  Returns:
  
  the value converted to a z-score.
- getMean
  
  public double getMean()
  
  The mean.
- getScale
  
  public double getScale()
  
  The scale, typically the standard-deviation.
- setMean
  
  public void setMean(double mean)
  
  The mean.
- setScale
  
  public void setScale(double scale)
  
  The scale, typically the standard-deviation.
- equals
  
  public boolean equals(Object o)
  
  Overrides:
  
  equals in class Object
- canEqual
  
  protected boolean canEqual(Object other)
- hashCode
  
  public int hashCode()
  
  Overrides:
  
  hashCode in class Object
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object