You are here: Start » AVL.NET » Function Reference » Histogram » Histogram Basics » AVL.CreateUniformHistogram
AVL.CreateUniformHistogram
Creates a uniform histogram of desired parameters with common value of all bins.
| Namespace: | AvlNet |
|---|---|
| Assembly: | AVL.NET.dll |
Syntax
C++
C#
public static void CreateUniformHistogram ( double inValue, float inDomainStart, float inBinSize, int inBinCount, AvlNet.Histogram outHistogram )
Parameters
| Name | Type | Range | Default | Description | |
|---|---|---|---|---|---|
 | inValue | double | Common value for all bins of the constructed histogram. | ||
| inDomainStart | float | 0.0f | First value of the domain represented by the histogram. Default value: 0.0f. | |
| inBinSize | float | <0.0f, INF> | 1.0f | Length of the domain section represented by each bin. Default value: 1.0f. |
| inBinCount | int | <1, +INF> | 1 | Length of the domain represented by the histogram. Default value: 1. |
 | outHistogram | AvlNet.Histogram | The resulting histogram. |
Description
The operation creates a histogram composed from equally valued bins representing the given domain.
Examples
CreateUniformHistogram run with inValue = 10.
Errors
List of possible exceptions:
| Error type | Description |
|---|---|
| DomainError | Non-positive bin width in CreateUniformHistogram. |
