numpy ----- +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - '_', optional | | - '_', optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - (...) array_like | | - (...) :term:`numpy:array_like` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - (...) array_like of float | | - (...) :term:`numpy:array_like` :xref_param_type:`of` :xref_param_type:`float` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - (...) array_like, float, optional | | - (...) :term:`numpy:array_like`, :xref_param_type:`float`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - (..., K) array | | - (..., :xref_param_type:`K`) :xref_param_type:`array ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - (..., M) array | | - (..., :xref_param_type:`M`) :xref_param_type:`array ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - (..., M) ndarray | | - (..., :xref_param_type:`M`) :xref_param_type:`ndarray ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - (..., M, M) array | | - (..., :xref_param_type:`M`, :xref_param_type:`M`) :xref_param_type:`array ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - (..., M, M) array_like | | - (..., :xref_param_type:`M`, :xref_param_type:`M`) :term:`numpy:array_like` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - (..., M, M) ndarray or matrix | | - (..., :xref_param_type:`M`, :xref_param_type:`M`) :xref_param_type:`ndarray ` or :xref_param_type:`matrix ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - (..., M, N) array_like | | - (..., :xref_param_type:`M`, :xref_param_type:`N`) :term:`numpy:array_like` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - (..., M,) ndarray | | - (..., M,) :xref_param_type:`ndarray ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - (..., N, M) ndarray | | - (..., :xref_param_type:`N`, :xref_param_type:`M`) :xref_param_type:`ndarray ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - (...,M,N) array_like | | - (...,M,N) :term:`numpy:array_like` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - (...,N,M) ndarray | | - (...,N,M) :xref_param_type:`ndarray ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - (2,) array_like, optional | | - (2,) :term:`numpy:array_like`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - (2,) ndarray | | - (2,) :xref_param_type:`ndarray ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - (M, N) array_like | | - (:xref_param_type:`M`, :xref_param_type:`N`) :term:`numpy:array_like` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - (M, N) ndarray | | - (:xref_param_type:`M`, :xref_param_type:`N`) :xref_param_type:`ndarray ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - (M, N) ndarray, optional | | - (:xref_param_type:`M`, :xref_param_type:`N`) :xref_param_type:`ndarray `, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - (M,) array_like | | - (M,) :term:`numpy:array_like` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - (M,) ndarray, bool | | - (M,) :xref_param_type:`ndarray `, :xref_param_type:`bool` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - (N,) array_like | | - (N,) :term:`numpy:array_like` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - (N,) array_like, optional | | - (N,) :term:`numpy:array_like`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - (N,) ndarray | | - (N,) :xref_param_type:`ndarray ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - (N,) tuple of ints | | - (N,) :xref_param_type:`tuple` :xref_param_type:`of` :xref_param_type:`ints ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - (float, float), optional | | - (:xref_param_type:`float`, :xref_param_type:`float`), optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - (int, int) or None, optional | | - (:xref_param_type:`int`, :xref_param_type:`int`) :xref_param_type:`or` :xref_param_type:`None`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - (min(M, N),) ndarray | | - (:xref_param_type:`min`\(:xref_param_type:`M`, :xref_param_type:`N`),) :xref_param_type:`ndarray ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 1-D array of bools | | - 1-D :xref_param_type:`array ` :xref_param_type:`of` :xref_param_type:`bools` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 1-D array or sequence | | - 1-D :xref_param_type:`array ` or :term:`python:sequence` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 1-D array_like | | - 1-D :term:`numpy:array_like` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 1-D array_like, optional | | - 1-D :term:`numpy:array_like`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 1-D ndarray | | - 1-D :xref_param_type:`ndarray ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 1-D sequence | | - 1-D :term:`python:sequence` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 1-D sequence of float or complex | | - 1-D :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`float` or :xref_param_type:`complex` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 1-D sequence of floats | | - 1-D :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`floats ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 1-D sequences | | - 1-D :xref_param_type:`sequences` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 1D or 2D array_like | | - 1D or 2D :term:`numpy:array_like` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 2-D array | | - 2-D :xref_param_type:`array ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - An estimate of the optimal bin width for the given data. | | - :xref_param_type:`An` :xref_param_type:`estimate` :xref_param_type:`of` :xref_param_type:`the` :xref_param_type:`optimal` :xref_param_type:`bin` :xref_param_type:`width` :xref_param_type:`for` :xref_param_type:`the` :xref_param_type:`given` data. | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Arguments, optional | | - :xref_param_type:`Arguments`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Array or MaskedArray | | - :xref_param_type:`Array` or :xref_param_type:`MaskedArray ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Chebyshev instance | | - :xref_param_type:`Chebyshev` :xref_param_type:`instance` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Exception or tuple of Exceptions | | - :xref_param_type:`Exception` or :xref_param_type:`tuple` :xref_param_type:`of` :xref_param_type:`Exceptions` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Keyword arguments, optional | | - :xref_param_type:`Keyword` :xref_param_type:`arguments`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - MaskedArray | | - :xref_param_type:`MaskedArray ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - MaskedArray or array_like | | - :xref_param_type:`MaskedArray ` or :term:`numpy:array_like` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - MaskedArray or tuple of ndarrays | | - :xref_param_type:`MaskedArray ` or :xref_param_type:`tuple` :xref_param_type:`of` :xref_param_type:`ndarrays` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None | | - :xref_param_type:`None` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None or float, optional | | - :xref_param_type:`None` or :xref_param_type:`float`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None or int or tuple of ints, optional | | - :xref_param_type:`None` or :xref_param_type:`int` or :xref_param_type:`tuple` :xref_param_type:`of` :xref_param_type:`ints `, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None, str or sequence of warnings, optional | | - :xref_param_type:`None`, :xref_param_type:`str` or :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`warnings`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Number, optional | | - :xref_param_type:`Number`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Python type, optional | | - :xref_param_type:`Python` :xref_param_type:`type`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Scalar | | - :xref_param_type:`Scalar` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - _NoValue, optional | | - :xref_param_type:`_NoValue`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - any | | - :xref_param_type:`any` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - any, optional | | - :xref_param_type:`any`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - anything | | - :xref_param_type:`anything` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array | | - :xref_param_type:`array ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array of dtype float | | - :xref_param_type:`array ` :xref_param_type:`of` :xref_param_type:`dtype ` :xref_param_type:`float` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array of ints | | - :xref_param_type:`array ` :xref_param_type:`of` :xref_param_type:`ints ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array of str or unicode-like | | - :xref_param_type:`array ` :xref_param_type:`of` :xref_param_type:`str` or unicode-like | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array or sequence | | - :xref_param_type:`array ` or :term:`python:sequence` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array or sequence of arrays | | - :xref_param_type:`array ` or :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`arrays` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array, at least 2-D | | - :xref_param_type:`array `, :xref_param_type:`at` :xref_param_type:`least` 2-D | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array, at least 2-D. | | - :xref_param_type:`array `, :xref_param_type:`at` :xref_param_type:`least` 2-D. | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array, optional | | - :xref_param_type:`array `, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array, tuple, dict, etc. | | - :xref_param_type:`array `, :xref_param_type:`tuple`, :xref_param_type:`dict`, etc. | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array-like | | - :term:`array-like` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array-like of str or unicode | | - :term:`array-like` :xref_param_type:`of` :xref_param_type:`str` or :xref_param_type:`unicode` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array-like, {str, unicode} | | - :term:`array-like`, {:xref_param_type:`str`, :xref_param_type:`unicode`} | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like | | - :term:`numpy:array_like` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like (Ni..., M, Nk...) | | - :term:`numpy:array_like` (Ni..., :xref_param_type:`M`, Nk...) | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like (Nj...) | | - :term:`numpy:array_like` (Nj...) | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like of float | | - :term:`numpy:array_like` :xref_param_type:`of` :xref_param_type:`float` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like of ints | | - :term:`numpy:array_like` :xref_param_type:`of` :xref_param_type:`ints ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like of ints, optional | | - :term:`numpy:array_like` :xref_param_type:`of` :xref_param_type:`ints `, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like of rank N | | - :term:`numpy:array_like` :xref_param_type:`of` :xref_param_type:`rank` :xref_param_type:`N` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like of str or unicode | | - :term:`numpy:array_like` :xref_param_type:`of` :xref_param_type:`str` or :xref_param_type:`unicode` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like of values | | - :term:`numpy:array_like` :xref_param_type:`of` :xref_param_type:`values` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like or poly1d | | - :term:`numpy:array_like` or :xref_param_type:`poly1d` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like or poly1d object | | - :term:`numpy:array_like` or :xref_param_type:`poly1d` :xref_param_type:`object` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like or scalar | | - :term:`numpy:array_like` or :xref_param_type:`scalar` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like or string | | - :term:`numpy:array_like` or :xref_param_type:`string ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, optional | | - :term:`numpy:array_like`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, MaskedArray | | - :term:`numpy:array_like`, :xref_param_type:`MaskedArray ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, bool | | - :term:`numpy:array_like`, :xref_param_type:`bool` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, compatible object | | - :term:`numpy:array_like`, :xref_param_type:`compatible` :xref_param_type:`object` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, dtype float or complex | | - :term:`numpy:array_like`, :xref_param_type:`dtype ` :xref_param_type:`float` or :xref_param_type:`complex` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, int | | - :term:`numpy:array_like`, :xref_param_type:`int` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, int, optional | | - :term:`numpy:array_like`, :xref_param_type:`int`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, optional | | - :term:`numpy:array_like`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, shape (M, N) | | - :term:`numpy:array_like`, :xref_param_type:`shape` (:xref_param_type:`M`, :xref_param_type:`N`) | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, shape (M,) | | - :term:`numpy:array_like`, :xref_param_type:`shape` (M,) | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, shape (M,) or (M, K) | | - :term:`numpy:array_like`, :xref_param_type:`shape` (M,) :xref_param_type:`or` (:xref_param_type:`M`, :xref_param_type:`K`) | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, shape (M,), optional | | - :term:`numpy:array_like`, :xref_param_type:`shape` (M,), optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, shape (N,) | | - :term:`numpy:array_like`, :xref_param_type:`shape` (N,) | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, shape (N,) or (N, N) | | - :term:`numpy:array_like`, :xref_param_type:`shape` (N,) :xref_param_type:`or` (:xref_param_type:`N`, :xref_param_type:`N`) | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, shape (`M`,) | | - :term:`numpy:array_like`, :xref_param_type:`shape` (`M`,) | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, shape (`M`,) or (`M`, `K`) | | - :term:`numpy:array_like`, :xref_param_type:`shape` (`M`,) :xref_param_type:`or` (`M`, `K`) | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, shape (`M`,), optional | | - :term:`numpy:array_like`, :xref_param_type:`shape` (`M`,), optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, shape(2,2), optional | | - :term:`numpy:array_like`, :xref_param_type:`shape`\(2,2), optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, shape(M, ) | | - :term:`numpy:array_like`, :xref_param_type:`shape`\(:xref_param_type:`M`, ) | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, shape(N,) | | - :term:`numpy:array_like`, :xref_param_type:`shape`\(N,) | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, shape(N,), optional | | - :term:`numpy:array_like`, :xref_param_type:`shape`\(N,), optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, unicode | | - :term:`numpy:array_like`, :xref_param_type:`unicode` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like, {str, unicode} | | - :term:`numpy:array_like`, {:xref_param_type:`str`, :xref_param_type:`unicode`} | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool | | - :xref_param_type:`bool` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool or callable | | - :xref_param_type:`bool` or :xref_param_type:`callable` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool or callable, optional | | - :xref_param_type:`bool` or :xref_param_type:`callable`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool or int, optional | | - :xref_param_type:`bool` or :xref_param_type:`int`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool or ndarray | | - :xref_param_type:`bool` or :xref_param_type:`ndarray ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool, optional | | - :xref_param_type:`bool`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool, optional. | | - :xref_param_type:`bool`, optional. | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean | | - :xref_param_type:`boolean ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean, optional | | - :xref_param_type:`boolean `, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - buffer, optional | | - :xref_param_type:`buffer`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - byte string | | - :xref_param_type:`byte` :xref_param_type:`string ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bytes (python 3) or str (python 2) | | - :xref_param_type:`bytes` (:xref_param_type:`python` 3) :xref_param_type:`or` :xref_param_type:`str` (:xref_param_type:`python` 2) | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - callable | | - :xref_param_type:`callable` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - callable f(err, flag) or object with write method | | - :xref_param_type:`callable` :xref_param_type:`f`\(:xref_param_type:`err`, :xref_param_type:`flag`) :xref_param_type:`or` :xref_param_type:`object` :xref_param_type:`with` :xref_param_type:`write` :xref_param_type:`method` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - callable, log instance or None | | - :xref_param_type:`callable`, :xref_param_type:`log` :xref_param_type:`instance` or :xref_param_type:`None` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - char, optional | | - :xref_param_type:`char`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - class | | - :term:`python:class` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - class instance | | - :term:`python:class` :xref_param_type:`instance` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - class or tuple of classes. | | - :term:`python:class` or :xref_param_type:`tuple` :xref_param_type:`of` classes. | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - class, optional | | - :term:`python:class`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - compiled regexp or str, optional | | - :xref_param_type:`compiled` :xref_param_type:`regexp` or :xref_param_type:`str`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - complex ndarray | | - :xref_param_type:`complex` :xref_param_type:`ndarray ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - data type code | | - :xref_param_type:`data` :xref_param_type:`type` :xref_param_type:`code` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - data-type | | - data-type | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - data-type or ndarray sub-class, optional | | - data-type or :xref_param_type:`ndarray ` sub-class, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - data-type, optional | | - data-type, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dict | | - :xref_param_type:`dict` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dict of callables, optional | | - :xref_param_type:`dict` :xref_param_type:`of` :xref_param_type:`callables`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dict or list | | - :xref_param_type:`dict` or :xref_param_type:`list` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dict {obj_full_name: (docstring, kind, index), ...} | | - :xref_param_type:`dict` {obj_full_name: (:xref_param_type:`docstring`, :xref_param_type:`kind`, :xref_param_type:`index`), ...} | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dict, optional | | - :xref_param_type:`dict`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dictionary | | - :xref_param_type:`dictionary ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dictionary, optional | | - :xref_param_type:`dictionary `, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dtype | | - :xref_param_type:`dtype ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dtype or Python type | | - :xref_param_type:`dtype ` or :xref_param_type:`Python` :xref_param_type:`type` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dtype or dtype specifier | | - :xref_param_type:`dtype ` or :xref_param_type:`dtype ` :xref_param_type:`specifier` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dtype or list of dtypes | | - :xref_param_type:`dtype ` or :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`dtypes` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dtype, optional | | - :xref_param_type:`dtype `, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - file like object, optional | | - :xref_param_type:`file` :xref_param_type:`like` :xref_param_type:`object`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - file object | | - :xref_param_type:`file` :xref_param_type:`object` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - file object, optional | | - :xref_param_type:`file` :xref_param_type:`object`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - file or str | | - :xref_param_type:`file` or :xref_param_type:`str` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - file, str, or pathlib.Path | | - :xref_param_type:`file`, :xref_param_type:`str`, :xref_param_type:`or` :xref_param_type:`pathlib.Path` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - file, str, pathlib.Path, list of str, generator | | - :xref_param_type:`file`, :xref_param_type:`str`, :xref_param_type:`pathlib.Path`, :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`str`, :xref_param_type:`generator` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - file-like object, string, or pathlib.Path | | - :term:`file-like` :xref_param_type:`object`, :xref_param_type:`string `, :xref_param_type:`or` :xref_param_type:`pathlib.Path` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - file-like, optional | | - :term:`file-like`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - file_like object | | - :term:`file_like` :xref_param_type:`object` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - filelike object | | - :xref_param_type:`filelike` :xref_param_type:`object` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - filename or file handle | | - :xref_param_type:`filename` or :xref_param_type:`file` :xref_param_type:`handle` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float | | - :xref_param_type:`float` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float or complex (corresponding to fp) or ndarray | | - :xref_param_type:`float` or :xref_param_type:`complex` (:xref_param_type:`corresponding` :xref_param_type:`to` :xref_param_type:`fp`) :xref_param_type:`or` :xref_param_type:`ndarray ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float or ndarray | | - :xref_param_type:`float` or :xref_param_type:`ndarray ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float, dtype, or instance | | - :xref_param_type:`float`, :xref_param_type:`dtype `, :xref_param_type:`or` :xref_param_type:`instance` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float, optional | | - :xref_param_type:`float`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - func | | - :xref_param_type:`func` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - function | | - :xref_param_type:`function` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - function (M,) -> (Nj...) | | - :xref_param_type:`function` (M,) -> (Nj...) | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - function or None | | - :xref_param_type:`function` or :xref_param_type:`None` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - function, optional | | - :xref_param_type:`function`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - indexing object | | - :xref_param_type:`indexing` :xref_param_type:`object` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - instance of :class:`MachAr` or :class:`MachArLike` | | - :xref_param_type:`instance` :xref_param_type:`of` :class:`MachAr` or :class:`MachArLike` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - instancemethod | | - :xref_param_type:`instancemethod` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int | | - :xref_param_type:`int` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int array | | - :xref_param_type:`int` :xref_param_type:`array ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int in [0, 255] | | - :xref_param_type:`int` :xref_param_type:`in` [0, 255] | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or (2,) array_like | | - :xref_param_type:`int` :xref_param_type:`or` (2,) :term:`numpy:array_like` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or 1-D array | | - :xref_param_type:`int` or 1-D :xref_param_type:`array ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or 1-D array_like | | - :xref_param_type:`int` or 1-D :term:`numpy:array_like` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or None, optional | | - :xref_param_type:`int` or :xref_param_type:`None`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or array of int | | - :xref_param_type:`int` or :xref_param_type:`array ` :xref_param_type:`of` :xref_param_type:`int` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or array of ints | | - :xref_param_type:`int` or :xref_param_type:`array ` :xref_param_type:`of` :xref_param_type:`ints ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or array_like or [int, int] or [array, array], optional | | - :xref_param_type:`int` or :term:`numpy:array_like` :xref_param_type:`or` [:xref_param_type:`int`, :xref_param_type:`int`] :xref_param_type:`or` [:xref_param_type:`array `, :xref_param_type:`array `], optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or sequence of int | | - :xref_param_type:`int` or :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`int` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or sequence of ints | | - :xref_param_type:`int` or :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`ints ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or sequence of scalars or str, optional | | - :xref_param_type:`int` or :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`scalars` or :xref_param_type:`str`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or sequence, optional | | - :xref_param_type:`int` or :term:`python:sequence`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or shape tuple, optional | | - :xref_param_type:`int` or :xref_param_type:`shape` :xref_param_type:`tuple`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or tuple of int | | - :xref_param_type:`int` or :xref_param_type:`tuple` :xref_param_type:`of` :xref_param_type:`int` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or tuple of ints | | - :xref_param_type:`int` or :xref_param_type:`tuple` :xref_param_type:`of` :xref_param_type:`ints ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or tuple of ints, optional | | - :xref_param_type:`int` or :xref_param_type:`tuple` :xref_param_type:`of` :xref_param_type:`ints `, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or tuple, optional | | - :xref_param_type:`int` or :xref_param_type:`tuple`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, optional | | - :xref_param_type:`int`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, iterable of int | | - :xref_param_type:`int`, :term:`python:iterable` :xref_param_type:`of` :xref_param_type:`int` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, ndarray | | - :xref_param_type:`int`, :xref_param_type:`ndarray ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, optional | | - :xref_param_type:`int`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, slice or sequence of ints | | - :xref_param_type:`int`, :xref_param_type:`slice` or :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`ints ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - integer | | - :xref_param_type:`integer ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - integer type, dtype, or instance | | - :xref_param_type:`integer ` :xref_param_type:`type`, :xref_param_type:`dtype `, :xref_param_type:`or` :xref_param_type:`instance` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - integer, optional | | - :xref_param_type:`integer `, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - iterable | | - :term:`python:iterable` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - keyword arguments | | - :xref_param_type:`keyword` :xref_param_type:`arguments` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list | | - :xref_param_type:`list` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of `m` scalars or scalar, optional | | - :xref_param_type:`list` :xref_param_type:`of` `m` :xref_param_type:`scalars` or :xref_param_type:`scalar`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of array_like | | - :xref_param_type:`list` :xref_param_type:`of` :term:`numpy:array_like` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of arrays | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`arrays` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of bool arrays or bool scalars | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`bool` :xref_param_type:`arrays` or :xref_param_type:`bool` :xref_param_type:`scalars` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of bool ndarrays | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`bool` :xref_param_type:`ndarrays` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of callables, f(x,*args,**kw), or scalars | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`callables`, :xref_param_type:`f`\(x,*args,**kw), :xref_param_type:`or` :xref_param_type:`scalars` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of data-types, optional | | - :xref_param_type:`list` :xref_param_type:`of` data-types, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of int, optional | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`int`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of ints | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`ints ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of ints, optional | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`ints `, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of ndarrays | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`ndarrays` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of scalar or array, optional | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`scalar` or :xref_param_type:`array `, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of slice | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`slice` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of str | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`str` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of str or array_like | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`str` or :term:`numpy:array_like` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of str, optional | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`str`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of strings | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`strings ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of tuples | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`tuples ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list or tuple of str | | - :xref_param_type:`list` or :xref_param_type:`tuple` :xref_param_type:`of` :xref_param_type:`str` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list, optional | | - :xref_param_type:`list`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - masked array or ndarray | | - :xref_param_type:`masked` :xref_param_type:`array ` or :xref_param_type:`ndarray ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - masked_array, optional | | - :xref_param_type:`masked_array`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - masked_array_like | | - :xref_param_type:`masked_array_like` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - matrix | | - :xref_param_type:`matrix ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - matrix object | | - :xref_param_type:`matrix ` :xref_param_type:`object` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - matrix of floats | | - :xref_param_type:`matrix ` :xref_param_type:`of` :xref_param_type:`floats ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - memmap | | - :xref_param_type:`memmap` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - module, optional | | - :xref_param_type:`module`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - module, str or None, optional | | - :xref_param_type:`module`, :xref_param_type:`str` or :xref_param_type:`None`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - narray | | - :xref_param_type:`narray` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray | | - :xref_param_type:`ndarray ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (Ni..., Nj..., Nk...) | | - :xref_param_type:`ndarray ` (Ni..., Nj..., Nk...) | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (Ni..., M, Nk...) | | - :xref_param_type:`ndarray ` (Ni..., :xref_param_type:`M`, Nk...) | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (Ni..., Nj..., Nk...) | | - :xref_param_type:`ndarray ` (Ni..., Nj..., Nk...) | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray of bools | | - :xref_param_type:`ndarray ` :xref_param_type:`of` :xref_param_type:`bools` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray of double. | | - :xref_param_type:`ndarray ` :xref_param_type:`of` double. | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray of float or complex, optional | | - :xref_param_type:`ndarray ` :xref_param_type:`of` :xref_param_type:`float` or :xref_param_type:`complex`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray of floats | | - :xref_param_type:`ndarray ` :xref_param_type:`of` :xref_param_type:`floats ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray of ints | | - :xref_param_type:`ndarray ` :xref_param_type:`of` :xref_param_type:`ints ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray of shape (N, M) | | - :xref_param_type:`ndarray ` :xref_param_type:`of` :xref_param_type:`shape` (:xref_param_type:`N`, :xref_param_type:`M`) | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray of shape (N,M) | | - :xref_param_type:`ndarray ` :xref_param_type:`of` :xref_param_type:`shape` (N,M) | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray or None | | - :xref_param_type:`ndarray ` or :xref_param_type:`None` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray or an ndarray subclass | | - :xref_param_type:`ndarray ` or :xref_param_type:`an` :xref_param_type:`ndarray ` :xref_param_type:`subclass` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray or bool | | - :xref_param_type:`ndarray ` or :xref_param_type:`bool` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray or int | | - :xref_param_type:`ndarray ` or :xref_param_type:`int` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray or list | | - :xref_param_type:`ndarray ` or :xref_param_type:`list` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray or list of ndarray | | - :xref_param_type:`ndarray ` or :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`ndarray ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray or matrix object | | - :xref_param_type:`ndarray ` or :xref_param_type:`matrix ` :xref_param_type:`object` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray or numpy scalar | | - :xref_param_type:`ndarray ` or :xref_param_type:`numpy` :xref_param_type:`scalar` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray or poly1d | | - :xref_param_type:`ndarray ` or :xref_param_type:`poly1d` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray or poly1d object | | - :xref_param_type:`ndarray ` or :xref_param_type:`poly1d` :xref_param_type:`object` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray or scalar | | - :xref_param_type:`ndarray ` or :xref_param_type:`scalar` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, algebra_like | | - :xref_param_type:`ndarray `, :xref_param_type:`algebra_like` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, bool | | - :xref_param_type:`ndarray `, :xref_param_type:`bool` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, compatible object | | - :xref_param_type:`ndarray `, :xref_param_type:`compatible` :xref_param_type:`object` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, dtype or scalar | | - :xref_param_type:`ndarray `, :xref_param_type:`dtype ` or :xref_param_type:`scalar` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, float | | - :xref_param_type:`ndarray `, :xref_param_type:`float` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, int | | - :xref_param_type:`ndarray `, :xref_param_type:`int` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, optional | | - :xref_param_type:`ndarray `, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, optional (Ni..., Nj..., Nk...) | | - :xref_param_type:`ndarray `, optional (Ni..., Nj..., Nk...) | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, scalar | | - :xref_param_type:`ndarray `, :xref_param_type:`scalar` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, see `dtype` parameter above. | | - :xref_param_type:`ndarray `, :xref_param_type:`see` `dtype` :xref_param_type:`parameter` above. | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, see dtype parameter above | | - :xref_param_type:`ndarray `, :xref_param_type:`see` :xref_param_type:`dtype ` :xref_param_type:`parameter` :xref_param_type:`above` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, see dtype parameter above. | | - :xref_param_type:`ndarray `, :xref_param_type:`see` :xref_param_type:`dtype ` :xref_param_type:`parameter` above. | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, shape (M, N) | | - :xref_param_type:`ndarray `, :xref_param_type:`shape` (:xref_param_type:`M`, :xref_param_type:`N`) | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, shape (M,) or (M, K) | | - :xref_param_type:`ndarray `, :xref_param_type:`shape` (M,) :xref_param_type:`or` (:xref_param_type:`M`, :xref_param_type:`K`) | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, shape (M,M) or (M,M,K) | | - :xref_param_type:`ndarray `, :xref_param_type:`shape` (M,M) :xref_param_type:`or` (M,M,K) | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, shape (`deg` + 1,) or (`deg` + 1, `K`) | | - :xref_param_type:`ndarray `, :xref_param_type:`shape` (`deg` + 1,) :xref_param_type:`or` (`deg` + 1, `K`) | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, shape (deg + 1,) | | - :xref_param_type:`ndarray `, :xref_param_type:`shape` (:xref_param_type:`deg` + 1,) | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, shape (deg + 1,) or (deg + 1, K) | | - :xref_param_type:`ndarray `, :xref_param_type:`shape` (:xref_param_type:`deg` + 1,) :xref_param_type:`or` (:xref_param_type:`deg` + 1, :xref_param_type:`K`) | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, shape = x.shape, dtype = x.dtype | | - :xref_param_type:`ndarray `, :xref_param_type:`shape` = :xref_param_type:`x.shape`, :xref_param_type:`dtype ` = :xref_param_type:`x.dtype` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, shape Q | | - :xref_param_type:`ndarray `, :xref_param_type:`shape` :xref_param_type:`Q` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, shape(M,) | | - :xref_param_type:`ndarray `, :xref_param_type:`shape`\(M,) | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, shape(N, N) | | - :xref_param_type:`ndarray `, :xref_param_type:`shape`\(:xref_param_type:`N`, :xref_param_type:`N`) | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, shape(nx+1,) | | - :xref_param_type:`ndarray `, :xref_param_type:`shape`\(nx+1,) | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, shape(nx, ny) | | - :xref_param_type:`ndarray `, :xref_param_type:`shape`\(:xref_param_type:`nx`, :xref_param_type:`ny`) | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, shape(ny+1,) | | - :xref_param_type:`ndarray `, :xref_param_type:`shape`\(ny+1,) | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, {str, unicode} | | - :xref_param_type:`ndarray `, {:xref_param_type:`str`, :xref_param_type:`unicode`} | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray. | | - ndarray. | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndpointer type object | | - :xref_param_type:`ndpointer` :xref_param_type:`type` :xref_param_type:`object` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - nested list of array_like or scalars (but not tuples) | | - :xref_param_type:`nested` :xref_param_type:`list` :xref_param_type:`of` :term:`numpy:array_like` or :xref_param_type:`scalars` (:xref_param_type:`but` :xref_param_type:`not` :xref_param_type:`tuples `) | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - non-negative int | | - non-negative :xref_param_type:`int` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - non-negative integer, optional | | - non-negative :xref_param_type:`integer `, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - non-negative number. | | - non-negative number. | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - np.dtype | | - :xref_param_type:`np.dtype` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - np.ndarray | | - :xref_param_type:`np.ndarray` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - number, optional | | - :xref_param_type:`number`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - numpy object | | - :xref_param_type:`numpy` :xref_param_type:`object` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - numpy scalar | | - :xref_param_type:`numpy` :xref_param_type:`scalar` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - numpy.ndarray | | - :xref_param_type:`numpy.ndarray` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - object | | - :xref_param_type:`object` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - object or str, optional | | - :xref_param_type:`object` or :xref_param_type:`str`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - one of 'k', '.', '0', '-', optional | | - :xref_param_type:`one` :xref_param_type:`of` 'k', '.', '0', '-', optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - optional | | - optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - optional float or complex corresponding to fp | | - optional :xref_param_type:`float` or :xref_param_type:`complex` :xref_param_type:`corresponding` :xref_param_type:`to` :xref_param_type:`fp` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - output mask | | - :xref_param_type:`output` :xref_param_type:`mask` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - poly1d | | - :xref_param_type:`poly1d` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - poly1d or sequence | | - :xref_param_type:`poly1d` or :term:`python:sequence` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - positive int | | - :xref_param_type:`positive` :xref_param_type:`int` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - python float or numpy floating scalar | | - :xref_param_type:`python` :xref_param_type:`float` or :xref_param_type:`numpy` :xref_param_type:`floating` :xref_param_type:`scalar` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - recarray | | - :xref_param_type:`recarray` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar | | - :xref_param_type:`scalar` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar dtype or object | | - :xref_param_type:`scalar` :xref_param_type:`dtype ` or :xref_param_type:`object` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar or MaskedArray | | - :xref_param_type:`scalar` or :xref_param_type:`MaskedArray ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar or None | | - :xref_param_type:`scalar` or :xref_param_type:`None` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar or array_like of shape(M, ) | | - :xref_param_type:`scalar` or :term:`numpy:array_like` :xref_param_type:`of` :xref_param_type:`shape`\(:xref_param_type:`M`, ) | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar or array_like of shape(M, ), optional | | - :xref_param_type:`scalar` or :term:`numpy:array_like` :xref_param_type:`of` :xref_param_type:`shape`\(:xref_param_type:`M`, ), optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar or array_like or `None` | | - :xref_param_type:`scalar` or :term:`numpy:array_like` or `None` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar or ndarray | | - :xref_param_type:`scalar` or :xref_param_type:`ndarray ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar, optional | | - :xref_param_type:`scalar`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - seq | | - :xref_param_type:`seq` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - seq or str | | - :xref_param_type:`seq` or :xref_param_type:`str` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - sequence | | - :term:`python:sequence` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - sequence of 1-D or 2-D arrays. | | - :term:`python:sequence` :xref_param_type:`of` 1-D or 2-D arrays. | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - sequence of array_like | | - :term:`python:sequence` :xref_param_type:`of` :term:`numpy:array_like` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - sequence of arrays | | - :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`arrays` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - sequence of datatypes, optional | | - :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`datatypes`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - sequence of int, optional | | - :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`int`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - sequence of ints | | - :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`ints ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - sequence of ints, optional | | - :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`ints `, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - sequence of ndarrays | | - :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`ndarrays` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - sequence of str | | - :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`str` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - sequence of str, optional | | - :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`str`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - sequence or int, optional | | - :term:`python:sequence` or :xref_param_type:`int`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - sequence, optional | | - :term:`python:sequence`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - series | | - :xref_param_type:`series ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - set | | - :xref_param_type:`set` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - set, optional | | - :xref_param_type:`set`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - slice, int or array of ints | | - :xref_param_type:`slice`, :xref_param_type:`int` or :xref_param_type:`array ` :xref_param_type:`of` :xref_param_type:`ints ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str | | - :xref_param_type:`str` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str of length 256 | | - :xref_param_type:`str` :xref_param_type:`of` :xref_param_type:`length` 256 | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or None | | - :xref_param_type:`str` or :xref_param_type:`None` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or None, optional | | - :xref_param_type:`str` or :xref_param_type:`None`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or array_like | | - :xref_param_type:`str` or :term:`numpy:array_like` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or bytes | | - :xref_param_type:`str` or :xref_param_type:`bytes` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or dtype object, optional | | - :xref_param_type:`str` or :xref_param_type:`dtype ` :xref_param_type:`object`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or file | | - :xref_param_type:`str` or :xref_param_type:`file` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or file-like object | | - :xref_param_type:`str` or :term:`file-like` :xref_param_type:`object` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or function | | - :xref_param_type:`str` or :xref_param_type:`function` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or list of dtypes, optional | | - :xref_param_type:`str` or :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`dtypes`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or list of str | | - :xref_param_type:`str` or :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`str` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or list of str, optional | | - :xref_param_type:`str` or :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`str`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or list, optional | | - :xref_param_type:`str` or :xref_param_type:`list`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or list/tuple of str | | - :xref_param_type:`str` or list/tuple :xref_param_type:`of` :xref_param_type:`str` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or pathlib.Path instance | | - :xref_param_type:`str` or :xref_param_type:`pathlib.Path` :xref_param_type:`instance` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or regexp | | - :xref_param_type:`str` or :xref_param_type:`regexp` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or seq | | - :xref_param_type:`str` or :xref_param_type:`seq` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or sequence | | - :xref_param_type:`str` or :term:`python:sequence` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or sequence of str, optional | | - :xref_param_type:`str` or :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`str`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or sequence of strs, optional | | - :xref_param_type:`str` or :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`strs`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or sequence, optional | | - :xref_param_type:`str` or :term:`python:sequence`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or tuple of str | | - :xref_param_type:`str` or :xref_param_type:`tuple` :xref_param_type:`of` :xref_param_type:`str` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or unicode | | - :xref_param_type:`str` or :xref_param_type:`unicode` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or unicode, optional | | - :xref_param_type:`str` or :xref_param_type:`unicode`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str {'dll', 'exe'} | | - :xref_param_type:`str` {'dll', 'exe'} | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str, None, module | | - :xref_param_type:`str`, :xref_param_type:`None`, :xref_param_type:`module` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str, bytes, file | | - :xref_param_type:`str`, :xref_param_type:`bytes`, :xref_param_type:`file` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str, file-like object, or pathlib.Path instance | | - :xref_param_type:`str`, :term:`file-like` :xref_param_type:`object`, :xref_param_type:`or` :xref_param_type:`pathlib.Path` :xref_param_type:`instance` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str, int, or sequence of ints, optional | | - :xref_param_type:`str`, :xref_param_type:`int`, :xref_param_type:`or` :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`ints `, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str, int, or sequence, optional | | - :xref_param_type:`str`, :xref_param_type:`int`, :xref_param_type:`or` :term:`python:sequence`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str, optional | | - :xref_param_type:`str`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string | | - :xref_param_type:`string ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string or `False`, optional | | - :xref_param_type:`string ` or `False`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string or sequence | | - :xref_param_type:`string ` or :term:`python:sequence` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string or sequence, optional | | - :xref_param_type:`string ` or :term:`python:sequence`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, either '-', '+', or ' ', optional | | - :xref_param_type:`string `, :xref_param_type:`either` '-', '+', :xref_param_type:`or` ' ', optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, filehandle | | - :xref_param_type:`string `, :xref_param_type:`filehandle` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, optional | | - :xref_param_type:`string `, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, sequence | | - :xref_param_type:`string `, :term:`python:sequence` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - structured array | | - :xref_param_type:`structured` :xref_param_type:`array ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - test object | | - :xref_param_type:`test` :xref_param_type:`object` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple | | - :xref_param_type:`tuple` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple of arrays | | - :xref_param_type:`tuple` :xref_param_type:`of` :xref_param_type:`arrays` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple of arrays. | | - :xref_param_type:`tuple` :xref_param_type:`of` arrays. | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple of index objects | | - :xref_param_type:`tuple` :xref_param_type:`of` :xref_param_type:`index` :xref_param_type:`objects` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple of indexing objects | | - :xref_param_type:`tuple` :xref_param_type:`of` :xref_param_type:`indexing` :xref_param_type:`objects` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple of int | | - :xref_param_type:`tuple` :xref_param_type:`of` :xref_param_type:`int` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple of int (major, minor) or None | | - :xref_param_type:`tuple` :xref_param_type:`of` :xref_param_type:`int` (:xref_param_type:`major`, :xref_param_type:`minor`) :xref_param_type:`or` :xref_param_type:`None` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple of ints | | - :xref_param_type:`tuple` :xref_param_type:`of` :xref_param_type:`ints ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple of ints or int, optional | | - :xref_param_type:`tuple` :xref_param_type:`of` :xref_param_type:`ints ` or :xref_param_type:`int`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple of ints, length 2 | | - :xref_param_type:`tuple` :xref_param_type:`of` :xref_param_type:`ints `, :xref_param_type:`length` 2 | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple of ints, optional | | - :xref_param_type:`tuple` :xref_param_type:`of` :xref_param_type:`ints `, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple of ndarrays | | - :xref_param_type:`tuple` :xref_param_type:`of` :xref_param_type:`ndarrays` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple of str, optional | | - :xref_param_type:`tuple` :xref_param_type:`of` :xref_param_type:`str`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple of tuples | | - :xref_param_type:`tuple` :xref_param_type:`of` :xref_param_type:`tuples ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple, optional | | - :xref_param_type:`tuple`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple, shape(2) of ndarray, shape(N) | | - :xref_param_type:`tuple`, :xref_param_type:`shape`\(2) :xref_param_type:`of` :xref_param_type:`ndarray `, :xref_param_type:`shape`\(:xref_param_type:`N`) | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple, shape(2) of ndarrays, shape(`n`) | | - :xref_param_type:`tuple`, :xref_param_type:`shape`\(2) :xref_param_type:`of` :xref_param_type:`ndarrays`, :xref_param_type:`shape`\(`n`) | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - unicode | | - :xref_param_type:`unicode` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - var | | - :xref_param_type:`var` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - variable, optional | | - :xref_param_type:`variable`, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - z-series | | - z-series | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - { (..., M, M), (..., M, K) } array | | - { (..., :xref_param_type:`M`, :xref_param_type:`M`), (..., :xref_param_type:`M`, :xref_param_type:`K`) } :xref_param_type:`array ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - { (..., N, N), (..., K, N) } array | | - { (..., :xref_param_type:`N`, :xref_param_type:`N`), (..., :xref_param_type:`K`, :xref_param_type:`N`) } :xref_param_type:`array ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'#', string}, optional | | - {'#', :xref_param_type:`string `}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'', string}, optional | | - {'', :xref_param_type:`string `}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'.f', '.f90'}, optional | | - {'.f', '.f90'}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'<', '>', '='}, optional | | - {'<', '>', '='}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'C', 'F', 'A', 'K'}, optional | | - {'C', 'F', 'A', 'K'}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'C', 'F', 'A', or 'K'}, optional | | - {'C', 'F', 'A', :xref_param_type:`or` 'K'}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'C', 'F', 'A'}, optional | | - {'C', 'F', 'A'}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'C', 'F'}, optional | | - {'C', 'F'}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'C','F', 'A', 'K'}, optional | | - {'C','F', 'A', 'K'}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'C','F','A'}, optional | | - {'C','F','A'}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'L', 'U'}, optional | | - {'L', 'U'}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'even', 'odd'}, optional | | - {'even', 'odd'}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'fast', 'full', '', attribute identifier}, optional | | - {'fast', 'full', '', :xref_param_type:`attribute` :xref_param_type:`identifier`}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'full', 'valid', 'same'}, optional | | - {'full', 'valid', 'same'}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'ignore', 'warn', 'raise', 'call', 'print', 'log'}, optional | | - {'ignore', 'warn', 'raise', 'call', 'print', 'log'}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'inner', 'outer', 'leftouter'}, optional | | - {'inner', 'outer', 'leftouter'}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'introselect'}, optional | | - {'introselect'}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'left', 'right'}, optional | | - {'left', 'right'}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'linear', 'lower', 'higher', 'midpoint', 'nearest'} | | - {'linear', 'lower', 'higher', 'midpoint', 'nearest'} | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'no', 'equiv', 'safe', 'same_kind', 'unsafe'}, optional | | - {'no', 'equiv', 'safe', 'same_kind', 'unsafe'}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'quicksort', 'mergesort', 'heapsort'}, optional | | - {'quicksort', 'mergesort', 'heapsort'}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'r', 'w', 'a'}, optional | | - {'r', 'w', 'a'}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'r', 'w'} | | - {'r', 'w'} | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'r+', 'r', 'w+', 'c'}, optional | | - {'r+', 'r', 'w+', 'c'}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'raise' (default), 'wrap', 'clip'}, optional | | - {'raise' (default), 'wrap', 'clip'}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'raise', 'wrap', 'clip'}, optional | | - {'raise', 'wrap', 'clip'}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'reduced', 'complete', 'r', 'raw', 'full', 'economic'}, optional | | - {'reduced', 'complete', 'r', 'raw', 'full', 'economic'}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'valid', 'same', 'full'}, optional | | - {'valid', 'same', 'full'}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'xy', 'ij'}, optional | | - {'xy', 'ij'}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {(..., M, M) ndarray, (..., M, M) matrix} | | - {(..., :xref_param_type:`M`, :xref_param_type:`M`) :xref_param_type:`ndarray `, (..., :xref_param_type:`M`, :xref_param_type:`M`) :xref_param_type:`matrix `} | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {(..., M,), (..., M, K)} ndarray | | - {(..., M,), (..., :xref_param_type:`M`, :xref_param_type:`K`)} :xref_param_type:`ndarray ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {(..., M,), (..., M, K)}, array_like | | - {(..., M,), (..., :xref_param_type:`M`, :xref_param_type:`K`)}, :term:`numpy:array_like` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {(1,), (K,), (0,)} ndarray | | - {(1,), (K,), (0,)} :xref_param_type:`ndarray ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {(M,), (..., M, N)} array_like | | - {(M,), (..., :xref_param_type:`M`, :xref_param_type:`N`)} :term:`numpy:array_like` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {(M,), (M, K)} array_like | | - {(M,), (:xref_param_type:`M`, :xref_param_type:`K`)} :term:`numpy:array_like` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {(N,), (N, K)} ndarray | | - {(N,), (:xref_param_type:`N`, :xref_param_type:`K`)} :xref_param_type:`ndarray ` | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {1, 2}, optional | | - {1, 2}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {False, True, 'greedy', 'optimal'}, optional | | - {:xref_param_type:`False`, :xref_param_type:`True`, 'greedy', 'optimal'}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {False, True}, optional | | - {:xref_param_type:`False`, :xref_param_type:`True`}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {None, "ortho"}, optional | | - {:xref_param_type:`None`, "ortho"}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {None, 'r+', 'r', 'w+', 'c'}, optional | | - {:xref_param_type:`None`, 'r+', 'r', 'w+', 'c'}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {None, 1, -1, 2, -2, inf, -inf, 'fro'}, optional | | - {:xref_param_type:`None`, 1, -1, 2, -2, :xref_param_type:`inf`, -inf, 'fro'}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {None, True, str, sequence}, optional | | - {:xref_param_type:`None`, :xref_param_type:`True`, :xref_param_type:`str`, :term:`python:sequence`}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {None, [beg, end], []}, optional | | - {:xref_param_type:`None`, [:xref_param_type:`beg`, :xref_param_type:`end`], []}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {None, [beg, end]}, optional | | - {:xref_param_type:`None`, [:xref_param_type:`beg`, :xref_param_type:`end`]}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {None, array_like}, optional | | - {:xref_param_type:`None`, :term:`numpy:array_like`}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {None, array}, optional | | - {:xref_param_type:`None`, :xref_param_type:`array `}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {None, dtype, function}, optional | | - {:xref_param_type:`None`, :xref_param_type:`dtype `, :xref_param_type:`function`}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {None, dtype}, optional | | - {:xref_param_type:`None`, :xref_param_type:`dtype `}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {None, integer} | | - {:xref_param_type:`None`, :xref_param_type:`integer `} | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {None, integer}, optional | | - {:xref_param_type:`None`, :xref_param_type:`integer `}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {None, int}, optional | | - {:xref_param_type:`None`, :xref_param_type:`int`}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {None, ndarray}, optional | | - {:xref_param_type:`None`, :xref_param_type:`ndarray `}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {None, sequence of str}, optional | | - {:xref_param_type:`None`, :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`str`}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {None, sequence}, optional | | - {:xref_param_type:`None`, :term:`python:sequence`}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {None, string}, optional | | - {:xref_param_type:`None`, :xref_param_type:`string `}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {None, str}, optional | | - {:xref_param_type:`None`, :xref_param_type:`str`}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {None,int}, optional | | - {None,int}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {True, False, 'upper', 'lower'}, optional | | - {:xref_param_type:`True`, :xref_param_type:`False`, 'upper', 'lower'}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {True, False}, | | - {:xref_param_type:`True`, :xref_param_type:`False`}, | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {True, False}, optional | | - {:xref_param_type:`True`, :xref_param_type:`False`}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {[], None, array_like}, optional | | - {[], :xref_param_type:`None`, :term:`numpy:array_like`}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {[], list, scalar}, optional | | - {[], :xref_param_type:`list`, :xref_param_type:`scalar`}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {[beg, end]}, optional | | - {[:xref_param_type:`beg`, :xref_param_type:`end`]}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {bool, None}, optional | | - {:xref_param_type:`bool`, :xref_param_type:`None`}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {bool, list, tuple, 'greedy', 'optimal'} | | - {:xref_param_type:`bool`, :xref_param_type:`list`, :xref_param_type:`tuple`, 'greedy', 'optimal'} | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {boolean}, optional | | - {:xref_param_type:`boolean `}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {data-type, None}, optional | | - {data-type, :xref_param_type:`None`}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {dictionary}, optional | | - {:xref_param_type:`dictionary `}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {divide, over, under, invalid} | | - {:xref_param_type:`divide`, :xref_param_type:`over`, :xref_param_type:`under`, :xref_param_type:`invalid`} | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {file name/handle} | | - {:xref_param_type:`file` name/handle} | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {float, inf} | | - {:xref_param_type:`float`, :xref_param_type:`inf`} | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {float}, optional | | - {:xref_param_type:`float`}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {int, 2-tuple of ints, None}, optional | | - {:xref_param_type:`int`, 2-tuple :xref_param_type:`of` :xref_param_type:`ints `, :xref_param_type:`None`}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {int, sequence of int, None}, optional | | - {:xref_param_type:`int`, :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`int`, :xref_param_type:`None`}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {int, tuple of int, None}, optional | | - {:xref_param_type:`int`, :xref_param_type:`tuple` :xref_param_type:`of` :xref_param_type:`int`, :xref_param_type:`None`}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {integer_array} | | - {:xref_param_type:`integer_array`} | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {ndarray, None}, optional | | - {:xref_param_type:`ndarray `, :xref_param_type:`None`}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {ndarray, numpy scalar} | | - {:xref_param_type:`ndarray `, :xref_param_type:`numpy` :xref_param_type:`scalar`} | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {nomask, sequence}, optional. | | - {:xref_param_type:`nomask`, :term:`python:sequence`}, optional. | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {non-zero int, inf, -inf, 'fro', 'nuc'}, optional | | - {non-zero :xref_param_type:`int`, :xref_param_type:`inf`, -inf, 'fro', 'nuc'}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {sequence of ints, int} | | - {:term:`python:sequence` :xref_param_type:`of` :xref_param_type:`ints `, :xref_param_type:`int`} | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {sequence of str, None}, optional | | - {:term:`python:sequence` :xref_param_type:`of` :xref_param_type:`str`, :xref_param_type:`None`}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {sequence, array_like, float, int}, optional | | - {:term:`python:sequence`, :term:`numpy:array_like`, :xref_param_type:`float`, :xref_param_type:`int`}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {sequence, array_like, int} | | - {:term:`python:sequence`, :term:`numpy:array_like`, :xref_param_type:`int`} | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {sequence, int}, optional | | - {:term:`python:sequence`, :xref_param_type:`int`}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {str, unicode} | | - {:xref_param_type:`str`, :xref_param_type:`unicode`} | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {str, unicode}, optional | | - {:xref_param_type:`str`, :xref_param_type:`unicode`}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {string, None}, optional | | - {:xref_param_type:`string `, :xref_param_type:`None`}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {string, sequence} | | - {:xref_param_type:`string `, :term:`python:sequence`} | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {var}, optional | | - {:xref_param_type:`var`}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {{'begin', 1}, {'end', 0}}, {string, int} | | - {{'begin', 1}, {'end', 0}}, {:xref_param_type:`string `, :xref_param_type:`int`} | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {{'begin', 1}, {'end', 0}}, {string, int}, optional | | - {{'begin', 1}, {'end', 0}}, {:xref_param_type:`string `, :xref_param_type:`int`}, optional | +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+