From f31f12afa6fcbc852dfc57b34dd701d7b4145203 Mon Sep 17 00:00:00 2001 From: Neal C Date: Tue, 14 Jul 2020 00:44:56 -0700 Subject: 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 --- numpy/core/_asarray.py | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) (limited to 'numpy/core/_asarray.py') diff --git a/numpy/core/_asarray.py b/numpy/core/_asarray.py index df569f22d..1b06c328f 100644 --- a/numpy/core/_asarray.py +++ b/numpy/core/_asarray.py @@ -23,9 +23,12 @@ def asarray(a, dtype=None, order=None): of lists and ndarrays. 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. + 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 @@ -95,9 +98,13 @@ def asanyarray(a, dtype=None, order=None): tuples of lists, and ndarrays. 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 ------- -- cgit v1.2.1