OptionalSampleArrayStatistic (adams-pom 24.5.0-SNAPSHOT API)

All Known Implementing Classes:

AbstractOptionalSampleArrayStatistic, ArrayStandardDeviation, ArrayStandardize, ArrayStandardScores
```
public interface OptionalSampleArrayStatistic
```
Interface for array statistics that either work on the population or on the sample.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`boolean`	`getIsSample()`	Returns whether the arrays represent samples instead of populations.
`String`	`isSampleTipText()`	Returns the tip text for this property.
`void`	`setIsSample(boolean value)`	Sets whether the arrays represent samples instead of populations.

- Method Detail
  - setIsSample
```
void setIsSample(boolean value)
```
    Sets whether the arrays represent samples instead of populations.
    
    Parameters:
    
    value - true if arrays are samples and not populations
  - getIsSample
```
boolean getIsSample()
```
    Returns whether the arrays represent samples instead of populations.
    
    Returns:
    
    true if arrays are samples and not populations
  - isSampleTipText
```
String isSampleTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.