Skip to content

Commit 63e9cfa

Browse files
committed
DOC: Update change log
1 parent 2d7b96d commit 63e9cfa

File tree

2 files changed

+10
-9
lines changed

2 files changed

+10
-9
lines changed

doc/source/change-log.rst

+4-3
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,9 @@ v1.19.0
2020

2121
- Tested all bit generators out to at least 1TB `using PractRand`_.
2222
- Added :class:`randomgen.pcg64.PCG64DXSM` which is an alias for :class:`randomgen.pcg64.PCG64`
23-
with ``variant="cm-dxsm"`` and ``mode="sequence"``. This is the 2.0 version of PCG64 and
23+
with ``variant="dxsm"`` and ``mode="sequence"``. This is the 2.0 version of PCG64 and
2424
will likely become the default bit generator in NumPy in the near future.
25+
- Added :class:`randomgen.efiix64.EFIIX64` which is both fast and high-quality.
2526
- Added :class:`randomgen.sfc.SFC64` which supports generating streams using distinct
2627
Weyl constants.
2728
- Added a :class:`randomgen.pcg64.LCG128Mix` which supports setting the LCG multiplier,
@@ -33,8 +34,8 @@ v1.19.0
3334
- Added a :class:`randomgen.wrapper.UserBitGenerator` which allows bit generators to be written
3435
in Python or numba.
3536
- Added :class:`randomgen.generator.ExtendedGenerator` which contains features not in :class:`numpy.random.Generator`.
36-
- Added support for the ``DXSM`` and ``CM-DXSM`` variants of :class:`randomgen.pcg64.PCG64`. The
37-
``CM-DXSM`` variant is the official PCG 2.0 generator.
37+
- Added support for the ``dxsm`` and ``dxsm-128`` variants of :class:`randomgen.pcg64.PCG64`. The
38+
``dxsm`` variant is the official PCG 2.0 generator.
3839
- Added support for broadcasting inputs in :class:`randomgen.generator.ExtendedGenerator.multivariate_normal`.
3940
- Added support for the `++` variant of :class:`randomgen.xoroshiro128.Xoroshiro128`.
4041
- Fixed a bug the produced incorrect results in :func:`~randomgen.mt19937.MT19937.jumped`.

doc/source/performance.rst

+6-6
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@ although :class:`~randomgen.sfc64.SFC64` and :class:`~randomgen.xoshiro256.Xoshi
1010
are both excellent alternatives.
1111

1212
For very large scale
13-
applications -- requiring 1,000+ streams,
14-
:class:`~randomgen.pcg64.PCG64DXSM`, :class:`~randomgen.sfc64.SFC64`
15-
using distinct Weyl increments (``k``), or one of the cryptography-based generators
16-
:class:`~randomgen.aes.AESCounter` (if you have hardware acceleration),
13+
applications -- requiring 1,000+ streams --
14+
:class:`~randomgen.pcg64.PCG64DXSM` combined with a :class:`~numpy.random.SeedSequence` and ``spawn``,
15+
:class:`~randomgen.sfc64.SFC64` initialized using distinct Weyl increments (``k``), or one of
16+
the cryptography-based generators :class:`~randomgen.aes.AESCounter` (if you have hardware acceleration),
1717
:class:`~randomgen.effix64.EFFIC64`, :class:`~randomgen.speck128.SPECK128`,
1818
:class:`~randomgen.philox.Philox`, or :class:`~randomgen.hc128.HC128` if you do not)
19-
are all excellent choices.
19+
initialized with distinct keys are all excellent choices.
2020

21-
Unless you need backward compatibilyt, there are no longer good reasons to any
21+
Unless you need backward compatibility, there are no good reasons to use any
2222
of the Mersenne Twister PRNGS: :class:`~randomgen.mt19937.MT19937`, :class:`~randomgen.mt64.MT64`,
2323
:class:`~randomgen.sfmt.SFMT`, and :class:`~randomgen.dsfmt.DSFMT`.
2424

0 commit comments

Comments
 (0)