papyri
{ } Raw JSON

bundles / numpy 2.4.4 / numpy / rec / recarray

class

numpy.rec:recarray

source: /numpy/rec/__init__.py

Signature

class   recarray ( shape ,  dtype = None ,  buf = None ,  offset = 0 ,  strides = None ,  formats = None ,  names = None ,  titles = None ,  byteorder = None ,  aligned = False ,  order = C )

Summary

Construct an ndarray that allows field access using attributes.

Extended Summary

Arrays may have a data-types containing fields, analogous to columns in a spread sheet. An example is [(x, int), (y, float)], where each entry in the array is a pair of (int, float). Normally, these attributes are accessed using dictionary lookups such as arr['x'] and arr['y']. Record arrays allow the fields to be accessed as members of the array, using arr.x and arr.y.

Parameters

shape : tuple

Shape of output array.

dtype : data-type, optional

The desired data-type. By default, the data-type is determined from formats, names, titles, aligned and byteorder.

formats : list of data-types, optional

A list containing the data-types for the different columns, e.g. ['i4', 'f8', 'i4']. formats does not support the new convention of using types directly, i.e. (int, float, int). Note that formats must be a list, not a tuple. Given that formats is somewhat limited, we recommend specifying dtype instead.

names : tuple of str, optional

The name of each column, e.g. ('x', 'y', 'z').

buf : buffer, optional

By default, a new array is created of the given shape and data-type. If buf is specified and is an object exposing the buffer interface, the array will use the memory from the existing buffer. In this case, the offset and strides keywords are available.

Returns

rec : recarray

Empty array of the given shape and type.

Other Parameters

titles : tuple of str, optional

Aliases for column names. For example, if names were ('x', 'y', 'z') and titles is ('x_coordinate', 'y_coordinate', 'z_coordinate'), then arr['x'] is equivalent to both arr.x and arr.x_coordinate.

byteorder : {'<', '>', '='}, optional

Byte-order for all fields.

aligned : bool, optional

Align the fields in memory as the C-compiler would.

strides : tuple of ints, optional

Buffer (buf) is interpreted according to these strides (strides define how many bytes each array element, row, column, etc. occupy in memory).

offset : int, optional

Start reading buffer (buf) from this offset onwards.

order : {'C', 'F'}, optional

Row-major (C-style) or column-major (Fortran-style) order.

Notes

This constructor can be compared to empty: it creates a new record array but does not fill it with data. To create a record array from data, use one of the following methods:

  • Create a standard ndarray and convert it to a record array, using arr.view(np.recarray)

  • Use the buf keyword.

  • Use np.rec.fromrecords.

Examples

Create an array with two fields, ``x`` and ``y``: 
import numpy as np
x = np.array([(1.0, 2), (3.0, 4)], dtype=[('x', '<f8'), ('y', '<i8')])
x
✓
x['x']
✓
View the array as a record array: 
x = x.view(np.recarray)
✓
x.x
✓
x.y
✓
Create a new, empty record array:

See also

numpy.rec.format_parser

determine data-type from formats, names, titles.

numpy.rec.fromrecords

Construct a record array from data.

numpy.record

fundamental data-type for recarray.

Aliases

  • numpy.recarray

Referenced by

This package

Other packages