summaryrefslogtreecommitdiffhomepage
path: root/docs/crandom_api.md
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2022-04-18 23:53:18 +0200
committerTyge Løvset <[email protected]>2022-04-18 23:53:18 +0200
commit58497293d88109624d4798c56e888bcbab7c4285 (patch)
tree670f4f481672635f27363ea2d711a4cbb37618d6 /docs/crandom_api.md
parent1eddea1da0125ddad2f8804fadafd1494c1bb11a (diff)
downloadSTC-modified-58497293d88109624d4798c56e888bcbab7c4285.tar.gz
STC-modified-58497293d88109624d4798c56e888bcbab7c4285.zip
crandom.h: Renamed *_init(..) functions to *_new(..). Old names are kept but deprecated.
Diffstat (limited to 'docs/crandom_api.md')
-rw-r--r--docs/crandom_api.md14
1 files changed, 7 insertions, 7 deletions
diff --git a/docs/crandom_api.md b/docs/crandom_api.md
index 41c4a574..76b2379e 100644
--- a/docs/crandom_api.md
+++ b/docs/crandom_api.md
@@ -45,18 +45,18 @@ void csrandom(uint64_t seed); //
uint64_t crandom(void); // global stc64_rand(rng)
double crandomf(void); // global stc64_randf(rng)
-stc64_t stc64_init(uint64_t seed);
-stc64_t stc64_with_seq(uint64_t seed, uint64_t seq); // init with stream
+stc64_t stc64_new(uint64_t seed); // stc64_init(s) is deprecated
+stc64_t stc64_with_seq(uint64_t seed, uint64_t seq); // with unique stream
uint64_t stc64_rand(stc64_t* rng); // range [0, 2^64 - 1]
double stc64_randf(stc64_t* rng); // range [0.0, 1.0)
-stc64_uniform_t stc64_uniform_init(int64_t low, int64_t high); // uniform-distribution
+stc64_uniform_t stc64_uniform_new(int64_t low, int64_t high); // uniform-distribution
int64_t stc64_uniform(stc64_t* rng, stc64_uniform_t* dist); // range [low, high]
-stc64_uniformf_t stc64_uniformf_init(double lowf, double highf);
+stc64_uniformf_t stc64_uniformf_new(double lowf, double highf);
double stc64_uniformf(stc64_t* rng, stc64_uniformf_t* dist); // range [lowf, highf)
-stc64_normalf_t stc64_normalf_init(double mean, double stddev); // normal-distribution
+stc64_normalf_t stc64_normalf_new(double mean, double stddev); // normal-distribution
double stc64_normalf(stc64_t* rng, stc64_normalf_t* dist);
```
## Types
@@ -89,8 +89,8 @@ int main()
// Setup random engine with normal distribution.
uint64_t seed = time(NULL);
- stc64_t rng = stc64_init(seed);
- stc64_normalf_t dist = stc64_normalf_init(Mean, StdDev);
+ stc64_t rng = stc64_new(seed);
+ stc64_normalf_t dist = stc64_normalf_new(Mean, StdDev);
// Create histogram map
csmap_i mhist = csmap_i_init();