grizzled.math.stats

Ordering

Alphabetic
By inheritance

Inherited

Hide All
Show all

stats
AnyRef
Any

Visibility

Public
All

Impl.

Concrete
Abstract

Value Members

def != (arg0: AnyRef) : Boolean

attributes: final
definition classes: AnyRef
def != (arg0: Any) : Boolean

o != arg0 is the same as !(o == (arg0)).

o != arg0 is the same as !(o == (arg0)).
arg0
the object to compare against this object for dis-equality.
returns
false if the receiver object is equivalent to the argument; true otherwise.
attributes: final
definition classes: Any
def ## () : Int

attributes: final
definition classes: AnyRef → Any
def $asInstanceOf [T0] () : T0

attributes: final
definition classes: AnyRef
def $isInstanceOf [T0] () : Boolean

attributes: final
definition classes: AnyRef
def == (arg0: AnyRef) : Boolean

o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).
arg0
the object to compare against this object for equality.
returns
true if the receiver object is equivalent to the argument; false otherwise.
attributes: final
definition classes: AnyRef
def == (arg0: Any) : Boolean

o == arg0 is the same as o.equals(arg0).

o == arg0 is the same as o.equals(arg0).
arg0
the object to compare against this object for equality.
returns
true if the receiver object is equivalent to the argument; false otherwise.
attributes: final
definition classes: Any
def arithmeticMean [T] (items: T*)(implicit n: Numeric[T]) : Double

Calculates the arithmetic mean of the values of the passed-in numbers.

Calculates the arithmetic mean of the values of the passed-in numbers.
items
the numbers on which to operate
returns
the arithmetic mean
def asInstanceOf [T0] : T0

This method is used to cast the receiver object to be of type T0.

This method is used to cast the receiver object to be of type T0.
Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.
returns
the receiver object.
attributes: final
definition classes: Any
def clone () : AnyRef

This method creates and returns a copy of the receiver object.

This method creates and returns a copy of the receiver object.
The default implementation of the clone method is platform dependent.
returns
a copy of the receiver object.
attributes: protected
definition classes: AnyRef
def eq (arg0: AnyRef) : Boolean

This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

This method is used to test whether the argument (arg0) is a reference to the receiver object (this).
The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.
Additionally, the eq method has three other properties. * It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false. * For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false. * null.eq(null) returns true.
When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).
arg0
the object to compare against this object for reference equality.
returns
true if the argument is a reference to the receiver object; false otherwise.
attributes: final
definition classes: AnyRef
def equals (arg0: Any) : Boolean

This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.
The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation]: * It is reflexive: for any instance x of type Any, x.equals(x) should return true. * It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true. * It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same scala.Int (o1.hashCode.equals(o2.hashCode)).
arg0
the object to compare against this object for equality.
returns
true if the receiver object is equivalent to the argument; false otherwise.
definition classes: AnyRef → Any
def finalize () : Unit

This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.
The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.
attributes: protected
definition classes: AnyRef
def geometricMean [T] (items: T*)(implicit n: Numeric[T]) : Double

