Skip to content

Commit

Permalink
DOC: Spelling changes
Browse files Browse the repository at this point in the history
Fix multiple spelling errors
  • Loading branch information
bashtage committed Apr 2, 2018
1 parent b19e0db commit e983108
Show file tree
Hide file tree
Showing 14 changed files with 21 additions and 20 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ generators in Python and NumPy.

## Compatibility Warning

`RandomGenerator` does notsupports Box-Muller normal variates and so it not
`RandomGenerator` does not support Box-Muller normal variates and so it not
100% compatible with NumPy (or randomstate). Box-Muller normals are slow
to generate and all functions which previously relied on Box-Muller
normals now use the faster Ziggurat implementation. If you require backward
Expand Down Expand Up @@ -128,7 +128,7 @@ the RNG._

## Version
The version matched the latest version of NumPy where
`RandoMGenerator(MT19937())` passes all NumPy test.
`RandomGenerator(MT19937())` passes all NumPy test.

## Documentation

Expand Down
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ generators in Python and NumPy.
Compatibility Warning
---------------------

``RandomGenerator`` does notsupports Box-Muller normal variates and so
``RandomGenerator`` does not support Box-Muller normal variates and so
it not 100% compatible with NumPy (or randomstate). Box-Muller normals
are slow to generate and all functions which previously relied on
Box-Muller normals now use the faster Ziggurat implementation. If you
Expand Down Expand Up @@ -140,7 +140,7 @@ Version
-------

The version matched the latest version of NumPy where
``RandoMGenerator(MT19937())`` passes all NumPy test.
``RandomGenerator(MT19937())`` passes all NumPy test.

Documentation
-------------
Expand Down
1 change: 1 addition & 0 deletions doc/source/change-log.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ Change Log
Changes since v1.14
===================

- Added absolute_import to avoid import noise on Python 2.7
- Add legacy generator which allows NumPy replication
- Improve type handling of integers
- Switch to array-fillers for 0 parameter distribution to improve performance
Expand Down
4 changes: 2 additions & 2 deletions randomgen/dsfmt.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ cdef class DSFMT:
Notes
-----
``DSFMT`` directly provides generators for doubles, and unsigned 32 and 64-
bit integers [1]_ . These are not firectly available and must be consumed
bit integers [1]_ . These are not directly available and must be consumed
via a ``RandomGenerator`` object.
The Python stdlib module "random" also contains a Mersenne Twister
Expand Down Expand Up @@ -313,7 +313,7 @@ cdef class DSFMT:
@property
def ctypes(self):
"""
Cytpes interface
Ctypes interface
Returns
-------
Expand Down
4 changes: 2 additions & 2 deletions randomgen/generator.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ cdef class RandomGenerator:
>>> from randomgen import MT19937
>>> rg = RandomGenerator(MT19937())
The generator is also directly avialable from basic RNGs
The generator is also directly available from basic RNGs
>>> rg = MT19937().generator
>>> rg.standard_normal()
Expand Down Expand Up @@ -375,7 +375,7 @@ cdef class RandomGenerator:
.. math:: f(x; a,b) = \\frac{1}{B(\\alpha, \\beta)} x^{\\alpha - 1}
(1 - x)^{\\beta - 1},
where the normalisation, B, is the beta function,
where the normalization, B, is the beta function,
.. math:: B(\\alpha, \\beta) = \\int_0^1 t^{\\alpha - 1}
(1 - t)^{\\beta - 1} dt.
Expand Down
2 changes: 1 addition & 1 deletion randomgen/legacy/_legacy.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ cdef class _LegacyGenerator:
numbers for a set of distributions where the method used to produce random
samples has changed. Three core generators have changed: normal, exponential
and gamma. These have been replaced by faster Ziggurat-based methods in
``RadnomGenerator``. ``_LegacyGenerator`` retains the slower methods
``RandomGenerator``. ``_LegacyGenerator`` retains the slower methods
to produce samples from these distributions as well as from distributions
that depend on these such as the Chi-square, power or Weibull.
Expand Down
4 changes: 2 additions & 2 deletions randomgen/mt19937.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ cdef class MT19937:
Notes
-----
``MT19937`` directly provides generators for doubles, and unsigned 32 and 64-
bit integers [1]_ . These are not firectly available and must be consumed
bit integers [1]_ . These are not directly available and must be consumed
via a ``RandomGenerator`` object.
The Python stdlib module "random" also contains a Mersenne Twister
Expand Down Expand Up @@ -299,7 +299,7 @@ cdef class MT19937:
@property
def ctypes(self):
"""
Cytpes interface
Ctypes interface
Returns
-------
Expand Down
2 changes: 1 addition & 1 deletion randomgen/pcg32.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -327,7 +327,7 @@ cdef class PCG32:
@property
def ctypes(self):
"""
Cytpes interface
Ctypes interface
Returns
-------
Expand Down
2 changes: 1 addition & 1 deletion randomgen/pcg64.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -386,7 +386,7 @@ cdef class PCG64:
@property
def ctypes(self):
"""
Cytpes interface
Ctypes interface
Returns
-------
Expand Down
2 changes: 1 addition & 1 deletion randomgen/philox.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -394,7 +394,7 @@ cdef class Philox:

def ctypes(self):
"""
Cytpes interface
Ctypes interface
Returns
-------
Expand Down
6 changes: 3 additions & 3 deletions randomgen/threefry.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -99,8 +99,8 @@ cdef class ThreeFry:
``ThreeFry`` can be used in parallel applications by
calling the method ``jump`` which advances the state as-if
:math:`2^{128}` random numbers have been generated. Alternatively,
``advance`` can be used to advance the counter for an abritrary number of
positive steps in [0, 2**256). When using ``jump``, all generators should
``advance`` can be used to advance the counter for an any
positive step in [0, 2**256). When using ``jump``, all generators should
be initialized with the same seed to ensure that the segments come from
the same sequence. Alternatively, ``ThreeFry`` can be used
in parallel applications by using a sequence of distinct keys where each
Expand Down Expand Up @@ -387,7 +387,7 @@ cdef class ThreeFry:

def ctypes(self):
"""
Cytpes interface
Ctypes interface
Returns
-------
Expand Down
2 changes: 1 addition & 1 deletion randomgen/threefry32.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -382,7 +382,7 @@ cdef class ThreeFry32:

def ctypes(self):
"""
Cytpes interface
Ctypes interface
Returns
-------
Expand Down
2 changes: 1 addition & 1 deletion randomgen/xoroshiro128.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -273,7 +273,7 @@ cdef class Xoroshiro128:
@property
def ctypes(self):
"""
Cytpes interface
Ctypes interface
Returns
-------
Expand Down
2 changes: 1 addition & 1 deletion randomgen/xorshift1024.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -306,7 +306,7 @@ cdef class Xorshift1024:
@property
def ctypes(self):
"""
Cytpes interface
Ctypes interface
Returns
-------
Expand Down

0 comments on commit e983108

Please sign in to comment.