mirror of
https://github.com/ETLCPP/etl.git
synced 2026-06-15 16:36:03 +08:00
4a88884b39
* Add ranges * Initial Hugo setup * Work in progress * Added selection for local or remote site * Updated to 'light' theme * Changed to using Hextra Hugo theme * Changed to using Hextra Hugo theme * Changed to Hextra Hugo theme * Change to Hextra Hugo theme * Updated Hugo setup. * Updated Hugo setup. # Conflicts: # docs/releases/_index.md * Work in progress * Added new fonts Added new documentation * Latest documentation updates * Latest documentation updates # Conflicts: # docs/containers/array.md # docs/containers/array_view.md # docs/containers/array_wrapper.md # docs/containers/bip_buffer_spsc_atomic.md # docs/containers/bitset.md # docs/containers/indirect_vector.md # docs/containers/vector.md # docs/getting-started/compilers.md * Added bloom_filter markdown doc * Added more documentation Updated CSS for light and dark modes * Fixed some menus Added mode documentation files * Updated CSS rules Added badges to home page Added uniqur_ptr + pool tutorial * Fixed formatting on the home page markdown Modified light amd dark code formatting * Updated unique_ptr-with-pool * Added container and shared message tutorials * Updates to documentation * Added const_multimap * Updated source-formatting.md * Added initial raw text files form Web site editor * Innore coverage build directory * Exported raw text documentation files from the web site editor * Hugo updates * Added Hugo intalation and markdown descriptions * More addition to the documentation * Added closure.md and updates to delegate.md * Added format.md * Added documentation for etl::delegate_observable, etl::function, Base64 codec * Added io_port documentation * Added basic_format_spec * Added documentation for string_stream and string utilities. * Added more documentation Updated the documentation CSS * Added documentation for clocks, day, duration * Added more documentation for chrono classes Updated callouts * More chrono documentation * Completed chrono documentation * Maths functions documentation * Completed maths documentation * Completed maths documentation * Completed maths documentation * Completed maths documentation * Added multiple documentation files * Added iterator.md * Added debug_count.md and versions.md * Added debug_count.md and versions.md * Added more documentation * More documentation * Added some design pattern documentation Modified some of the layout files Modified the About documentation * Converted more documentation pages Modified the site CSS * Added more documentation Moced some documentation files to new directories * Added more documentation Tweaks to CSS * Added callback_timer_deferred_locked documentation * Added callback_timer_locked documentation * More documentation updates * More documentation updates * More documentation updates * New documentation files. Harmonised file name format * New documentation files. * Multiple document updates * Multiple document updates * Final conversion of web pages * Updates before PR * Updates before PR * Updates before PR # Conflicts: # docs/blog/_index.md * Final pre PR updates * Updates to message framework documentation * Renamed directory * Fix spelling * Added author and date to blog files Moved documentation files merged from development * Fixed 'Description' typo * Fix typos # Conflicts: # docs/IO/io_port.md # docs/containers/sets/const-multiset.md # docs/containers/sets/const-set.md # docs/maths/correlation.md # docs/maths/gamma.md * Renamed two files to lower case * Minor renaming * Added author and date * Updated callout on bresenham_line.md Added support for showing the ETL version on the documentation first page, by copying the version.txt file as a hugo asset. Updated the Python 'update_release.py' to copy 'version.txt' * Replace space in filename with hyphen. Added more information to hugo-commands.md * Replace space in filename with hyphen. Added more information to hugo-commands.md # Conflicts: # docs/getting-started/view-the-docs-locally/hugo-commands.md * Added a link to pseudo_moving_average.md * Updated title pages for groups * Fixed missing 404 for non-existent pages * Fixed coordinate variable names in the 'Calculating the intersection' example --------- Co-authored-by: Roland Reichwein <Roland.Reichwein@bmw.de> Co-authored-by: John Wellbelove <john.wellbelove@etlcpp.com> Co-authored-by: John Wellbelove <john.wellbelove@etlcpp.co.uk>
326 lines
5.6 KiB
Markdown
326 lines
5.6 KiB
Markdown
---
|
|
title: "random"
|
|
---
|
|
|
|
Utilities for producing random numbers.
|
|
|
|
## random
|
|
The base class for all 32 bit random number generators.
|
|
|
|
If `ETL_POLYMORPHIC_RANDOM` is defined, then the base class will have the following members, otherwise the base is empty.
|
|
|
|
```cpp
|
|
virtual ~random();
|
|
virtual void initialise(uint32_t seed) = 0;
|
|
virtual uint32_t operator()() = 0;
|
|
virtual uint32_t range(uint32_t low, uint32_t high) = 0;
|
|
```
|
|
|
|
## random_xorshift
|
|
Uses a 128bit XOR shift algorithm for producing a pseudo-random sequence of integers.
|
|
The result is a 32 bit integer between 0 and 4,294,967,295 (2^32 - 1).
|
|
|
|
```cpp
|
|
random_xor_shift()
|
|
```
|
|
**Description**
|
|
Constructor.
|
|
Uses the address of the object as the seed for the sequence.
|
|
|
|
---
|
|
|
|
```cpp
|
|
random_xor_shift(uint32_t seed)
|
|
```
|
|
**Description**
|
|
Constructor.
|
|
Uses seed as the `seed` for the sequence.
|
|
|
|
---
|
|
|
|
```cpp
|
|
void initialise(uint32_t seed)
|
|
```
|
|
**Description**
|
|
Sets the seed as the new seed for the sequence.
|
|
|
|
---
|
|
|
|
```cpp
|
|
uint32_t operator()()
|
|
```
|
|
**Return**
|
|
The next number in the pseudo-random sequence.
|
|
|
|
---
|
|
|
|
```cpp
|
|
uint32_t range(uint32_t low, uint32_t high)
|
|
```
|
|
** Return**
|
|
A number between the specified ranges, inclusive.
|
|
|
|
## random_lcg
|
|
Generates a 32 bit pseudo-random number using a linear congruent generator.
|
|
The result is a 32 bit integer between 0 and 2,147,483,647 (2^31 - 1).
|
|
|
|
```cpp
|
|
random_lcg()
|
|
```
|
|
**Description**
|
|
Constructor.
|
|
Uses the address of the object as the seed for the sequence
|
|
|
|
---
|
|
```cpp
|
|
random_lcg(uint32_t seed)
|
|
```
|
|
**Description**
|
|
Constructor.
|
|
Uses seed as the seed for the sequence.
|
|
|
|
---
|
|
|
|
```cpp
|
|
void initialise(uint32_t seed)
|
|
```
|
|
**Description**
|
|
Sets the seed as the new seed for the sequence.
|
|
|
|
---
|
|
|
|
```cpp
|
|
uint32_t operator()()
|
|
```
|
|
**Return**
|
|
The next number in the pseudo-random sequence.
|
|
|
|
---
|
|
|
|
```cpp
|
|
uint32_t range(uint32_t low, uint32_t high)
|
|
```
|
|
**Return**
|
|
A number between the specified ranges, inclusive.
|
|
|
|
## random_clcg
|
|
Generates a 32 bit pseudo-random number using a combined linear congruent generator.
|
|
The result is a 32 bit integer between 0 and 2,147,483,647 (2^31 - 1).
|
|
|
|
```cpp
|
|
random_clcg()
|
|
```
|
|
**Description**
|
|
Constructor.
|
|
Uses the address of the object as the seed for the sequence.
|
|
|
|
---
|
|
|
|
```cpp
|
|
random_clcg(uint32_t seed)
|
|
```
|
|
**Description**
|
|
Constructor.
|
|
Uses seed as the seed for the sequence.
|
|
|
|
---
|
|
|
|
```cpp
|
|
void initialise(uint32_t seed)
|
|
```
|
|
**Description**
|
|
Sets the seed as the new seed for the sequence.
|
|
|
|
---
|
|
|
|
```cpp
|
|
uint32_t operator()()
|
|
```
|
|
**Return**
|
|
The next number in the pseudo-random sequence.
|
|
|
|
---
|
|
|
|
```cpp
|
|
uint32_t range(uint32_t low, uint32_t high)
|
|
```
|
|
**Return**
|
|
A number between the specified ranges, inclusive.
|
|
|
|
## random_lsfr
|
|
Generates a 32 bit pseudo-random number using a linear shift feedback register.
|
|
The result is a 32 bit integer between 1 and 4,294,967,295 (2^32 - 1).
|
|
The seed must not be zero. The output does not include zero.
|
|
|
|
```cpp
|
|
random_lsfr()
|
|
```
|
|
**Description**
|
|
Constructor.
|
|
Uses the address of the object as the seed for the sequence.
|
|
|
|
---
|
|
|
|
```cpp
|
|
random_lsfr(uint32_t seed)
|
|
```
|
|
**Description**
|
|
Constructor.
|
|
Uses seed as the seed for the sequence.
|
|
|
|
---
|
|
|
|
```cpp
|
|
void initialise(uint32_t seed)
|
|
```
|
|
**Description**
|
|
Sets the seed as the new seed for the sequence.
|
|
|
|
```cpp
|
|
uint32_t operator()()
|
|
```
|
|
**Return**
|
|
The next number in the pseudo-random sequence.
|
|
|
|
---
|
|
|
|
```cpp
|
|
uint32_t range(uint32_t low, uint32_t high)
|
|
```
|
|
**Return**
|
|
A number between the specified ranges, inclusive.
|
|
|
|
## random_mwc
|
|
Generates a 32 bit pseudo-random number using a multiply-with-carry algorithm.
|
|
The result is a 32 bit integer between 1 and 4,294,967,295 (2^32 - 1).
|
|
|
|
```cpp
|
|
random_mwc()
|
|
```
|
|
**Description**
|
|
Constructor.
|
|
Uses the address of the object as the seed for the sequence.
|
|
|
|
---
|
|
|
|
```cpp
|
|
random_mwc(uint32_t seed)
|
|
```
|
|
**Description**
|
|
Constructor.
|
|
Uses seed as the seed for the sequence.
|
|
|
|
---
|
|
|
|
```cpp
|
|
void initialise(uint32_t seed)
|
|
```
|
|
**Description**
|
|
Sets the seed as the new seed for the sequence.
|
|
|
|
---
|
|
|
|
```cpp
|
|
uint32_t operator()()
|
|
```
|
|
**Return**
|
|
The next number in the pseudo-random sequence.
|
|
|
|
---
|
|
|
|
```cpp
|
|
uint32_t range(uint32_t low, uint32_t high)
|
|
```
|
|
**Return**
|
|
A number between the specified ranges, inclusive.
|
|
|
|
## random_pcg
|
|
Generates a 32 bit pseudo-random number using a permuted congruential generator algorithm.
|
|
The result is a 32 bit integer between 1 and 4,294,967,295 (2^32 - 1).
|
|
|
|
```cpp
|
|
random_pcg()
|
|
```
|
|
**Description**
|
|
Constructor.
|
|
Uses the address of the object as the seed for the sequence.
|
|
|
|
---
|
|
|
|
```cpp
|
|
random_pcg(uint32_t seed)
|
|
```
|
|
**Description**
|
|
Constructor.
|
|
Uses seed as the seed for the sequence.
|
|
|
|
---
|
|
|
|
```cpp
|
|
void initialise(uint32_t seed)
|
|
```
|
|
**Description**
|
|
Sets the seed as the new seed for the sequence.
|
|
|
|
```cpp
|
|
uint32_t operator()()
|
|
```
|
|
**Return**
|
|
The next number in the pseudo-random sequence.
|
|
|
|
---
|
|
|
|
```cpp
|
|
uint32_t range(uint32_t low, uint32_t high)
|
|
```
|
|
**Return**
|
|
A number between the specified ranges, inclusive.
|
|
|
|
## random_hash
|
|
|
|
```cpp
|
|
template <typename THash>
|
|
```
|
|
Generates a 32 bit pseudo-random number by applying a user supplied 32bit hash to a counter.
|
|
The hash must implement void `add(uint8_t)` and `uint8_t value()` member functions.
|
|
|
|
```cpp
|
|
random_hash()
|
|
```
|
|
**Description**
|
|
Constructor.
|
|
Uses the address of the object as the seed for the sequence.
|
|
|
|
---
|
|
|
|
```cpp
|
|
random_hash(uint32_t seed)
|
|
```
|
|
**Description**
|
|
Constructor.
|
|
Uses seed as the seed for the sequence.
|
|
|
|
---
|
|
|
|
```cpp
|
|
void initialise(uint32_t seed)
|
|
```
|
|
**Description**
|
|
Sets the seed as the new seed for the sequence.
|
|
|
|
---
|
|
|
|
```cpp
|
|
uint32_t operator()()
|
|
```
|
|
**Return**
|
|
The next number in the pseudo-random sequence.
|
|
|
|
---
|
|
|
|
```cpp
|
|
uint32_t range(uint32_t low, uint32_t high)
|
|
```
|
|
**Return**
|
|
A number between the specified ranges, inclusive.
|