You are here: Start » AVL.NET » AVL.CreateHistogram Method
AVL.CreateHistogram Method
Creates the histogram of the array of real numbers.
| Namespace: | AvlNet |
|---|---|
| Assembly: | AVL.NET.dll |
Syntax
public static void CreateHistogram( float[] inArray, int[] inWeights, float inBinSize, float? inDomainStart, float? inDomainLength, out AvlNet.Histogram outHistogram )
Parameters
| Name | Type | Range | Default | Description | |
|---|---|---|---|---|---|
 | inArray | float | Array from which histogram will be generated. | ||
| inWeights | int | Weights corresponding to the elements of 'inArray'. Default value: atl::NIL, or null. | ||
| inBinSize | float | <0.0001f, INF> | 1.0f | Input bin size. Default value: 1.0f. |
| inDomainStart | float? | Input domain begin. Default value: atl::NIL, or null. | ||
| inDomainLength | float? | <0.0001f, INF> | Input domain length. Default value: atl::NIL, or null. | |
 | outHistogram | AvlNet.Histogram | Output histogram. |
Description
The operation creates a histogram of inArray values.
Errors
| Error type | Description |
|---|---|
| DomainError | Input bin width is incorrect in CreateHistogram. |
| DomainError | Input boundaries are incorrect in CreateHistogram. |
| DomainError | Inconsistent array lengths at inArray and inWeights in CreateHistogram. |
| DomainError | Negative weight encountered in CreateHistogram. |
