ILNumerics Ultimate VS

Statisticshistn Method

ILNumerics Ultimate VS Documentation
ILNumerics - Technical Application Development
Calculates the normalized (with the number of the samples) histogram of the given samples.

[ILNumerics Statistics Toolbox]

Namespace:  ILNumerics.Toolboxes
Assembly:  ILNumerics.Toolboxes.Statistics (in ILNumerics.Toolboxes.Statistics.dll) Version: 5.5.0.0 (5.5.7503.3146)
Syntax

public static RetArray<double> histn(
	InArray<double> x,
	int bins = 0,
	double rangeStart = -unendlich,
	double rangeEnd = +unendlich
)

Parameters

x
Type: ILNumericsInArrayDouble
Given data.
bins (Optional)
Type: SystemInt32
Number of the bins [by default 0 - ceiled square root of the samples], specify otherwise.
rangeStart (Optional)
Type: SystemDouble
Start of the range [by default double.NegativeInfinity - minimum value of the samples], specify otherwise.
rangeEnd (Optional)
Type: SystemDouble
End of the range [by default double.PositiveInfinity - maximum value of the samples], specify otherwise.

Return Value

Type: RetArrayDouble
Returns with the observation counts for each bins normalized with the number of elements, yielding the probability for each bin.
Remarks

  • If 'x' is empty, an empty array will be returned.
  • If 'x' is null, an ArgumentException will be thrown.
  • The number of the bins will be the square root of the samples by default.
  • The start of the range is the minimum value of the elements by default.
  • The end of the range is the maximum value of the elements by default.
  • If the 'rangeEnd' ≥ 'rangeStart' an ArgumentException will be thrown.
  • On the limits of the edges, the counting will increment to the left side bin.
  • On the leftmost bin's edge, the counting will increment to the right side bin (first bin).
  • On the rightmost bin's edge, the counting will increment to the left side bin (last bin).
  • Outside of the limits, the occurance will not be counted.
  • All occurance of double.NaN will not be counted.
  • All occurance of double.PositiveInfinity will not be counted.
  • All occurance of double.NegativeInfinity will not be counted.

[ILNumerics Statistics Toolbox]

See Also

Reference