summaryrefslogtreecommitdiff
path: root/numpy/add_newdocs.py
Commit message (Collapse)AuthorAgeFilesLines
...
* Document empty(..., object) initialization to None.Antony Lee2015-09-261-2/+2
| | | | | | Behavior goes back at least to 1.6.2. Fixes #6367.
* DOC: Document Datetime, Timedelta dtype kindsHassan Kibirige2015-09-081-1/+3
|
* DOC: update docs + release notes vs shares_memoryPauli Virtanen2015-08-291-3/+2
|
* ENH: add shares_memory, implement may_share_memory using itPauli Virtanen2015-08-291-7/+24
|
* Doc : fixed paramter typoSamuel St-Jean2015-08-181-1/+1
|
* DOC: Fix docstring warnings in documetation generation.Charles Harris2015-07-011-5/+9
| | | | | | | | | | | | Most of these fixes involve putting blank lines around .. versionadded:: x.x.x and .. deprecated:: x.x.x Some of the examples were also fixed.
* DOC: Remove references to removed setasflat ndarray method.Charles Harris2015-07-011-31/+0
|
* DOC: Update docs.Gabor Kovacs2015-06-211-13/+14
| | | | | | | Update docs for boolean array indexing and nonzero order. Add links to row-major and column-major terms where they appear. Closes #3177
* DOC: Document '@' and matmul.Charles Harris2015-06-041-1/+126
| | | | | Document the matmul function and add '@' to the operator section of the reference manual.
* DOC: Better document 'order' argument of 'sort' and friendsJaime Fernandez2015-05-301-6/+10
| | | | Closes #5927
* Merge pull request #5605 from shoyer/stackCharles Harris2015-05-121-1/+2
|\ | | | | ENH: add np.stack
| * ENH: add np.stackStephan Hoyer2015-05-111-1/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The motivation here is to present a uniform and N-dimensional interface for joining arrays along a new axis, similarly to how `concatenate` provides a uniform and N-dimensional interface for joining arrays along an existing axis. Background ~~~~~~~~~~ Currently, users can choose between `hstack`, `vstack`, `column_stack` and `dstack`, but none of these functions handle N-dimensional input. In my opinion, it's also difficult to keep track of the differences between these methods and to predict how they will handle input with different dimensions. In the past, my preferred approach has been to either construct the result array explicitly and use indexing for assignment, to or use `np.array` to stack along the first dimension and then use `transpose` (or a similar method) to reorder dimensions if necessary. This is pretty awkward. I brought this proposal up a few weeks on the numpy-discussion list: http://mail.scipy.org/pipermail/numpy-discussion/2015-February/072199.html I also received positive feedback on Twitter: https://twitter.com/shoyer/status/565937244599377920 Implementation notes ~~~~~~~~~~~~~~~~~~~~ The one line summaries for `concatenate` and `stack` have been (re)written to mirror each other, and to make clear that the distinction between these functions is whether they join over an existing or new axis. In general, I've tweaked the documentation and docstrings with an eye toward pointing users to `concatenate`/`stack`/`split` as a fundamental set of basic array manipulation routines, and away from `array_split`/`{h,v,d}split`/`{h,v,d,column_}stack` I put this implementation in `numpy.core.shape_base` alongside `hstack`/`vstack`, but it appears that there is also a `numpy.lib.shape_base` module that contains another larger set of functions, including `dstack`. I'm not really sure where this belongs (or if it even matters). Finally, it might be a good idea to write a masked array version of `stack`. But I don't use masked arrays, so I'm not well motivated to do that.
* | ENH sync ndarray methods doc/args with numpy function doc/argsAllan Haldane2015-04-021-10/+11
|/ | | | | | | | | | Modified the docstrings to all, any, sum, prod, mean, var, std, min, max to add keepdims argument. Added 'out' keyword parameter to numpy.argmin, numpy.argmax, to mirror ndarray methods. Updated ndarray.clip docstring to give correct parameter description.
* Merge pull request #5307 from hunse/array-docstringCharles Harris2015-01-261-7/+7
|\ | | | | Array docstring now lists correct order default
| * DOC: array docstring lists correct order defaultEric Hunsberger2014-11-201-7/+7
| | | | | | | | Fixes #5306
* | DOC: Fixing help documentation error in numpy.zeros. Fixes #5497 [skip ci]abdulmuneer2015-01-241-1/+1
| |
* | Merge pull request #5476 from juliantaylor/merge-cbaseJaime2015-01-231-9/+9
|\ \ | | | | | | merge _compiled_base module into multiarray
| * | MAINT: merge _compiled_base module into multiarrayJulian Taylor2015-01-221-9/+9
| | | | | | | | | | | | Allows access to internal functions for the file.
* | | DOC: improve record/structured array nomenclature & guideAllan Haldane2015-01-221-4/+5
|/ / | | | | | | | | | | | | | | | | | | | | This update adds a section better describing record arrays in the user guide (numpy/doc/structured_arrays.py). It also corrects nomenclature, such that "structured array" refers to ndarrays with structured dtype, "record array" refers to modified ndarrays as created by np.rec.array, and "recarray" refers to ndarrays viewed as np.recarray. See the note at the end of the structured array user guide.
* | DOC: Added a note about writeability of views from np.einsum toIan Henriksen2015-01-011-0/+16
|/ | | | | the corresponding docstring. Also added an example showing how to write to the diagonal of an array.
* DOC: reorganize `digitize` docstringjaimefrio2014-09-251-1/+2
|
* DOC: document improvements to `np.digitize`jaimefrio2014-09-251-0/+7
|
* ENH: implement `digitize` with `PyArray_SearchSorted`jaimefrio2014-09-251-5/+5
|
* Merge pull request #5107 from juliantaylor/na-docCharles Harris2014-09-231-9/+1
|\ | | | | DOC: remove preservena reference from docstrings
| * DOC: remove preservena reference from docstringsJulian Taylor2014-09-231-9/+1
| | | | | | | | | | | | | | preservena is not not implemented. the putmask docstring is misleading, currently copyto is faster for dense or sparse masks while putmask is faster for random masks. [ci skip]
* | DOC: Update docs to reflect deprecation of alterdot and restoredot.Charles Harris2014-09-041-37/+0
| | | | | | | | | | Also move docstrings into the versions in numpy/core/numeric.py as the functions are no longer in the defunct _dotblas module.
* | DOC: add version added tag to reduction keepdims argumentJulian Taylor2014-07-271-0/+2
| |
* | DOC: fix documented return value of tostring/tobytesJulian Taylor2014-07-271-10/+12
|/ | | | The function returns bytes not strings. This is relevant in python3.
* explain character codes of dtype.kindHans Meine2014-03-151-1/+13
| | | | "one of 'biufcSUV'" is not very helpful if it stands alone, also the 'O' typecode was missing.
* DOC: remove mention of quickselect in argpartition docsJulian Taylor2014-03-011-1/+1
| | | | the default algorithm is introselect
* DOC: Document ldexp and frexp.Charles Harris2014-02-281-77/+0
| | | | | | | | | The documentation needs to be in umathmodule.c as that is where ldexp and frexp and defined. I moved the current documention from add_newdocs.py to ufunc_docstrings.py, manually translated them into C strings, and inserted them into umathmodule.c. Closes #2354.
* BUG: Fix promote_types, can_cast, as astype issuesJay Bourque2014-02-251-5/+23
| | | | | | - promote_types does not return correct string size for integer and string arguments. Fix so that integer and string types are promoted to string type that is long enough to hold integer type safely cast to string. - can_cast incorrectly returns True for certain integer and string types. Fix so that can_cast only returns True if string type is long enough to hold integer type safely cast to string. - calling astype to convert integer to string should fail if string type is not long enough to hold integer converted to string and casting argument is set to "safe".
* ENH: add tobytes and stop using tostring in documentationJulian Taylor2014-02-111-8/+17
| | | | | | | tostring returns bytes which are not equal to string, so provide a tobytes function alias. tostring does not emit a deprecation warning yet so rdepends do not need to check two names to support older versions of numpy without warnings.
* DOC: fix error in reduceat documentationPauli Virtanen2014-01-281-5/+6
| | | | reduceat does not allow out-of-bounds indices currently
* DOC: add versionadded:: 1.8.0 to ufunc.at docstringJulian Taylor2014-01-221-0/+2
|
* ENH: Remove unnecessary broadcasting notation restrictions in einsum.hpaulj2014-01-101-0/+14
| | | | | | | | | | | | | In a case where 'ik,kj->ij' works, einsum would raise an error for 'ik,k...->i...' because the 'ik' did not have ellipsis In einsum.c.src prepare_op_axes() pass all 'broadcast' cases through the 'RIGHT' case (interation from the end). Since the BROADCAST variable is not longer needed, all instances of it have been removed from einsum.c.src test_einsum.py - adds a test_einsum_broadcast case.
* DOC: adding 'Returns' section to `empty` functionCJ Carey2013-09-251-0/+6
| | | This matches the format of related functions like `empty_like` and `zeros`.
* DOC: add isclose and partition to reference and link some docsJulian Taylor2013-09-141-0/+2
| | | | also drop sometrue/alltrue link, its equivalent to any/all.
* ENH: Make the ndarray diagonal method return a view.Charles Harris2013-08-221-1/+3
| | | | | | | Also remove the test_diagonal_deprecation test and add test that checks that a view is returned and that it is not writeable. Closes #596.
* STY: Giant comma spacing fixup.Charles Harris2013-08-181-5/+5
| | | | | | | Run the 2to3 ws_comma fixer on *.py files. Some lines are now too long and will need to be broken at some point. OTOH, some lines were already too long and need to be broken at some point. Now seems as good a time as any to do this with open PRs at a minimum.
* STY: Giant whitespace cleanup.Charles Harris2013-08-181-1/+1
| | | | Now is as good a time as any with open PR's at a low.
* Update docsJay Bourque2013-08-161-3/+3
|
* Update docsJay Bourque2013-08-161-0/+3
|
* Update docsJay Bourque2013-08-161-18/+24
|
* Reword some comments/documentationJay Bourque2013-08-161-5/+8
|
* Update documentation for 'at' methodJay Bourque2013-08-161-0/+41
|
* ENH: add quickselect algorithm and expose it via partitionJulian Taylor2013-08-121-0/+69
| | | | | | | | | | | | | | | | | | | | | | | | A partition sorts the kth element into its sorted order and moves all smaller elements before the kth element and all equal or greater elements behind it. The ordering of all elements in the partitions is undefined. It is implemented via the introselection algorithm which has worst case linear complexity compared to a full sort that has linearithmic complexity. The introselect algorithm uses a quickselect with median of three pivot and falls back to a quickselect with median of median of five pivot if no sufficient progress is made. The pivots used during the search for the wanted kth element can optionally be stored and reused for further partitionings of the array. This is used by the python interface if an array of kth is provided to the partitions function. This improves the performance of median and which need to select two elements if the size of the array is even. A percentile function interpolating between values also profits from this. String selection is implemented in terms of quicksort which has the same properties as a selection for now.
* ENH: implement may_share_memory in CJulian Taylor2013-05-281-0/+26
| | | | | | | | | memmap needs to call it in __array_finalize__ to determine if it can drop the references on copies. The python version if may_share_memory caused significant slowdowns when slicing these maps. closes gh-3364
* DOC: Add NPY_RELAXED_STRIDES_DOCUMENTATION doc to ndarry.flagsSebastian Berg2013-04-111-2/+11
|
* 2to3: Apply `print` fixer.Charles Harris2013-04-061-1/+1
| | | | | | | Add `print_function` to all `from __future__ import ...` statements and use the python3 print function syntax everywhere. Closes #3078.
View Lorry Controller Status