Back to FabImage Library website

You are here: Start » Function Reference » Basic » Random » CreateRandomArray

CreateRandomArray


Header: STD.h
Namespace: fil
Module: FoundationLite

Creates array with random values.

Syntax

void fil::CreateRandomArray
(
	const int inLength,
	const float inMinValue,
	const float inMaxValue,
	const float inStep,
	ftl::Optional<int> inSeed,
	ftl::Array<float>& outArray
)

Parameters

Name Type Range Default Description
Input value inLength const int 10 Length of output array
Input value inMinValue const float Minimal generated value
Input value inMaxValue const float 10.0f Maximal generated value
Input value inStep const float 0.0001 - 1.0f Minimal difference between two generated values
Input value inSeed Optional<int> NIL Random seed used to generate values
Output value outArray Array<float>&

Remarks

This filter should not be used for generating cryptographically secure random numbers.

Errors

List of possible exceptions:

Error type Description
DomainError Value of inLength is non-positive.
DomainError Value of inMinValue is greater than value of inMaxValue.
DomainError Value of inStep is greater than span between maximal and minimal value.
DomainError Values inMinValue and inMaxValue are equal.