You are here: Start » AVL.NET » AVL.MakeHistogram

AVL.MakeHistogram

Creates a histogram assuming given bin values.

Namespace:AvlNet
Assembly:AVL.NET.dll

Syntax

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

Parameters

Name Type Range Default Description
inValuesSystem.Collections.Generic.IList<int>Input array of bin values.
inDomainStartfloat0.0fInput domain begin. Default value: 0.0f.
inDomainLengthfloat<0.0f, INF>256.0fInput domain length. Default value: 256.0f.
inBinSizefloat<0.0f, INF>1.0fInput length of the domain range covered by a single bin. Default value: 1.0f.
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 Non-positive value of inBinSize in MakeHistogram.
DomainError The calculated bin count is greater than input values count in MakeHistogram.
DomainError The calculated bin count is less than input values count in MakeHistogram.

See also