Calculates the geometric mean of the values of the passed-in numbers, namely, the n-th root of (x1 * x2 * .

Calculates the geometric mean of the values of the passed-in numbers, namely, the n-th root of (x1 * x2 * ... * xn). Note that all numbers used in the calculation of a geometric mean must be positive.
For a discussion of when a geometric mean is more suitable than an arithmetic mean, seehttp://www.math.toronto.edu/mathnet/questionCorner/geomean.html.
items
the numbers on which to operate
returns
the geometric mean
def getClass () : java.lang.Class[_]

Returns a representation that corresponds to the dynamic class of the receiver object.

Returns a representation that corresponds to the dynamic class of the receiver object.
The nature of the representation is platform dependent.
returns
a representation that corresponds to the dynamic class of the receiver object.
attributes: final
definition classes: AnyRef
def harmonicMean [T] (items: T*)(implicit n: Numeric[T]) : Double

Calculates the harmonic mean of the values of the passed-in numbers, namely: n / (1/x^1^ + 1/x^2^ + ... + 1/x^n^).

Calculates the harmonic mean of the values of the passed-in numbers, namely: n / (1/x^1^ + 1/x^2^ + ... + 1/x^n^).
items
the numbers on which to operate
returns
the harmonic mean
def hashCode () : Int

Returns a hash code value for the object.

Returns a hash code value for the object.
The default hashing algorithm is platform dependent.
Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.
returns
the hash code value for the object.
definition classes: AnyRef → Any
def isInstanceOf [T0] : Boolean

This method is used to test whether the dynamic type of the receiver object is T0.

This method is used to test whether the dynamic type of the receiver object is T0.
Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.
returns
true if the receiver object is an instance of erasure of type T0; false otherwise.
attributes: final
definition classes: Any
def mean [T] (items: T*)(implicit n: Numeric[T]) : Double

Synonym for arithmeticMean.
Synonym for arithmeticMean.
1. arithmeticMean
def median [T] (items: T*)(implicit n: Numeric[T]) : Double

Calculates the median of the values of the passed-in numbers.

Calculates the median of the values of the passed-in numbers.
items
the numbers on which to operate
returns
the median
def mode [T] (items: T*)(implicit n: Numeric[T]) : List[T]

Calculates the mode (most common value(s)) of the values of the passed-in numbers.

Calculates the mode (most common value(s)) of the values of the passed-in numbers. If there are multiple common values, they're all returned.
items
the numbers on which to operate
returns
list of modal values
def ne (arg0: AnyRef) : Boolean

o.ne(arg0) is the same as !(o.eq(arg0)).

o.ne(arg0) is the same as !(o.eq(arg0)).
arg0
the object to compare against this object for reference dis-equality.
returns
false if the argument is not a reference to the receiver object; true otherwise.
attributes: final
definition classes: AnyRef
def notify () : Unit

Wakes up a single thread that is waiting on the receiver object's monitor.

Wakes up a single thread that is waiting on the receiver object's monitor.
attributes: final
definition classes: AnyRef
def notifyAll () : Unit

Wakes up all threads that are waiting on the receiver object's monitor.

Wakes up all threads that are waiting on the receiver object's monitor.
attributes: final
definition classes: AnyRef
def popStdDev [T] (items: T*)(implicit n: Numeric[T]) : Double

Shorter synonym for populationStandardDeviation.
Shorter synonym for populationStandardDeviation.
1. populationStandardDeviation
def populationStandardDeviation [T] (items: T*)(implicit n: Numeric[T]) : Double

Calculate the population standard deviation of the specified values.
Calculate the population standard deviation of the specified values. The population standard deviation is merely the square root of the population variance. Thus, this function is just shorthand for:
```
java.lang.Math.sqrt(populationVariance(items))
```
items
the numbers on which to operate
returns
the standard deviation
def populationVariance [T] (items: T*)(implicit n: Numeric[T]) : Double

Calculate the population variance of the finite population defined by the items arguments.
Calculate the population variance of the finite population defined by the items arguments. The population variance is defined as:
```
1
- *  SUM(i=1, N) { (x[i] - mean)^2^ }
N
```
See:
- http://en.wikipedia.org/wiki/Variance#Population_variance_and_sample_variance- http://www.quickmba.com/stats/standard-deviation/
items
the numbers on which to operate
returns
the variance
def range [T] (items: T*)(implicit n: Numeric[T]) : T

Calculate the range of a data set.

Calculate the range of a data set. This function does a single linear pass over the data set.
items
the numbers on which to operate
returns
the range
def sampleStandardDeviation [T] (items: T*)(implicit n: Numeric[T]) : Double

Calculate the sample standard deviation of the specified values.
Calculate the sample standard deviation of the specified values. The sample standard deviation is merely the square root of the sample variance. Thus, this function is just shorthand for:
```
java.lang.Math.sqrt(sampleVariance(items))
```
items
the numbers on which to operate
returns
the standard deviation
def sampleStdDev [T] (items: T*)(implicit n: Numeric[T]) : Double

Shorter synonym for sampleStandardDeviation.
Shorter synonym for sampleStandardDeviation.
1. populationStandardDeviation
def sampleVariance [T] (items: T*)(implicit n: Numeric[T]) : Double

Calculate the unbiased sample variance of the finite sample defined by the items arguments.
Calculate the unbiased sample variance of the finite sample defined by the items arguments. The sample variance is defined as:
```
  1
----- *   SUM(i=1, N) { (x[i] - sampleMean)^2^  }
N - 1
```
See:
- http://en.wikipedia.org/wiki/Variance#Population_variance_and_sample_variance- http://www.quickmba.com/stats/standard-deviation/
items
the numbers on which to operate
returns
the variance
def synchronized [T0] (arg0: T0) : T0

attributes: final
definition classes: AnyRef
def toString () : String

Returns a string representation of the object.

Returns a string representation of the object.
The default representation is platform dependent.
returns
a string representation of the object.
definition classes: AnyRef → Any
def wait () : Unit

attributes: final
definition classes: AnyRef
def wait (arg0: Long, arg1: Int) : Unit

attributes: final
definition classes: AnyRef
def wait (arg0: Long) : Unit

attributes: final
definition classes: AnyRef

stats

object stats extends AnyRef

Value Members

def != (arg0: AnyRef) : Boolean

def != (arg0: Any) : Boolean

def ## () : Int

def $asInstanceOf [T0] () : T0

def $isInstanceOf [T0] () : Boolean

def == (arg0: AnyRef) : Boolean

def == (arg0: Any) : Boolean

def arithmeticMean [T] (items: T*)(implicit n: Numeric[T]) : Double

def asInstanceOf [T0] : T0

def clone () : AnyRef

def eq (arg0: AnyRef) : Boolean

def equals (arg0: Any) : Boolean

def finalize () : Unit

def geometricMean [T] (items: T*)(implicit n: Numeric[T]) : Double

def getClass () : java.lang.Class[_]

def harmonicMean [T] (items: T*)(implicit n: Numeric[T]) : Double

def hashCode () : Int

def isInstanceOf [T0] : Boolean

def mean [T] (items: T*)(implicit n: Numeric[T]) : Double

def median [T] (items: T*)(implicit n: Numeric[T]) : Double

def mode [T] (items: T*)(implicit n: Numeric[T]) : List[T]

def ne (arg0: AnyRef) : Boolean

def notify () : Unit

def notifyAll () : Unit

def popStdDev [T] (items: T*)(implicit n: Numeric[T]) : Double

def populationStandardDeviation [T] (items: T*)(implicit n: Numeric[T]) : Double

def populationVariance [T] (items: T*)(implicit n: Numeric[T]) : Double

def range [T] (items: T*)(implicit n: Numeric[T]) : T

def sampleStandardDeviation [T] (items: T*)(implicit n: Numeric[T]) : Double

def sampleStdDev [T] (items: T*)(implicit n: Numeric[T]) : Double

def sampleVariance [T] (items: T*)(implicit n: Numeric[T]) : Double

def synchronized [T0] (arg0: T0) : T0

def toString () : String

def wait () : Unit

def wait (arg0: Long, arg1: Int) : Unit

def wait (arg0: Long) : Unit

Inherited from AnyRef

Inherited from Any