Random Engine

class arrayfire.library.random.RandomEngine(engine_type: RandomEngineType = RandomEngineType.PHILOX, seed: int = 0)

Bases: object

Class to handle random number generator engines.

Parameters

engine_typeRandomEngineType, optional, default: RandomEngineType.PHILOX

Specifies the type of random engine to be created. Can be one of: - RandomEngineType.PHILOX - RandomEngineType.THREEFRY - RandomEngineType.MERSENNE

seedint, optional, default: 0

Specifies the seed for the random engine.

classmethod from_engine(engine: AFRandomEngineHandle) → RandomEngine

Create a RandomEngine instance from an existing RandomEngine handle.

Parameters

enginewrapper.AFRandomEngineHandle

The existing RandomEngine handle.

Returns

RandomEngine

A new RandomEngine instance created from the provided engine handle.

get_engine() → AFRandomEngineHandle

Get the ArrayFire random engine handle.

Returns

wrapper.AFRandomEngineHandle

The ArrayFire random engine handle associated with this RandomEngine instance.

get_seed() → int

Get the seed for the random engine.

Returns

int

The seed value of the random engine.

get_type() → RandomEngineType

Get the type of the random engine.

Returns

RandomEngineType

The type of the random engine.

set_seed(seed: int) → None

Set the seed for the random engine.

Parameters

seedint

Specifies the seed to be set for the random engine.

set_type(engine_type: RandomEngineType) → None

Set the type of the random engine.

Parameters

engine_typeRandomEngineType

Specifies the type of the random engine to be set.