diff options
| author | Neal C <nealchau@gmail.com> | 2020-07-14 00:44:56 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-07-14 10:44:56 +0300 |
| commit | f31f12afa6fcbc852dfc57b34dd701d7b4145203 (patch) | |
| tree | 81bd2558ad7b91c2af5dfb219ed74247f3f534ae /numpy/lib/function_base.py | |
| parent | 197093bd7a455ce285b2415e45039cab83544269 (diff) | |
| download | numpy-f31f12afa6fcbc852dfc57b34dd701d7b4145203.tar.gz | |
DOC: Add explanation of 'K' and 'A' layout options to 'asarray*' functions (#16811)
* DOC: update parameter choices for asarray, asarray_contiguous, asarray_chkfinite converters
Co-authored-by: sun <sun@vosdbt.org>
Diffstat (limited to 'numpy/lib/function_base.py')
| -rw-r--r-- | numpy/lib/function_base.py | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/numpy/lib/function_base.py b/numpy/lib/function_base.py index 42ea8c7a7..6ea9cc4de 100644 --- a/numpy/lib/function_base.py +++ b/numpy/lib/function_base.py @@ -431,10 +431,13 @@ def asarray_chkfinite(a, dtype=None, order=None): of lists and ndarrays. Success requires no NaNs or Infs. dtype : data-type, optional By default, the data-type is inferred from the input data. - order : {'C', 'F'}, optional - Whether to use row-major (C-style) or - column-major (Fortran-style) memory representation. - Defaults to 'C'. + order : {'C', 'F', 'A', 'K'}, optional + Memory layout. 'A' and 'K' depend on the order of input array a. + 'C' row-major (C-style), + 'F' column-major (Fortran-style) memory representation. + 'A' (any) means 'F' if `a` is Fortran contiguous, 'C' otherwise + 'K' (keep) preserve input order + Defaults to 'C'. Returns ------- |