SampleSet (ojAlgo 47.2.0 API)

java.lang.Object
- org.ojalgo.random.SampleSet

All Implemented Interfaces:: Access1D<Double>, Structure1D

public final class SampleSet
extends Object
implements Access1D<Double>

Nested Class Summary
- Nested classes/interfaces inherited from interface org.ojalgo.structure.Access1D
  Access1D.Aggregatable<N extends Number>, Access1D.Collectable<N extends Number,R extends Mutate1D.Receiver<N>>, Access1D.Elements, Access1D.ElementView<N extends Number>, Access1D.IndexOf, Access1D.Sliceable<N extends Number>, Access1D.Visitable<N extends Number>
- Nested classes/interfaces inherited from interface org.ojalgo.structure.Structure1D
  Structure1D.BasicMapper<T>, Structure1D.IndexCallback, Structure1D.IndexMapper<T>, Structure1D.IntIndex, Structure1D.Logical<S extends Structure1D,B extends Structure1D.Logical<S,?>>, Structure1D.LongIndex, Structure1D.LoopCallback

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static double`	`calculateVariance(double sumOfValues, double sumOfSquaredValues, int numberOfValues)`
`long`	`count()`
`double`	`doubleValue(long index)`
`Double`	`get(long index)`
`double`	`getCorrelation(SampleSet anotherSampleSet)`
`double`	`getCovariance(SampleSet anotherSampleSet)`
`double`	`getFirst()`
`double`	`getInterquartileRange()`
`double`	`getLargest()` max(abs(value))
`double`	`getLast()`
`double`	`getMaximum()` max(value)
`double`	`getMean()`
`double`	`getMedian()` Potentially expensive as it requires copying and sorting of the samples.
`double`	`getMinimum()` min(value)
`double`	`getQuartile1()` Potentially expensive as it requires copying and sorting of the samples.
`double`	`getQuartile2()` Potentially expensive as it requires copying and sorting of the samples.
`double`	`getQuartile3()` Potentially expensive as it requires copying and sorting of the samples.
`double`	`getSmallest()` min(abs(value))
`double`	`getStandardDeviation()`
`double`	`getStandardScore(long index)` The standard score is the (signed) number of standard deviations an observation or datum is above the mean.
`double`	`getSumOfSquares()` Sum of squares is a concept that permeates much of inferential statistics and descriptive statistics.
`double[]`	`getValues()`
`double`	`getVariance()`
`static SampleSet`	`make()`
`static SampleSet`	`make(RandomNumber randomNumber, int size)`
`void`	`reset()` If the underlying `Access1D` of samples is modified you must reset the sample set before using.
`int`	`size()`
`SampleSet`	`swap(Access1D<?> samples)` Replace the underlying samples and reset the sample set.
`String`	`toString()`
`static SampleSet`	`wrap(Access1D<?> someSamples)`
`static SampleSet`	`wrap(double[] someSamples)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.ojalgo.structure.Access1D
asCollectable1D, asPrimitive1D, axpy, byteValue, dot, elements, equals, floatValue, hashCode, intValue, longValue, nonzeros, shortValue, supplyTo, toRawCopy1D, toString, wrap, wrap

Methods inherited from interface org.ojalgo.structure.Structure1D
index, loopAll, loopMatching, loopRange, mapper

- Method Detail
  - calculateVariance
```
public static double calculateVariance(double sumOfValues,
                                       double sumOfSquaredValues,
                                       int numberOfValues)
```
    Parameters:
    
    sumOfValues - The sum of all values in a sample set
    
    sumOfSquaredValues - The sum of all squared values, in a sample set
    
    numberOfValues - The number of values in the sample set
    
    Returns:
    
    The sample set's variance
  - make
```
public static SampleSet make()
```
  - make
```
public static SampleSet make(RandomNumber randomNumber,
                             int size)
```
  - wrap
```
public static SampleSet wrap(Access1D<?> someSamples)
```
  - wrap
```
public static SampleSet wrap(double[] someSamples)
```
    Specified by:
    
    wrap in interface Access1D<Double>
  - count
```
public long count()
```
    Specified by:
    
    count in interface Structure1D
    
    Returns:
    
    The total number of elements in this structure.
  - doubleValue
```
public double doubleValue(long index)
```
    Specified by:
    
    doubleValue in interface Access1D<Double>
  - get
```
public Double get(long index)
```
    Specified by:
    
    get in interface Access1D<Double>
  - getCorrelation
```
public double getCorrelation(SampleSet anotherSampleSet)
```
  - getCovariance
```
public double getCovariance(SampleSet anotherSampleSet)
```
  - getFirst
```
public double getFirst()
```
  - getInterquartileRange
```
public double getInterquartileRange()
```
  - getLargest
```
public double getLargest()
```
    max(abs(value))
  - getLast
```
public double getLast()
```
  - getMaximum
```
public double getMaximum()
```
    max(value)
  - getMean
```
public double getMean()
```
  - getMedian
```
public double getMedian()
```
    Potentially expensive as it requires copying and sorting of the samples.
  - getMinimum
```
public double getMinimum()
```
    min(value)
  - getQuartile1
```
public double getQuartile1()
```
    Potentially expensive as it requires copying and sorting of the samples.
  - getQuartile2
```
public double getQuartile2()
```
    Potentially expensive as it requires copying and sorting of the samples.
  - getQuartile3
```
public double getQuartile3()
```
    Potentially expensive as it requires copying and sorting of the samples.
  - getSmallest
```
public double getSmallest()
```
    min(abs(value))
  - getStandardDeviation
```
public double getStandardDeviation()
```
  - getStandardScore
```
public double getStandardScore(long index)
```
    The standard score is the (signed) number of standard deviations an observation or datum is above the mean. Thus, a positive standard score indicates a datum above the mean, while a negative standard score indicates a datum below the mean. It is a dimensionless quantity obtained by subtracting the population mean from an individual raw score and then dividing the difference by the population standard deviation.
    
    See Also:
    
    WikipediA
  - getSumOfSquares
```
public double getSumOfSquares()
```
    Sum of squares is a concept that permeates much of inferential statistics and descriptive statistics. More properly, it is "the sum of the squared deviations". Mathematically, it is an unscaled, or unadjusted measure of dispersion (also called variability). When scaled for the number of degrees of freedom, it estimates the variance, or spread of the observations about their mean value.
    
    See Also:
    
    WikipediA
  - getValues
```
public double[] getValues()
```
    Returns:
    
    A copy of the internal data (the samples).
  - getVariance
```
public double getVariance()
```
  - reset
```
public void reset()
```
    If the underlying Access1D of samples is modified you must reset the sample set before using.
  - size
```
public int size()
```
    Specified by:
    
    size in interface Structure1D
  - swap
```
public SampleSet swap(Access1D<?> samples)
```
    Replace the underlying samples and reset the sample set.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class SampleSet

Nested Class Summary

Nested classes/interfaces inherited from interface org.ojalgo.structure.Access1D

Nested classes/interfaces inherited from interface org.ojalgo.structure.Structure1D

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.ojalgo.structure.Access1D

Methods inherited from interface org.ojalgo.structure.Structure1D

Method Detail

calculateVariance

make

make

wrap

wrap

count

doubleValue

get

getCorrelation

getCovariance

getFirst

getInterquartileRange

getLargest

getLast

getMaximum

getMean

getMedian

getMinimum

getQuartile1

getQuartile2

getQuartile3

getSmallest

getStandardDeviation

getStandardScore

getSumOfSquares

getValues

getVariance

reset

size

swap

toString