|
NumericalAnalysisExtensionsStandardDeviation(IEnumerableDouble, Boolean) Method
|
Computes the standard deviation over a sequence of Double values.
Namespace: GSF.NumericalAnalysisAssembly: GSF.Core (in GSF.Core.dll) Version: 2.4.249-beta+56964f8aed6f3f2e54faec1539f7ce0ba6548fdf
Syntaxpublic static double StandardDeviation(
this IEnumerable<double> source,
bool calculateForSample = false
)
<ExtensionAttribute>
Public Shared Function StandardDeviation (
source As IEnumerable(Of Double),
Optional calculateForSample As Boolean = false
) As Double
public:
[ExtensionAttribute]
static double StandardDeviation(
IEnumerable<double>^ source,
bool calculateForSample = false
)
[<ExtensionAttribute>]
static member StandardDeviation :
source : IEnumerable<float> *
?calculateForSample : bool
(* Defaults:
let _calculateForSample = defaultArg calculateForSample false
*)
-> float
GSF.NumericalAnalysis.NumericalAnalysisExtensions.StandardDeviation = function(source, calculateForSample);
View SourceParameters
- source IEnumerableDouble
- Source data sample.
- calculateForSample Boolean (Optional)
- Set to true to calculate for estimated population size, or false for full population.
Return Value
DoubleThe 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
IEnumerableDouble. 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