Functions to create, modify, use, and destroy randomEngine objects.
More...
Functions to create, modify, use, and destroy randomEngine objects.
A af::randomEngine object can be used to generate psuedo random numbers using various types of random number generation algorithms defined by af::randomEngineType.
◆ af_create_random_engine()
C Interface for creating random engine.
- Parameters
-
[out] | engine | The pointer to the returned random engine object |
[in] | rtype | The type of the random number generator |
[in] | seed | The initializing seed of the random number generator |
- Returns
- AF_SUCCESS if the execution completes properly
◆ af_random_engine_get_seed()
C Interface for getting the seed of a random engine.
- Parameters
-
[out] | seed | The pointer to the returned seed. |
[in] | engine | The random engine object |
- Returns
- AF_SUCCESS if the execution completes properly
◆ af_random_engine_get_type()
C Interface for getting random engine type.
- Parameters
-
[out] | rtype | The type of the random number generator |
[in] | engine | The random engine object |
- Returns
- AF_SUCCESS if the execution completes properly
◆ af_random_engine_set_seed()
C Interface for setting the seed of a random engine.
- Parameters
-
[out] | engine | The pointer to the returned random engine object |
[in] | seed | The initializing seed of the random number generator |
- Returns
- AF_SUCCESS if the execution completes properly
◆ af_random_engine_set_type()
C Interface for changing random engine type.
- Parameters
-
[in] | engine | The random engine object |
[in] | rtype | The type of the random number generator |
- Returns
- AF_SUCCESS if the execution completes properly
◆ af_release_random_engine()
C Interface for releasing random engine.
- Parameters
-
[in] | engine | The random engine object |
- Returns
- AF_SUCCESS if the execution completes properly
◆ af_retain_random_engine()
C Interface for retaining random engine.
- Parameters
-
[out] | out | The pointer to the returned random engine object |
[in] | engine | The random engine object |
- Returns
- AF_SUCCESS if the execution completes properly