You are viewing an older version (2.4.3). Go to latest (2.4.4)
{ } Raw JSON

bundles / numpy 2.4.3 / numpy / asfortranarray

built-in

numpy:asfortranarray

Signature

built-in asfortranarray ( a dtype = None * like = None )

Summary

Return an array (ndim >= 1) laid out in Fortran order in memory.

Parameters

a : array_like

Input array.

dtype : str or dtype object, optional

By default, the data-type is inferred from the input data.

like : array_like, optional

Reference object to allow the creation of arrays which are not NumPy arrays. If an array-like passed in as like supports the __array_function__ protocol, the result will be defined by it. In this case, it ensures the creation of an array object compatible with that passed in via this argument.

Returns

out : ndarray

The input a in Fortran, or column-major, order.

Examples

Starting with a C-contiguous array:
import numpy as np
x = np.ones((2, 3), order='C')
x.flags['C_CONTIGUOUS']
Calling ``asfortranarray`` makes a Fortran-contiguous copy:
y = np.asfortranarray(x)
y.flags['F_CONTIGUOUS']
np.may_share_memory(x, y)
Now, starting with a Fortran-contiguous array:
x = np.ones((2, 3), order='F')
x.flags['F_CONTIGUOUS']
Then, calling ``asfortranarray`` returns the same object:
y = np.asfortranarray(x)
x is y
Note: This function returns an array with at least one-dimension (1-d) so it will not preserve 0-d arrays.

See also

asanyarray

Convert input to an ndarray with either row or column-major memory order.

ascontiguousarray

Convert input to a contiguous (C order) array.

ndarray.flags

Information about the memory layout of the array.

require

Return an ndarray that satisfies requirements.

Aliases

  • numpy.asfortranarray

Referenced by