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, NullableRef<IList<double>> inWeights, float? inDomainStart, float inBinSize, int? inBinCount, bool inCyclic, AvlNet.Histogram outHistogram )
Parameters
| Name | Type | Range | Default | Description | |
|---|---|---|---|---|---|
 | inArray | System.Collections.Generic.IList<float> | Array from which histogram will be generated. | ||
| inWeights | AvlNet.NullableRef<System.Collections.Generic.IList<double>> | Weights corresponding to the elements of 'inArray'. Default value: atl::NIL. | ||
| inDomainStart | float? | Input domain begin. Default value: atl::NIL. | ||
| inBinSize | float | <0.0001f, INF> | 1.0f | Input bin size. Default value: 1.0f. |
| inBinCount | int? | <0, +INF> | Input domain length. Default value: atl::NIL. | |
| inCyclic | bool | False | Determines if input data is cyclic. Default value: False. | |
 | outHistogram | AvlNet.Histogram | Output 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. |
