You are here: Start » AVL.NET » 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 | |
---|---|---|---|---|---|
inValues | System.Collections.Generic.IList<int> | Input array of bin values. | |||
inDomainStart | float | 0.0f | Input domain begin. Default value: 0.0f. | ||
inDomainLength | float | <0.0f, INF> | 256.0f | Input domain length. Default value: 256.0f. | |
inBinSize | float | <0.0f, INF> | 1.0f | Input length of the domain range covered by a single bin. Default value: 1.0f. | |
outHistogram | AvlNet.Histogram | Output 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 bins count is greater than input values count in inValues. |
DomainError | The calculated bins count is less than input values count in inValues. |