You are here: Start » AVL.NET » Function Reference » Histogram » Histogram Basics » AVL.MakeHistogram

AVL.MakeHistogram

Creates a histogram out of an array of bin values.

Namespace:AvlNet
Assembly:AVL.NET.dll

Syntax

C++
C#
 
public static void MakeHistogram
(
	IList<double> inValues,
	float inDomainStart,
	float inBinSize,
	int inStartIndex,
	AvlNet.Histogram outHistogram
)

Parameters

Name Type Range Default Description
inValuesSystem.Collections.Generic.IList<double>Input array of bin values.
inDomainStartfloat0.0fInput domain begin. Default value: 0.0f.
inBinSizefloat<0.0f, INF>1.0fInput length of the domain range covered by a single bin. Default value: 1.0f.
inStartIndexint<0, +INF>0Index of the first bin in the values array. Default value: 0.
outHistogramAvlNet.HistogramOutput histogram.

Remarks

The calculated bin count must be equal to element count of the inValues array.

Errors

List of possible exceptions:

Error type Description
DomainError Empty inValues array on input in MakeHistogram.
DomainError Input inStartIndex out of bound in MakeHistogram.
DomainError Non-positive value of inBinSize in MakeHistogram.
DomainError Not enough data to fill all bins or inBinCount too large in MakeHistogram.

Function Overrides

See also