stochastic-rs-core 2.6.0

Core traits, SIMD RNG, and macros for stochastic-rs.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

[![Crates.io](https://img.shields.io/crates/v/stochastic-rs-core?style=flat-square)](https://crates.io/crates/stochastic-rs-core)
[![docs.rs](https://img.shields.io/docsrs/stochastic-rs-core?style=flat-square)](https://docs.rs/stochastic-rs-core)
![License](https://img.shields.io/crates/l/stochastic-rs-core?style=flat-square)

# stochastic-rs-core

**Core traits, SIMD RNG, and seeding for stochastic-rs**

The foundation crate. Everything else in the workspace draws its randomness
from here.

## What is in it

- **`SimdRng`** — a xoshiro-based generator with SIMD bulk fills
  (`fill_uniform_f64`, `fill_ziggurat`, …). Implements `rand::RngCore`, so it
  drops into anything expecting an `Rng`.
- **`SeedExt`** — the workspace seeding contract. Two implementations:
  `Unseeded` (a fresh, globally unique stream per construction, zero
  overhead) and `Deterministic::new(seed)` (reproducible, `AtomicU64`-backed
  so `derive()` can fan out independent child streams from one source).
- **`SimdRngDual`** — an experimental two-engine variant behind the
  `dual-stream-rng` feature. Roughly 5–11% faster on ziggurat-based bulk
  fills on Apple Silicon; its stream is *not* bit-compatible with `SimdRng`.

## Usage

```rust
use stochastic_rs_core::simd_rng::{Deterministic, SimdRng, Unseeded};

// Reproducible
let mut rng = SimdRng::from_seed(42);
let x = rng.next_f64();

// A seed source to hand to a distribution or process
let seed = Deterministic::new(42);
```

## Seeding rule

The seed belongs to the **constructor**, not to an `Rng` you pass in later.
Distributions in this workspace own their stream; a `fill_slice(rng, out)`
call ignores the `rng` argument by design.

## Part of stochastic-rs

This crate is one of the sub-crates of
[**stochastic-rs**](https://github.com/rust-dd/stochastic-rs). Most users
should depend on the umbrella crate, which re-exports everything:

```toml
[dependencies]
stochastic-rs = "2.6"
```

Depend on `stochastic-rs-core` directly only when you want this slice and nothing else.

- Documentation: [stochastic.rust-dd.com](https://stochastic.rust-dd.com)
- API reference: [docs.rs/stochastic-rs-core](https://docs.rs/stochastic-rs-core)

## License

MIT