|
NumericalAnalysisExtensionsStandardDeviation(IEnumerableSingle, Boolean) Method
|
Computes the standard deviation over a sequence of Single values.
Namespace: GSF.NumericalAnalysisAssembly: GSF.Core (in GSF.Core.dll) Version: 2.4.248-beta+a497a19de709fd99e2448886199a2c8824265ddf
Syntaxpublic static float StandardDeviation(
this IEnumerable<float> source,
bool calculateForSample = false
)
<ExtensionAttribute>
Public Shared Function StandardDeviation (
source As IEnumerable(Of Single),
Optional calculateForSample As Boolean = false
) As Single
public:
[ExtensionAttribute]
static float StandardDeviation(
IEnumerable<float>^ source,
bool calculateForSample = false
)
[<ExtensionAttribute>]
static member StandardDeviation :
source : IEnumerable<float32> *
?calculateForSample : bool
(* Defaults:
let _calculateForSample = defaultArg calculateForSample false
*)
-> float32
GSF.NumericalAnalysis.NumericalAnalysisExtensions.StandardDeviation = function(source, calculateForSample);
View SourceParameters
- source IEnumerableSingle
- Source data sample.
- calculateForSample Boolean (Optional)
- Set to true to calculate for estimated population size, or false for full population.
Return Value
SingleThe standard deviation of the sequence.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type
IEnumerableSingle. When you use instance method syntax to call this method, omit the first parameter. For more information, see
Extension Methods (Visual Basic) or
Extension Methods (C# Programming Guide).
ExceptionsException | Condition |
---|
ArgumentNullException | source is null. |
ArgumentOutOfRangeException | source does not contain enough values to produce a result. |
See Also