summaryrefslogtreecommitdiff
path: root/doc/source/reference
Commit message (Collapse)AuthorAgeFilesLines
* API: Do not import sliding_window_view to main namespaceSebastian Berg2020-11-051-1/+1
| | | | | At least for now, lets not import it to the main namespace, since there is no agreement that this is a good idea.
* ENH: Implement sliding window (gh-17394)Klaus Zimmermann2020-11-051-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * implement sliding_window_view #7753 Test cases are shown in the issue page. * Add Example Cases * Add step_size and N-dim support * Add shape and step_size check. Remove warning. * Remove shape default Add step_size default's description. * Give proper parameter name 'step' * fix a parameter description mistake * implement test function for sliding_window_view() * implement test function for sliding_window_view() * Fix according to @eric-wieser comments * Change arange to ogrid in Examples * remove np.squeeze on return line * Clarify document to avoid parameter confusion. * add `writable` and more explanation in docs * resolve a write conflit * fixes according to @seberg review * resolve write hazard * remove outdated docs. * change referring according to @mattip. change 'writeable' to 'readonly' as @seberg suggest. remove 'step' as @eric-wieser request * fix test minor error * DOC: Grammar fixes * STY: Add missing line break required by PEP8 * + Change readonly parameter to writeable. + Update writeable description. + Fix a few parameter checks. + Other minor improvements. * Move to new api as proposed by @eric-wieser - Change api to follow suggestion by Eric Wieser in https://github.com/numpy/numpy/pull/10771#issuecomment-524715356 - Update docstring - Add more tests * Improve documentation * Add sliding_window_view to documentation index * Apply suggestions from code review Co-authored-by: Eric Wieser <wieser.eric@gmail.com> * Fix window shape check * Add `sliding_window_view` to __all__ * Add tests for error cases * Add array_function dispatching * Change dispatcher argument defaults to None * Simplify array function dispatching * Added "np." prefix to doctests * Split tests * Improved docstring * Add release note * Fix docstring formatting * Fix doctest * Remove namespacing in documentation indexing * Improve docstring * Improved docstring * Simplified docstring * Improve docstring to make pseudo code stand out * Improve docstring * Add simple application example * Correct release note * Improve link with as_strides * Add note about performance * Tidy up main doc string * Make language on performance warning stronger * Bugfix: pass subok and writeable to as_strided * Add writeable test * Add subok test * Change subok test to use custom array subclass instead of unsupported MaskedArray * Add version added information Co-authored-by: Eric Wieser <wieser.eric@gmail.com> Co-authored-by: Fanjin <fjzeng@ucsd.edu> Co-authored-by: Fanjin Zeng <Fnjn@users.noreply.github.com> Co-authored-by: Eric Wieser <wieser.eric@gmail.com> Co-authored-by: fanjin <fjzeng@outlook.com> Closes gh-7753
* DOC: Add ``ma.isMaskedArray`` and aliasestakanori-pskq2020-11-051-0/+3
|
* Update doc/source/reference/c-api/array.rstTakanori H2020-10-271-1/+1
| | | Co-authored-by: Eric Wieser <wieser.eric@gmail.com>
* DOC: Fix some referencestakanori-pskq2020-10-265-10/+11
|
* DOC: Don't use Python highlighting for non-python codeEric Wieser2020-10-252-2/+6
|
* Merge pull request #17627 from takanori-pskq/i13114-array-structMatti Picus2020-10-256-15/+15
|\ | | | | DOC: Fix the references for ``__array_*__``
| * DOC: Fix the references for ``__array_*__``takanori-pskq2020-10-256-15/+15
| |
* | Merge pull request #17630 from takanori-pskq/i13114-capsuleMatti Picus2020-10-251-2/+3
|\ \ | | | | | | DOC: Replace ``PyCObject`` with ``PyCapsule``
| * | DOC: Replace ``PyCObject`` with ``PyCapsule``takanori-pskq2020-10-251-2/+3
| |/
* | Merge pull request #17629 from takanori-pskq/i13114-pyufunc-identityMatti Picus2020-10-251-3/+9
|\ \ | | | | | | DOC: Add ``identity_value`` to ``PyUFuncObject``
| * | DOC: Add ``identity_value`` to ``PyUFuncObject``takanori-pskq2020-10-251-3/+9
| |/
* | DOC: Add entries for macrostakanori-pskq2020-10-251-3/+29
|/
* DOC: Tidy up references to str_ / bytes_Eric Wieser2020-10-244-13/+12
| | | | | | | | This: * Fixes some broken references * Cleans up some use of Python 2 aliases: * Switches references to `np.string_` to describe `np.bytes_` instead * Switches references to `np.unicode_` to describe `np.str_` instead
* DOC: Fixup for ``PyUFunc_*``takanori-pskq2020-10-241-1/+3
|
* Update doc/source/reference/random/c-api.rstTakanori H2020-10-241-2/+1
| | | Co-authored-by: Eric Wieser <wieser.eric@gmail.com>
* DOC: Fixup for PR #17614takanori-pskq2020-10-241-1/+1
|
* DOC: Fix some referencestakanori-pskq2020-10-248-25/+28
|
* DOC: Fix the document for arrays interfacetakanori-pskq2020-10-231-14/+14
|
* Merge pull request #17570 from takanori-pskq/i13114-feature-versionMatti Picus2020-10-221-12/+16
|\ | | | | DOC: Add the entry for ``NPY_FEATURE_VERSION``
| * DOC: Fixuptakanori-pskq2020-10-221-17/+16
| |
| * DOC: Add the entry for ``NPY_FEATURE_VERSION``takanori-pskq2020-10-151-0/+5
| |
* | ENH: add function to get broadcast shape from a given set of shapes. (#17535)madhulikajc2020-10-171-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * ENH: add function to get broadcast shape from a given set of shapes. Add new function numpy.broadcast_shape which takes tuples for the shapes to be broadcast against each other. Return the broadcasted shape as a tuple. See #17217 * Perform array allocations of size 0 for provided shape tuples Co-authored-by: Eric Wieser <wieser.eric@gmail.com> * Test for int as input shape Also update docstring to include both ints and tuples of ints as input * Remove unnecessary array_function_dispatch * Add missing set_module * Add release notes. Add versionadded to docstring. Also fix up docstring details. * follow convention for trailing comma Co-authored-by: Sebastian Berg <sebastian@sipsolutions.net> * Change name to broadcast_shapes. Also add test case, and type hint. * follow convention Co-authored-by: Eric Wieser <wieser.eric@gmail.com> * Update docstring Co-authored-by: Eric Wieser <wieser.eric@gmail.com> * Add reference to numpy docs on broadcasting to docstring Also move versionadded * Fix spelling Co-authored-by: Warren Weckesser <warren.weckesser@gmail.com> * Add broadcast_shapes to reference docs and add See Also sections Co-authored-by: Eric Wieser <wieser.eric@gmail.com> Co-authored-by: Sebastian Berg <sebastian@sipsolutions.net> Co-authored-by: Warren Weckesser <warren.weckesser@gmail.com>
* | DOC: Fix Boolean array indexing typoBen Derrett2020-10-161-1/+1
| |
* | DOC: Fix typostakanori-pskq2020-10-152-3/+3
|/
* Merge pull request #17559 from takanori-pskq/i16217-remove-directivesMatti Picus2020-10-142-16/+6
|\ | | | | DOC: Remove directives for some constants
| * DOC: Remove directives for some constantstakanori-pskq2020-10-142-16/+6
| |
* | DOC: Fix wrong blockquotestakanori-pskq2020-10-141-8/+0
|/
* DOC: Add missing types to C function docs (#17549)Takanori H2020-10-134-86/+87
| | | `.. c:function::` expects its contents to be a valid C prototype, meaning the return types and arguments are all need types.
* DOC: Fix Boolean types in C functionstakanori-pskq2020-10-102-9/+9
|
* DOC: Fixing references in ma docstrings (#16300)Takanori H2020-10-071-1/+1
| | | Fix broken links in see also section of some ma functions.
* Merge pull request #17481 from takanori-pskq/i13114-fix-structures-memberMatti Picus2020-10-071-251/+251
|\ | | | | DOC: Fix the entries for members of structures
| * DOC: Fix the entries for members of structurestakanori-pskq2020-10-071-251/+251
| |
* | DOC: rm numpy. from type alias attr definitions.Ross Barnowski2020-10-061-14/+14
| |
* | DOC: add some missing scalar aliasesEric Wieser2020-10-061-5/+23
|/
* Merge pull request #17464 from takanori-pskq/i13114-add-entriesMatti Picus2020-10-062-75/+112
|\ | | | | DOC: Add some entries for C types and macros
| * Fix: Remove the link for `PyArrayMapIterObject`takanori-pskq2020-10-061-3/+1
| |
| * Fixuptakanori-pskq2020-10-061-2/+2
| |
| * DOC: Add some entries for C types and macrostakanori-pskq2020-10-062-74/+113
| |
* | Merge pull request #17331 from eric-wieser/remove-scalar-tablesMatti Picus2020-10-061-99/+220
|\ \ | |/ |/| DOC: Remove the tables of scalar types, and use `..autoclass` to create link targets instead
| * DOC: typo.Ross Barnowski2020-10-051-1/+1
| |
| * DOC: Overhaul the scalar type documentation to use `..autoclass`Eric Wieser2020-10-041-99/+220
| | | | | | | | | | | | This remove the tables. since they only had three columns, and using the character code is advised against anyway. With this change, the individual scalar types as well as their aliases are now valid sphinx python domain targets.
* | DOC: Fix some references for macrostakanori-pskq2020-10-054-9/+18
| |
* | Fix: Add the entry for `NPY_ARR_HAS_DESCR`takanori-pskq2020-10-051-0/+2
| |
* | DOC: Fix the references for macrostakanori-pskq2020-10-043-5/+17
|/
* DOC: Fix the links for ``Ellipsis`` (#17431)Takanori H2020-10-021-4/+4
|
* DOC: Add arraysetops to autosummary.Ross Barnowski2020-09-291-0/+5
| | | | | | * Generate stub for module, fixes 7 broken links * Modify arraysetops module docstring w/ rst formatting * Remove listing of functions from module docstring.
* DOC: Fix incorrect `.. deprecated::` syntax that led to this note being ↵Eric Wieser2020-09-181-8/+9
| | | | invisible.
* Merge pull request #17330 from eric-wieser/dtype-docsSebastian Berg2020-09-161-26/+29
|\ | | | | DOC: improve `issubdtype` and scalar type docs
| * DOC: Fix broken references and make the tables a little clearerEric Wieser2020-09-161-26/+29
| | | | | | | | | | | | `types.BooleanType` and similar names were python2 things that no longer exist `unicode` also no longer exists, and is now `str`
View Lorry Controller Status