Back to Aurora Vision Library Lite website
You are here: Start » Basic » Random » RandomInteger
RandomInteger
Header: | STD.h |
---|---|
Namespace: | avl |
Creates random integer value in given closed interval.
Syntax
void avl::RandomInteger ( RandomState& ioState, const int inMinValue, const int inMaxValue, atl::Optional<int> inSeed, int& outValue )
Parameters
Name | Type | Default | Description | |
---|---|---|---|---|
ioState | RandomState& | Object used to maintain state of the function. | ||
inMinValue | const int | Minimal generated value | ||
inMaxValue | const int | 10 | Maximal generated value | |
inSeed | Optional<int> | NIL | Random seed used to generate values | |
outValue | int& |
Remarks
This filter should not be used for generating cryptographically secure random numbers.
Errors
List of possible exceptions:
Error type | Description |
---|---|
DomainError | Value of inMinValue is greater than value of inMaxValue. |
DomainError | Values inMinValue and inMaxValue are equal. |