diff options
Diffstat (limited to 'doc/source/reference')
24 files changed, 101 insertions, 101 deletions
diff --git a/doc/source/reference/c-api/array.rst b/doc/source/reference/c-api/array.rst index f22b41a85..f69c2bcb1 100644 --- a/doc/source/reference/c-api/array.rst +++ b/doc/source/reference/c-api/array.rst @@ -162,7 +162,7 @@ and its sub-types). Data access -^^^^^^^^^^^ +~~~~~~~~~~~ These functions and macros provide easy access to elements of the ndarray from C. These work for all arrays. You may need to take care @@ -208,7 +208,7 @@ Creating arrays From scratch -^^^^^^^^^^^^ +~~~~~~~~~~~~ .. c:function:: PyObject* PyArray_NewFromDescr( \ PyTypeObject* subtype, PyArray_Descr* descr, int nd, npy_intp const* dims, \ @@ -404,7 +404,7 @@ From scratch to another value. From other objects -^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~ .. c:function:: PyObject* PyArray_FromAny( \ PyObject* op, PyArray_Descr* dtype, int min_depth, int max_depth, \ @@ -805,7 +805,7 @@ Dealing with types General check of Python Type -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. c:function:: int PyArray_Check(PyObject *op) @@ -877,7 +877,7 @@ General check of Python Type Data-type checking -^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~ For the typenum macros, the argument is an integer representing an enumerated array data type. For the array type checking macros the @@ -1048,7 +1048,7 @@ argument must be a :c:expr:`PyObject *` that can be directly interpreted as a Converting data types -^^^^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~~~~ .. c:function:: PyObject* PyArray_Cast(PyArrayObject* arr, int typenum) @@ -1268,7 +1268,7 @@ Converting data types User-defined data types -^^^^^^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~~~~~~ .. c:function:: void PyArray_InitArrFuncs(PyArray_ArrFuncs* f) @@ -1321,7 +1321,7 @@ User-defined data types Only works for user-defined data-types. Special functions for NPY_OBJECT -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. c:function:: int PyArray_INCREF(PyArrayObject* op) @@ -1399,7 +1399,7 @@ PyArray_FromAny function. Basic Array Flags -^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~ An ndarray can have a data segment that is not a simple contiguous chunk of well-behaved memory you can manipulate. It may not be aligned @@ -1482,7 +1482,7 @@ for ``flags`` which can be any of :c:data:`NPY_ARRAY_C_CONTIGUOUS`, Combinations of array flags -^^^^^^^^^^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. c:macro:: NPY_ARRAY_BEHAVED @@ -1514,7 +1514,7 @@ Combinations of array flags Flag-like constants -^^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~~ These constants are used in :c:func:`PyArray_FromAny` (and its macro forms) to specify desired properties of the new array. @@ -1534,7 +1534,7 @@ specify desired properties of the new array. Flag checking -^^^^^^^^^^^^^ +~~~~~~~~~~~~~ For all of these macros *arr* must be an instance of a (subclass of) :c:data:`PyArray_Type`. @@ -1640,7 +1640,7 @@ Array method alternative API Conversion -^^^^^^^^^^ +~~~~~~~~~~ .. c:function:: PyObject* PyArray_GetField( \ PyArrayObject* self, PyArray_Descr* dtype, int offset) @@ -1749,7 +1749,7 @@ Conversion Shape Manipulation -^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~ .. c:function:: PyObject* PyArray_Newshape( \ PyArrayObject* self, PyArray_Dims* newshape, NPY_ORDER order) @@ -1833,7 +1833,7 @@ Shape Manipulation Item selection and manipulation -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. c:function:: PyObject* PyArray_TakeFrom( \ PyArrayObject* self, PyObject* indices, int axis, PyArrayObject* ret, \ @@ -2013,7 +2013,7 @@ Item selection and manipulation Calculation -^^^^^^^^^^^ +~~~~~~~~~~~ .. tip:: @@ -2173,7 +2173,7 @@ Functions Array Functions -^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~ .. c:function:: int PyArray_AsCArray( \ PyObject** op, void* ptr, npy_intp* dims, int nd, \ @@ -2324,7 +2324,7 @@ Array Functions Other functions -^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~ .. c:function:: npy_bool PyArray_CheckStrides( \ int elsize, int nd, npy_intp numbytes, npy_intp const* dims, \ @@ -2969,7 +2969,7 @@ Conversion Utilities For use with :c:func:`PyArg_ParseTuple` -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ All of these functions can be used in :c:func:`PyArg_ParseTuple` (...) with the "O&" format specifier to automatically convert any Python object @@ -3097,7 +3097,7 @@ to. to help functions allow a different clipmode for each dimension. Other conversions -^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~ .. c:function:: int PyArray_PyIntAsInt(PyObject* op) @@ -3138,7 +3138,7 @@ Miscellaneous Importing the API -^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~ In order to make use of the C-API from another extension module, the :c:func:`import_array` function must be called. If the extension module is @@ -3209,7 +3209,7 @@ the C-API is needed then some additional steps must be taken. #defined to. Checking the API Version -^^^^^^^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~~~~~~~ Because python extensions are not used in the same way as usual libraries on most platforms, some errors cannot be automatically detected at build time or @@ -3264,7 +3264,7 @@ extension with the lowest :c:data:`NPY_FEATURE_VERSION` as possible. function is added). A changed value does not always require a recompile. Internal Flexibility -^^^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~~~ .. c:function:: int PyArray_SetNumericOps(PyObject* dict) @@ -3321,7 +3321,7 @@ Internal Flexibility Memory management -^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~ .. c:function:: char* PyDataMem_NEW(size_t nbytes) @@ -3368,7 +3368,7 @@ Memory management Returns 0 if nothing was done, -1 on error, and 1 if action was taken. Threading support -^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~ These macros are only meaningful if :c:data:`NPY_ALLOW_THREADS` evaluates True during compilation of the extension module. Otherwise, @@ -3475,7 +3475,7 @@ Group 2 Priority -^^^^^^^^ +~~~~~~~~ .. c:macro:: NPY_PRIORITY @@ -3498,7 +3498,7 @@ Priority Default buffers -^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~ .. c:macro:: NPY_BUFSIZE @@ -3514,7 +3514,7 @@ Default buffers Other constants -^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~ .. c:macro:: NPY_NUM_FLOATTYPE @@ -3548,7 +3548,7 @@ Other constants Miscellaneous Macros -^^^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~~~ .. c:function:: int PyArray_SAMESHAPE(PyArrayObject *a1, PyArrayObject *a2) @@ -3610,7 +3610,7 @@ Miscellaneous Macros Enumerated Types -^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~ .. c:enum:: NPY_SORTKIND diff --git a/doc/source/reference/c-api/dtype.rst b/doc/source/reference/c-api/dtype.rst index 382e45dc0..642f62749 100644 --- a/doc/source/reference/c-api/dtype.rst +++ b/doc/source/reference/c-api/dtype.rst @@ -219,7 +219,7 @@ Defines ------- Max and min values for integers -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ``NPY_MAX_INT{bits}``, ``NPY_MAX_UINT{bits}``, ``NPY_MIN_INT{bits}`` These are defined for ``{bits}`` = 8, 16, 32, 64, 128, and 256 and provide @@ -238,7 +238,7 @@ Max and min values for integers Number of bits in data types -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ All ``NPY_SIZEOF_{CTYPE}`` constants have corresponding ``NPY_BITSOF_{CTYPE}`` constants defined. The ``NPY_BITSOF_{CTYPE}`` @@ -250,7 +250,7 @@ the available ``{CTYPE}s`` are Bit-width references to enumerated typenums -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ All of the numeric data types (integer, floating point, and complex) have constants that are defined to be a specific enumerated type @@ -265,7 +265,7 @@ types are available. Integer that can hold a pointer -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The constants **NPY_INTP** and **NPY_UINTP** refer to an enumerated integer type that is large enough to hold a pointer on the @@ -283,7 +283,7 @@ types. Boolean -^^^^^^^ +~~~~~~~ .. c:type:: npy_bool @@ -292,7 +292,7 @@ Boolean (Un)Signed Integer -^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~ Unsigned versions of the integers can be defined by pre-pending a 'u' to the front of the integer name. @@ -373,7 +373,7 @@ to the front of the integer name. (Complex) Floating point -^^^^^^^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~~~~~~~ .. c:type:: npy_half @@ -408,7 +408,7 @@ that order). Bit-width names -^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~ There are also typedefs for signed integers, unsigned integers, floating point, and complex floating point types of specific bit- diff --git a/doc/source/reference/random/bit_generators/index.rst b/doc/source/reference/random/bit_generators/index.rst index 211f0d60e..d93f38d0b 100644 --- a/doc/source/reference/random/bit_generators/index.rst +++ b/doc/source/reference/random/bit_generators/index.rst @@ -1,7 +1,7 @@ .. currentmodule:: numpy.random Bit Generators --------------- +============== The random values produced by :class:`~Generator` originate in a BitGenerator. The BitGenerators do not directly provide @@ -11,7 +11,7 @@ low-level wrappers for consumption by code that can efficiently access the functions provided, e.g., `numba <https://numba.pydata.org>`_. Supported BitGenerators -======================= +----------------------- The included BitGenerators are: @@ -51,7 +51,7 @@ The included BitGenerators are: SFC64 <sfc64> Seeding and Entropy -------------------- +=================== A BitGenerator provides a stream of random values. In order to generate reproducible streams, BitGenerators support setting their initial state via a diff --git a/doc/source/reference/random/bit_generators/mt19937.rst b/doc/source/reference/random/bit_generators/mt19937.rst index d05ea7c6f..e85234d10 100644 --- a/doc/source/reference/random/bit_generators/mt19937.rst +++ b/doc/source/reference/random/bit_generators/mt19937.rst @@ -1,5 +1,5 @@ Mersenne Twister (MT19937) --------------------------- +========================== .. currentmodule:: numpy.random @@ -8,7 +8,7 @@ Mersenne Twister (MT19937) :exclude-members: __init__ State -===== +----- .. autosummary:: :toctree: generated/ @@ -16,14 +16,14 @@ State ~MT19937.state Parallel generation -=================== +------------------- .. autosummary:: :toctree: generated/ ~MT19937.jumped Extending -========= +--------- .. autosummary:: :toctree: generated/ diff --git a/doc/source/reference/random/bit_generators/pcg64.rst b/doc/source/reference/random/bit_generators/pcg64.rst index 889965f77..6ebd34f4a 100644 --- a/doc/source/reference/random/bit_generators/pcg64.rst +++ b/doc/source/reference/random/bit_generators/pcg64.rst @@ -1,5 +1,5 @@ Permuted Congruential Generator (64-bit, PCG64) ------------------------------------------------ +=============================================== .. currentmodule:: numpy.random @@ -8,7 +8,7 @@ Permuted Congruential Generator (64-bit, PCG64) :exclude-members: __init__ State -===== +----- .. autosummary:: :toctree: generated/ @@ -16,7 +16,7 @@ State ~PCG64.state Parallel generation -=================== +------------------- .. autosummary:: :toctree: generated/ @@ -24,7 +24,7 @@ Parallel generation ~PCG64.jumped Extending -========= +--------- .. autosummary:: :toctree: generated/ diff --git a/doc/source/reference/random/bit_generators/pcg64dxsm.rst b/doc/source/reference/random/bit_generators/pcg64dxsm.rst index e37efa5d3..99e4d15c9 100644 --- a/doc/source/reference/random/bit_generators/pcg64dxsm.rst +++ b/doc/source/reference/random/bit_generators/pcg64dxsm.rst @@ -1,5 +1,5 @@ Permuted Congruential Generator (64-bit, PCG64 DXSM) ----------------------------------------------------- +==================================================== .. currentmodule:: numpy.random @@ -8,7 +8,7 @@ Permuted Congruential Generator (64-bit, PCG64 DXSM) :exclude-members: __init__ State -===== +----- .. autosummary:: :toctree: generated/ @@ -16,7 +16,7 @@ State ~PCG64DXSM.state Parallel generation -=================== +------------------- .. autosummary:: :toctree: generated/ @@ -24,7 +24,7 @@ Parallel generation ~PCG64DXSM.jumped Extending -========= +--------- .. autosummary:: :toctree: generated/ diff --git a/doc/source/reference/random/bit_generators/philox.rst b/doc/source/reference/random/bit_generators/philox.rst index 3c2fa4cc5..4df364653 100644 --- a/doc/source/reference/random/bit_generators/philox.rst +++ b/doc/source/reference/random/bit_generators/philox.rst @@ -1,5 +1,5 @@ Philox Counter-based RNG ------------------------- +======================== .. currentmodule:: numpy.random @@ -8,7 +8,7 @@ Philox Counter-based RNG :exclude-members: __init__ State -===== +----- .. autosummary:: :toctree: generated/ @@ -16,7 +16,7 @@ State ~Philox.state Parallel generation -=================== +------------------- .. autosummary:: :toctree: generated/ @@ -24,7 +24,7 @@ Parallel generation ~Philox.jumped Extending -========= +--------- .. autosummary:: :toctree: generated/ diff --git a/doc/source/reference/random/bit_generators/sfc64.rst b/doc/source/reference/random/bit_generators/sfc64.rst index 8cb255bc1..6ea9593c2 100644 --- a/doc/source/reference/random/bit_generators/sfc64.rst +++ b/doc/source/reference/random/bit_generators/sfc64.rst @@ -1,5 +1,5 @@ SFC64 Small Fast Chaotic PRNG ------------------------------ +============================= .. currentmodule:: numpy.random @@ -8,7 +8,7 @@ SFC64 Small Fast Chaotic PRNG :exclude-members: __init__ State -===== +----- .. autosummary:: :toctree: generated/ @@ -16,7 +16,7 @@ State ~SFC64.state Extending -========= +--------- .. autosummary:: :toctree: generated/ diff --git a/doc/source/reference/random/extending.rst b/doc/source/reference/random/extending.rst index 2c506e943..6bb941496 100644 --- a/doc/source/reference/random/extending.rst +++ b/doc/source/reference/random/extending.rst @@ -3,14 +3,14 @@ .. _extending: Extending ---------- +========= The BitGenerators have been designed to be extendable using standard tools for high-performance Python -- numba and Cython. The `~Generator` object can also be used with user-provided BitGenerators as long as these export a small set of required functions. Numba -===== +----- Numba can be used with either CTypes or CFFI. The current iteration of the BitGenerators all export a small set of functions through both interfaces. @@ -30,7 +30,7 @@ the `examples` section below. .. _random_cython: Cython -====== +------ Cython can be used to unpack the ``PyCapsule`` provided by a BitGenerator. This example uses `PCG64` and the example from above. The usual caveats @@ -61,7 +61,7 @@ See :ref:`extending_cython_example` for the complete listings of these examples and a minimal ``setup.py`` to build the c-extension modules. CFFI -==== +---- CFFI can be used to directly access the functions in ``include/numpy/random/distributions.h``. Some "massaging" of the header @@ -80,7 +80,7 @@ directly from the ``_generator`` shared object, using the `BitGenerator.cffi` in New Bit Generators -================== +------------------ `~Generator` can be used with user-provided `~BitGenerator`\ s. The simplest way to write a new BitGenerator is to examine the pyx file of one of the existing BitGenerators. The key structure that must be provided is the @@ -109,7 +109,7 @@ the next 64-bit unsigned integer function if not needed. Functions inside bitgen_state->next_uint64(bitgen_state->state) Examples -======== +-------- .. toctree:: Numba <examples/numba> diff --git a/doc/source/reference/random/generator.rst b/doc/source/reference/random/generator.rst index 9bee4d756..dc71cb1f9 100644 --- a/doc/source/reference/random/generator.rst +++ b/doc/source/reference/random/generator.rst @@ -1,7 +1,7 @@ .. currentmodule:: numpy.random Random Generator ----------------- +================ The `~Generator` provides access to a wide range of distributions, and served as a replacement for :class:`~numpy.random.RandomState`. The main difference between @@ -19,14 +19,14 @@ can be changed by passing an instantized BitGenerator to ``Generator``. :exclude-members: __init__ Accessing the BitGenerator -========================== +-------------------------- .. autosummary:: :toctree: generated/ ~numpy.random.Generator.bit_generator Simple random data -================== +------------------ .. autosummary:: :toctree: generated/ @@ -36,7 +36,7 @@ Simple random data ~numpy.random.Generator.bytes Permutations -============ +------------ The methods for randomly permuting a sequence are .. autosummary:: @@ -140,7 +140,7 @@ For example, ['B', 'D', 'A', 'E', 'C'] # random Distributions -============= +------------- .. autosummary:: :toctree: generated/ diff --git a/doc/source/reference/random/legacy.rst b/doc/source/reference/random/legacy.rst index 42437dbb6..b1fce49a1 100644 --- a/doc/source/reference/random/legacy.rst +++ b/doc/source/reference/random/legacy.rst @@ -52,7 +52,7 @@ using the state of the `RandomState`: :exclude-members: __init__ Seeding and State -================= +----------------- .. autosummary:: :toctree: generated/ @@ -62,7 +62,7 @@ Seeding and State ~RandomState.seed Simple random data -================== +------------------ .. autosummary:: :toctree: generated/ @@ -75,7 +75,7 @@ Simple random data ~RandomState.bytes Permutations -============ +------------ .. autosummary:: :toctree: generated/ @@ -83,7 +83,7 @@ Permutations ~RandomState.permutation Distributions -============= +------------- .. autosummary:: :toctree: generated/ @@ -124,7 +124,7 @@ Distributions ~RandomState.zipf Functions in `numpy.random` -=========================== +--------------------------- Many of the RandomState methods above are exported as functions in `numpy.random` This usage is discouraged, as it is implemented via a global `RandomState` instance which is not advised on two counts: diff --git a/doc/source/reference/random/performance.rst b/doc/source/reference/random/performance.rst index cb9b94113..3a7cb027e 100644 --- a/doc/source/reference/random/performance.rst +++ b/doc/source/reference/random/performance.rst @@ -1,10 +1,10 @@ Performance ------------ +=========== .. currentmodule:: numpy.random Recommendation -************** +-------------- The recommended generator for general use is `PCG64` or its upgraded variant `PCG64DXSM` for heavily-parallel use cases. They are statistically high quality, @@ -31,7 +31,7 @@ many systems. .. _`fails some statistical tests`: https://www.iro.umontreal.ca/~lecuyer/myftp/papers/testu01.pdf Timings -******* +------- The timings below are the time in ns to produce 1 random value from a specific distribution. The original `MT19937` generator is @@ -86,7 +86,7 @@ performance was computed using a geometric mean. All timings were taken using Linux on an AMD Ryzen 9 3900X processor. Performance on different Operating Systems -****************************************** +------------------------------------------ Performance differs across platforms due to compiler and hardware availability (e.g., register width) differences. The default bit generator has been chosen to perform well on 64-bit platforms. Performance on 32-bit operating systems diff --git a/doc/source/reference/random/upgrading-pcg64.rst b/doc/source/reference/random/upgrading-pcg64.rst index 9e540ace9..b36bdf4c8 100644 --- a/doc/source/reference/random/upgrading-pcg64.rst +++ b/doc/source/reference/random/upgrading-pcg64.rst @@ -3,7 +3,7 @@ .. currentmodule:: numpy.random Upgrading ``PCG64`` with ``PCG64DXSM`` --------------------------------------- +====================================== Uses of the `PCG64` `BitGenerator` in a massively-parallel context have been shown to have statistical weaknesses that were not apparent at the first @@ -15,7 +15,7 @@ the statistical weakness while preserving the performance and the features of `PCG64`. Does this affect me? -==================== +-------------------- If you @@ -48,7 +48,7 @@ swamped by the remaining streams in most applications. .. _upgrading-pcg64-details: Technical Details -================= +----------------- Like many PRNG algorithms, `PCG64` is constructed from a transition function, which advances a 128-bit state, and an output function, that mixes the 128-bit diff --git a/doc/source/reference/routines.bitwise.rst b/doc/source/reference/routines.bitwise.rst index 58661abc7..5bf61ed8a 100644 --- a/doc/source/reference/routines.bitwise.rst +++ b/doc/source/reference/routines.bitwise.rst @@ -1,5 +1,5 @@ Binary operations -***************** +================= .. currentmodule:: numpy diff --git a/doc/source/reference/routines.char.rst b/doc/source/reference/routines.char.rst index 90df14125..0644263f4 100644 --- a/doc/source/reference/routines.char.rst +++ b/doc/source/reference/routines.char.rst @@ -1,5 +1,5 @@ String operations -***************** +================= .. currentmodule:: numpy.char diff --git a/doc/source/reference/routines.dual.rst b/doc/source/reference/routines.dual.rst index 01814e9a7..18c7791d0 100644 --- a/doc/source/reference/routines.dual.rst +++ b/doc/source/reference/routines.dual.rst @@ -1,5 +1,5 @@ Optionally SciPy-accelerated routines (:mod:`numpy.dual`) -********************************************************* +========================================================= .. automodule:: numpy.dual diff --git a/doc/source/reference/routines.err.rst b/doc/source/reference/routines.err.rst index b3a7164b9..8f5106f76 100644 --- a/doc/source/reference/routines.err.rst +++ b/doc/source/reference/routines.err.rst @@ -1,5 +1,5 @@ Floating point error handling -***************************** +============================= .. currentmodule:: numpy diff --git a/doc/source/reference/routines.io.rst b/doc/source/reference/routines.io.rst index 3052ee1fb..2542b336f 100644 --- a/doc/source/reference/routines.io.rst +++ b/doc/source/reference/routines.io.rst @@ -1,7 +1,7 @@ .. _routines.io: Input and output -**************** +================ .. currentmodule:: numpy diff --git a/doc/source/reference/routines.linalg.rst b/doc/source/reference/routines.linalg.rst index 76b7ab82c..dfdcde4ab 100644 --- a/doc/source/reference/routines.linalg.rst +++ b/doc/source/reference/routines.linalg.rst @@ -3,7 +3,7 @@ .. module:: numpy.linalg Linear algebra (:mod:`numpy.linalg`) -************************************ +==================================== The NumPy linear algebra functions rely on BLAS and LAPACK to provide efficient low level implementations of standard linear algebra algorithms. Those diff --git a/doc/source/reference/routines.logic.rst b/doc/source/reference/routines.logic.rst index 7fa0cd1de..68a236605 100644 --- a/doc/source/reference/routines.logic.rst +++ b/doc/source/reference/routines.logic.rst @@ -1,5 +1,5 @@ Logic functions -*************** +=============== .. currentmodule:: numpy diff --git a/doc/source/reference/routines.ma.rst b/doc/source/reference/routines.ma.rst index 1de5c1c02..d503cc243 100644 --- a/doc/source/reference/routines.ma.rst +++ b/doc/source/reference/routines.ma.rst @@ -1,13 +1,13 @@ .. _routines.ma: Masked array operations -*********************** +======================= .. currentmodule:: numpy Constants -========= +--------- .. autosummary:: :toctree: generated/ @@ -16,7 +16,7 @@ Constants Creation -======== +-------- From existing data ~~~~~~~~~~~~~~~~~~ @@ -52,7 +52,7 @@ Ones and zeros _____ Inspecting the array -==================== +-------------------- .. autosummary:: :toctree: generated/ @@ -91,7 +91,7 @@ Inspecting the array _____ Manipulating a MaskedArray -========================== +-------------------------- Changing the shape ~~~~~~~~~~~~~~~~~~ @@ -162,7 +162,7 @@ Joining arrays _____ Operations on masks -=================== +------------------- Creating a mask ~~~~~~~~~~~~~~~ @@ -220,7 +220,7 @@ Modifying a mask _____ Conversion operations -====================== +---------------------- > to a masked array ~~~~~~~~~~~~~~~~~~~ @@ -291,7 +291,7 @@ Filling a masked array _____ Masked arrays arithmetic -======================== +------------------------ Arithmetic ~~~~~~~~~~ diff --git a/doc/source/reference/routines.math.rst b/doc/source/reference/routines.math.rst index 2a09b8d20..a454841b3 100644 --- a/doc/source/reference/routines.math.rst +++ b/doc/source/reference/routines.math.rst @@ -1,5 +1,5 @@ Mathematical functions -********************** +====================== .. currentmodule:: numpy diff --git a/doc/source/reference/routines.other.rst b/doc/source/reference/routines.other.rst index 339857409..bb0be7137 100644 --- a/doc/source/reference/routines.other.rst +++ b/doc/source/reference/routines.other.rst @@ -1,5 +1,5 @@ Miscellaneous routines -********************** +====================== .. toctree:: diff --git a/doc/source/reference/routines.polynomials.rst b/doc/source/reference/routines.polynomials.rst index 6ad692e70..ea22ab75f 100644 --- a/doc/source/reference/routines.polynomials.rst +++ b/doc/source/reference/routines.polynomials.rst @@ -1,7 +1,7 @@ .. _routines.polynomial: Polynomials -*********** +=========== Polynomials in NumPy can be *created*, *manipulated*, and even *fitted* using the :doc:`convenience classes <routines.polynomials.classes>` |