#std

Calculates standard deviation as the square root of variance(values, options).

import { Arith } from "@teakit/arith";

Arith.std(["1", "2", "3"]).toString(); // "0.81649658092772603273"
Arith.std(["1", "2", "3"], { sample: true }).toString(); // "1"

const Short = Arith.clone({ DECIMAL_PLACES: 4 });
Short.std(["1", "2", "3"]).toString(); // "0.8165"

#API Reference

#Signature

Arith.std(values: readonly ArithValue[], options?: ArithSampleOptions): ArithInstance;

#Parameters

#Returns

Returns Arith.variance(values, options).sqrt().

#Throws

• Throws if values is not a non-empty array.
• Throws if any value is non-finite.
• Throws if sample: true is used with fewer than two values.
• Throws if options.sample is not boolean when provided.

#Agent Contract

#Agent Notes

• Use std, not standardDeviation.
• Population standard deviation is the default.