NumPy: ¿Qué es una matriz estructurada de NumPy y cómo trabajar con ellas en Python?

Publicado el 03 agosto 2021 por Daniel Rodríguez @analyticslane

A la hora de crear una matriz de NumPy es posible definir el tipo de dato mediante la propiedad dtype, evitando de esta forma que este sea deducido a partir de los datos. Aunque inicialmente se pueda pensar en el uso de los tipos primitivos: enteros, reales o cadenas de texto, también es posible emplear estructuras definidas por el usuario. Creando en este último caso lo que se llama una matriz estructurada de NumPy. Siendo estos unos elementos que ofrecen ciertas ventajas. Debido a que las matrices de NumPy son homogéneas, esto es, únicamente pueden contener datos de un mismo tipo, su uso garantiza que los datos sean siempre válidos.

La matriz estructurada de NumPy

Una matriz estructurada de NumPy es un objeto compuesto por estructuras (similares a los datos struct que existen en C y otros lenguajes) que representan un tipo de dato compuesto. Asegurando de este modo que cada uno de los elementos del objeto contienen los mismos datos. Evitando así que se puedan agregar al vector datos que no son correctos.

Antes de crear una matriz estructurada en NumPy es necesario definir la estructura. Lo que requiere crear una lista de tuplas en las que el primer valor es el nombre del campo y el segundo el tipo de dato. Una vez hecho esto se puede crear una matriz de NumPy de forma habitual con np.array(). Solamente se ha de tener en cuenta que cada uno de los elementos del array han de ajustarse a la estructura definida, ya que en caso contrario se produciría un error. De este modo se puede crear una primera matriz estructurada con el siguiente código.

import numpy as np

struct = [
    ('first_name', (np.str_, 10)),
    ('last_name', (np.str_, 12)),
    ('age', np.int32),
    ('score', np.float64)]

arr = np.array([('Montgomery', 'Humes', 27, 0.45),
                ('Dagmar', 'Elstow', 41, 1),
                ('Reeba', 'Wattisham', 29, 0.77)],
               dtype=struct)

arr
array([('Montgomery', 'Humes', 27, 0.45), ('Dagmar', 'Elstow', 41, 1.  ),
       ('Reeba', 'Wattisham', 29, 0.77)],
       dtype=[('first_name', '<U10'), ('last_name', '<U12'), ('age', '<i4'), ('score', '<f8')])

En este caso se ha indicado una estructura con cuatro valores: el nombre como una cadena texto de longitud 10, el apellido como una cadena de texto de longitud 12, la edad como un valor entero y el score como un valor real. Tipo de dato que se puede apreciar al imprimir el array.

Validación de los tipos de dato

A la hora de crear un elemento NumPy validará cada uno de los campos y, en caso de no cumplir lo transformara si es posible. Algo que se puede apreciar en el siguiente ejemplo.

np.array([(12, 'Keningham, Broddy', '21', '0.66')], dtype=struct)
array([('12', 'Keningham, B', 21, 0.66)],
       dtype=[('first_name', '<U10'), ('last_name', '<U12'), ('age', '<i4'), ('score', '<f8')])

Nótese que en el ejemplo ninguno de los campos cumplen las condiciones establecidas. El primer campo, el nombre, es un valor entero que es convertido a una cadena de texto. En el caso del apellido, el segundo campo, su longitud es de más de 12 caracteres, por lo que al crear la matriz NumPy ha truncado está hasta el máximo permitido. Finalmente, en el caso de los valores numéricos, la edad y el score, los datos son texto, aunque en este caso es posible convertirlos al tipo correcto. En el caso de que no fuese posible la conversión, se produciría un error como en el siguiente caso.

np.array([('Broddy', 'Keningham', '21', 'None')], dtype=struct)
ValueError: could not convert string to float: 'None'

Agregar elementos a una matriz estructurada

Para agregar nuevos elementos a una matriz estructurada se puede recurrir a la función np.append(), como en el resto de los casos. La única peculiaridad es que ambas matrices han de ser del mismo tipo, ya que la función no realizará la conversión. Lo que se puede ver en el siguiente ejemplo donde los tipos son correctos, pero Python devuelve un error.

arr = np.append(arr, [('Dagmar', 'Keningham', 21, 0.66),
                      ('Dagmar', 'Brechin', 53, 0.75)])
TypeError: invalid type promotion

Siendo necesario, antes de agregar los elementos, crear matriz estructurada. Ya que NumPy no realizará la conversión de los tipos. Lo que se puede hacer tal como se muestra a continuación

arr = np.append(arr, np.array([('Dagmar', 'Keningham', 21, 0.66),
                               ('Dagmar', 'Brechin', 53, 0.75)],
                              dtype=struct))

Ordenar elementos en las matrices estructuradas

En el caso de ser necesario ordenar los elementos de una matriz estructurada se puede recurrir a la función np.sort(). Dado que los datos no son primitivos, es necesario indicar a la función mediante qué valor se deben ordenar estos. Lo que se puede hacer a través de la propiedad order. Así, para ordenar la matriz en base al nombre solamente hay que escribir.

np.sort(arr, order='first_name')
array([('Dagmar', 'Brechin', 53, 0.75), ('Dagmar', 'Elstow', 41, 1.  ),
       ('Dagmar', 'Keningham', 21, 0.66),
       ('Montgomery', 'Humes', 27, 0.45),
       ('Reeba', 'Wattisham', 29, 0.77)],
      dtype=[('first_name', '<U10'), ('last_name', '<U12'), ('age', '<i4'), ('score', '<f8')])

También se puede ordenar en base a más de una propiedad, para lo que solamente se tiene que pasar una lista con el nombre de las propiedades. En el ejemplo, esto se puede ver al ordenar por nombre, donde hay tres registros con el mismo valor, por lo que se puede usar como segundo valor la edad.

np.sort(arr, order=['first_name', 'age'])
array([('Dagmar', 'Keningham', 21, 0.66), ('Dagmar', 'Elstow', 41, 1.  ),
       ('Dagmar', 'Brechin', 53, 0.75), ('Montgomery', 'Humes', 27, 0.45),
       ('Reeba', 'Wattisham', 29, 0.77)],
      dtype=[('first_name', '<U10'), ('last_name', '<U12'), ('age', '<i4'), ('score', '<f8')])

Conclusiones

En esta entrada se ha visto como se puede crear un tipo de dato en Python para crear una matriz estructurada de NumPy. Un tipo de objeto que ofrece ciertas ventajas cuando necesitamos que los datos con los que trabajamos cumplan unas especificaciones dadas. Evitando de esta forma posibles errores.