Skip to content

Commit 1bb8c38

Browse files
committed
Minor documentation improvements
1 parent 4771ced commit 1bb8c38

File tree

3 files changed

+8
-0
lines changed

3 files changed

+8
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,11 @@ ciphers. This package provides:
1515
building blocks for other cryptographic primitives, such as the
1616
ChaCha20-Poly1305 AEAD algorithm.
1717

18+
The default stream cipher provided by this package follows [Daniel Bernstein's
19+
original implementation](https://cr.yp.to/chacha.html) (using a 64-bit counter
20+
and 64-bit nonce), which allows you to generate 1 ZiB of random data before the
21+
nonce must be recycled.
22+
1823
## Usage
1924

2025
You can start using ChaChaCiphers.jl for random number generation by creating a

src/cuda_keystream.jl

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ julia> x = CuVector{Float32}(undef, 2^10);
3232
DocTestSetup = nothing
3333
```
3434
35+
See also: [`ChaChaStream`](@ref)
3536
"""
3637
mutable struct CUDAChaChaStream <: AbstractChaChaStream
3738
key :: CuVector{UInt32}

src/keystream.jl

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,8 @@ julia> randstring(stream, 'a':'z', 8)
4949
```@meta
5050
DocTestSetup = nothing
5151
```
52+
53+
See also: [`CUDAChaChaStream`](@ref)
5254
"""
5355
mutable struct ChaChaStream <: AbstractChaChaStream
5456
key :: SVector{8,UInt32}

0 commit comments

Comments
 (0)