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

AVL.CreateHistogram

Creates the histogram of the array of real numbers.

Namespace:AvlNet
Assembly:AVL.NET.dll

Syntax

C++
C#
 
public static void CreateHistogram
(
	IList<float> inArray,
	float inBinSize,
	bool inCyclic,
	AvlNet.Histogram outHistogram
)

Parameters

Name Type Range Default Description
inArraySystem.Collections.Generic.IList<float>Array from which histogram will be generated.
inBinSizefloat<0.0001f, INF>1.0fInput bin size. Default value: 1.0f.
inCyclicboolFalseDetermines if input data is cyclic. Default value: False.
outHistogramAvlNet.HistogramOutput histogram.

Description

The operation creates a histogram of inArray values.

Errors

List of possible exceptions:

Error type Description
DomainError Inconsistent array lengths at inArray and inWeights in CreateHistogram.
DomainError Input bin width is incorrect in CreateHistogram.
DomainError Input boundaries are incorrect in CreateHistogram.
DomainError Negative weight encountered in CreateHistogram.
DomainError Output histogram size too large in CreateHistogram.

Function Overrides

See also