ravel

Contents

ravel#

class brainunit.math.ravel(a, order='C', **kwargs)#

Return a contiguous flattened quantity or array.

Parameters:

  • a (Array | saiunit.Quantity) – Input array. The elements in a are read in the order specified by order, and packed as a 1-D array.

  • order (str) – The elements of a are read using this index order. ‘C’ means to index the elements in row-major, C-style order, with the last axis index changing fastest, back to the first axis index changing slowest. ‘F’ means to index the elements in column-major, Fortran-style order, with the first index changing fastest, and the last index changing slowest. ‘A’ means to read the elements in Fortran-like index order if a is Fortran contiguous in memory, C-like order otherwise. ‘K’ means to read the elements in the order they occur in memory, except for reversing the data when strides are negative. By default, ‘C’ index order is used.

Returns:

res – The flattened quantity or array. The shape of the output is the same as a, but the array is 1-D.

Return type:

Array | saiunit.Quantity

Examples

>>> import saiunit as u
>>> a = [[1, 2], [3, 4]] * u.meter
>>> u.math.ravel(a)
Contents