summaryrefslogtreecommitdiff
path: root/doc/source
Commit message (Collapse)AuthorAgeFilesLines
...
| * | | Add/remove spaces in snippets and re-format here and thereRin Arakaki2020-12-111-200/+184
| |/ /
* | | Merge pull request #16370 from takanori-pskq/i16217Matti Picus2020-12-1615-168/+235
|\ \ \ | | | | | | | | DOC: Fix for building with sphinx 3
| * | | DOC: Fix for buildling with sphinx 3takanori-pskq2020-11-0615-168/+235
| | | |
* | | | Merge pull request #17637 from takanori-pskq/i13114-add-module-templateMatti Picus2020-12-161-0/+40
|\ \ \ \ | | | | | | | | | | DOC: Add module template
| * | | | Update doc/source/_templates/autosummary/module.rstTakanori H2020-10-291-1/+3
| | | | | | | | | | | | | | | Co-authored-by: Eric Wieser <wieser.eric@gmail.com>
| * | | | DOC: Add module templatetakanori-pskq2020-10-261-0/+38
| | | | |
* | | | | DOC: Add more information about poly1d -> polynomial to reference guide (#16164)Ross Barnowski2020-12-151-10/+154
| |_|_|/ |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Added internal link to polynomial package. Also uncapitalized Polynomial, to mitigate potential confusion of the Polynomial convenience class with the polynomial package. * WIP: Adding transition guide from poly1d to polynomial * WIP: Started adding quickref table for poly transition * WIP: Finish fleshing out transition guide for polynomials * Proofreading transition guide. * Fix traceback in code example for failing doctest. * DOC: Remove trailing _ from sphinx links. Was causing a CI failure on building the devdocs * Fix typo. Co-Authored-By: Chris Barnes <barnesc@janelia.hhmi.org> * DOC: Add note about terminology. Clarify the distinction between polynomial module and polynomial package. Co-authored-by: Chris Barnes <barnesc@janelia.hhmi.org>
* | | | DOC: Rename basics to fundamentals + added description (#17889)Ryan C Cooper2020-12-131-5/+9
| | | |
* | | | Merge pull request #17888 from spaceofmiah/patch-1Ralf Gommers2020-12-121-1/+1
|\ \ \ \ | |_|_|/ |/| | | DOC: Correct sentence/statement composition
| * | | Correct sentence/statement compositionAgbonze Osazuwa2020-12-011-1/+1
| | | | | | | | | | | | | | | | | | | | Incorrect statement spotted *In the simplest example of broadcasting, the scalar ``b`` is stretched to become an array ~of with the same~ shape as ``a`` so the shapes are compatible for element-by-element multiplication.*
* | | | DOC: Move links to the end of the sections in new debugging textSebastian Berg2020-12-051-4/+6
| | | |
* | | | Apply suggestions from code reviewSebastian Berg2020-12-051-8/+10
| | | | | | | | | | | | Co-authored-by: Matti Picus <matti.picus@gmail.com>
* | | | DOC: Add information about leak checking and valgrindSebastian Berg2020-12-053-0/+190
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This is not meant to be a fool-proof guide. It isn't and I do not want to expect people to use it... But I realize that I use these things semi-regulary (even if I never bother to remove all wrinkles) and it is good to have the information somewhere so that everyone knows where to look.
* | | | DOC: Update release notes to mention `type(dtype) is not np.dtype`Sebastian Berg2020-12-041-0/+29
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This also requires mentioning the C-API macro `#define PyArray_DescrCheck(op) PyObject_TypeCheck(op, &PyArrayDescr_Type)` which was updated to the above in 1.16.6 meaning that using the macro and compiling against an older NumPy version will cause issues. The macro has to be avoided in that case.
* | | | Merge pull request #17876 from sfolje0/quick-fixMatti Picus2020-12-021-0/+0
|\ \ \ \ | |/ / / |/| | | DOC: fixed typo in np-indexing.png explaining [-2:] slice in user guide
| * | | DOC: fixed typo in np-indexing.png explaining [-2:] slice in user guidesfolje02020-11-291-0/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | In User Guide of NumPy in tutorial for absulute beginners, i.e. in documentation document doc/source/user/absulute_beginners.rst there was a typo in the image np-indexing.png visualizing slices in **Indexing and slicing** section. Namely, in the first image in mentioned section, the last visualized array (under `data[-2:]` command), there was a picture of `data[:]` or `data[0:3]` (i.e. array([1,2,3])) presenting the slice indexing. But it should be a picture of of `data[-2:]` (i.e. array([2,3])). This commit fixes this by adding additional picture of array([2,3]) under `data[-2:]` command and changing command above last array([1,2,3]) pic to title named `data` to preserve the idea behind slice indexing.
* | | | Merge pull request #17875 from charris/prepare-for-1.20.0-releaseCharles Harris2020-11-301-0/+898
|\ \ \ \ | |/ / / |/| | | DOC: Prepare for 1.20.0 release
| * | | DOC: Prepare NumPy 1.20.0 release notes.Charles Harris2020-11-291-62/+93
| | | |
| * | | DOC: Run towncrier to produce unedited release notes.Charles Harris2020-11-281-0/+867
| | | | | | | | | | | | | | | | | | | | This is a separate commit so that it can be cherry-picked to master to cleanup the upcoming_changes directory.
* | | | DOC: fix typo in glossary.rstHollow Man2020-11-291-1/+1
| | | | | | | | | | | | | | | | Responsiblity -> Responsibility
* | | | MAINT: Update master after 1.20.x branch.v1.21.0.dev0Charles Harris2020-11-272-0/+7
|/ / / | | | | | | | | | | | | | | | | | | | | | - Update setup.py - Update pavement.py - Add 1.21.0-note.rst - Update npyconfig.h - Clear release/upcoming_changes
* | | ENH,API: Store exported buffer info on the array (#16938)Sebastian Berg2020-11-261-0/+24
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * ENH,API: Store exported buffer info on the array This speeds up array deallocation and buffer exports, since it removes the need to global dictionary lookups. It also somewhat simplifies the logic. The main advantage is prossibly less the speedup itself (which is not large compared to most things that happen in the livetime of an array), but rather that no unnecessary work is done for shortlived arrays, which never export a buffer. The downside of this approach is that the ABI changes for anyone who would be subclassing ndarray in C. * MAINT: Do not tag the NULL (no buffers exported) The allocation is not the right place to initialize to anything but NULL, so take the easy path and do not tag the NULL default. * TST: Add test for best try RuntimeError on corrupt buffer-info * Remove NPY_SIZEOF_PYARRAYOBJECT and add some documentation * Use 3 to tag the pointer and object for a "bad" one in the test * DEP: deprecate the NPY_SIZEOF_PYARRAYOBJECT macro * Tune down matti's deprecation to write the error instead. * Tweak macro, so that clang hopefully doesn't complain. * Use None instead of NULL in PyErr_WriteUnraisable, pypy seems to have a bug with it * Just comment it out... * Apply suggestions from code review Co-authored-by: Matti Picus <matti.picus@gmail.com> Co-authored-by: mattip <matti.picus@gmail.com>
* | | MAINT: Rewrite can-cast logic in terms of NEP 42Sebastian Berg2020-11-241-0/+15
| | |
* | | BUG: ensure _UFuncNoLoopError can be pickled (#17377)bernie gray2020-11-181-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | * BUG: ensure _UFuncNoLoopError can be pickled; closes #16490 * update quickstart.rst * add round trip pickle test * move _ArrayMemoryError picking test
* | | 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
| |
* | DOC: Modify Templates (#17691)Takanori H2020-11-044-5/+16
| | | | | | * DOC: Modify Templates
* | Add info on transopose to absolute beginners tutorial (#17703)prateek arora2020-11-031-4/+11
| | | | | | | | | | | | Adds a blurb about the transpose property of ndarray and updates formatting of some rst inline literals. Co-authored-by: Ross Barnowski <rossbar@berkeley.edu>
* | REL: Update master after 1.19.4 release.Charles Harris2020-11-023-2/+33
| |
* | REL: Update master after 1.19.3 release.Charles Harris2020-10-282-0/+47
| | | | | | | | | | | | - Forward port 1.19.3-notes.rst - Forward port 1.19.3-changelog.rst - Update release.rst
* | 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-266-12/+13
|/
* 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>
* Update doc/source/user/basics.rec.rstTakanori H2020-10-241-1/+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-2412-30/+35
|
* 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
| |