## Libraries.Compute.Statistics.Calculations.StandardDeviationsFromMean Documentation

This class calculates, for each data point in a column, the number of standard deviations from the mean. In statistics, this is classically called "z-scores."

**Example Code**

```
use Libraries.Compute.Statistics.DataFrame
use Libraries.Compute.Statistics.Calculations.StandardDeviationsFromMean
//Load a comma separated file
DataFrame frame
frame:Load("Data.csv")
StandardDeviationsFromMean zscores
DataFrameColumn column = frame:GetColumn(0)
column:Calculate(zscore
```

*Inherits from: *Libraries.Language.Object, Libraries.Compute.Statistics.DataFrameColumnCalculation

## Summary

### Actions Summary Table

Actions | Description |
---|---|

Add(Libraries.Language.Object value) | If the calculation otherwise has no primitive type, it sends it to the column as a raw object. |

Add(Libraries.Language.Types.Integer value) | |

Add(Libraries.Language.Types.Boolean value) | If the calculation returns true from IsIterable, this is a Boolean object that was passed to the calculation. |

Add(Libraries.Language.Types.Number value) | |

Add(Libraries.Language.Types.Text value) | If the calculation returns true from IsIterable, this is a Text object that was passed to the calculation. |

Calculate(Libraries.Compute.Statistics.DataFrameColumn column) | This action can calculate the equation from a particular column. |

CalculateStandardDeviationFromMean(number value, number mean, number standardDeviation) | This action calculates the number of standard deviations from the mean for a particular value, mean, and standard deviation. |

Compare(Libraries.Language.Object object) | This action compares two object hash codes and returns an integer. |

Empty() | This Calculation can be re-used if the Empty action is called before passing it to another column. |

End(Libraries.Compute.Statistics.DataFrameColumn column) | This action is called at the end of a calculatio |

Equals(Libraries.Language.Object object) | This action determines if two objects are equal based on their hash code values. |

GetHashCode() | This action gets the hash code for an object. |

GetResultColumn() | This returns a new NumberColumn of the same size as the original, filled with values that are the number of standard deviations from the mean. |

IsIterable() | If this action returns true, each element of the column will be sent to this calculation one by one. |

Start(Libraries.Compute.Statistics.DataFrameColumn column) |

## Actions Documentation

### Add(Libraries.Language.Object value)

If the calculation otherwise has no primitive type, it sends it to the column as a raw object. Columns might use this if they have custom type

#### Parameters

### Add(Libraries.Language.Types.Integer value)

#### Parameters

### Add(Libraries.Language.Types.Boolean value)

If the calculation returns true from IsIterable, this is a Boolean object that was passed to the calculation. This may be undefined, which indicates that the column did not contain a value at this position in the colum

#### Parameters

### Add(Libraries.Language.Types.Number value)

#### Parameters

### Add(Libraries.Language.Types.Text value)

If the calculation returns true from IsIterable, this is a Text object that was passed to the calculation. This may be undefined, which indicates that the column did not contain a value at this position in the colum

#### Parameters

### Calculate(Libraries.Compute.Statistics.DataFrameColumn column)

This action can calculate the equation from a particular column. By default this action will only be called if the Calculation is not Iterable. Because the Column class is not guaranteed to have any particular data type, individual Calculation classes may need to cast to a particular column or data type to perform their operations. If a calculation is Iterable, the column will pass all of its data, one by one, to the calculation instea

#### Parameters

### CalculateStandardDeviationFromMean(number value, number mean, number standardDeviation)

This action calculates the number of standard deviations from the mean for a particular value, mean, and standard deviation.

**Example Code**

```
use Libraries.Compute.Statistics.DataFrame
use Libraries.Compute.Statistics.Calculations.StandardDeviationsFromMean
StandardDeviationsFromMean zscores
//the value is at the mean, so this is zero.
output zscores:CalculateStandardDeviationFromMean(2,2,
```

#### Parameters

- number value: the value to calculate for
- number mean: the average value
- number standardDeviation: the total standard deviation

#### Return

number: the number of standard deviations from the mean (z-score)

### Compare(Libraries.Language.Object object)

This action compares two object hash codes and returns an integer. The result is larger if this hash code is larger than the object passed as a parameter, smaller, or equal. In this case, -1 means smaller, 0 means equal, and 1 means larger. This action was changed in Quorum 7 to return an integer, instead of a CompareResult object, because the previous implementation was causing efficiency issues.

**Example Code**

```
Object o
Object t
integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smalle
```

#### Parameters

- Libraries.Language.Object: The object to compare to.

#### Return

integer: The Compare result, Smaller, Equal, or Larger.

### Empty()

This Calculation can be re-used if the Empty action is called before passing it to another column. Otherwise, it retains its dat

### End(Libraries.Compute.Statistics.DataFrameColumn column)

This action is called at the end of a calculatio

#### Parameters

### Equals(Libraries.Language.Object object)

This action determines if two objects are equal based on their hash code values.

**Example Code**

```
use Libraries.Language.Object
use Libraries.Language.Types.Text
Object o
Text t
boolean result = o:Equals(
```

#### Parameters

- Libraries.Language.Object: The to be compared.

#### Return

boolean: True if the hash codes are equal and false if they are not equal.

### GetHashCode()

This action gets the hash code for an object.

**Example Code**

```
Object o
integer hash = o:GetHashCode
```

#### Return

integer: The integer hash code of the object.

### GetResultColumn()

This returns a new NumberColumn of the same size as the original, filled with values that are the number of standard deviations from the mean.

#### Return

Libraries.Compute.Statistics.Columns.NumberColumn: a new colu

### IsIterable()

If this action returns true, each element of the column will be sent to this calculation one by one. If this is false, the column should ask this class to conduct the calculation all at once using the Calculate actio

#### Return

boolean: