Validación de argumentos en Matlab

Hasta hace poco no existía en Matlab una forma automatizada para comprobar que los parámetros de una función son los correctos. La única manera de hacer esto era mediante la inclusión de código con comprobaciones específicas para ello, como puede ser el tipo de dato, las dimensiones de la matriz o los valores. Tampoco existía una manera de definir un valor por defecto para los parámetros. Esto cambió con la versión 2019b donde se introdujo el entorno arguments para configurar estas tareas. Dentro de este entorno se puede saber cuáles son los tipos de datos válidos, el tamaño de las matrices, validar los valores y asignar un valor por defecto. Todo esto facilita la validación de argumentos en Matlab, permitiendo esto se puede hacer definiendo los tipos de datos como en otros lenguajes.

Uso de arguments en una función de Matlab

A partir de la versión 2019b en el cuerpo de las funciones de Matlab se puede incluir un nuevo bloque usando la palabra reservada arguments. Al igual que el resto de los bloques, este finalizará al encontrarse con el primer end.

La sintaxis del bloque arguments es algo diferente a los utilizados habitualmente. En este bloque se debe incluir en cada línea el nombre de los parámetros de la función seguido del tipo de dato. Además, opcionalmente se puede incluir las dimensiones permitidas para la entrada (antes de la definición del tipo), un conjunto de validadores (entre corchetes depuesto del tipo de dato) y el valor por defecto al final de la línea. Siendo la sintaxis básica la siguiente.

En Analytics Lane

Nuevo simulador FIRE en el laboratorio de aplicaciones de Analytics Lane

arguments
    par1 (dimensions) dataType {validators} = defaultValue
    ...
    parN
end

Ejemplo de validación de argumentos en Matlab

Posiblemente la mejor forma para comprender cómo es la validación de argumentos en Matlab con arguments sea estudiando un ejemplo. Uno como la siguiente función.

function [out, par3] = testFunction(par1, par2, par3)

arguments
    par1 (1, 1) double {mustBeNonnegative}
    par2 (1, 2) double
    par3 string = 'No value'
end

out = par1 .* par2;

fprintf('La clase de %i es %s\n', par1, class(par1));
fprintf('La clase de (%d, %d) es %s\n', par2, class(par2));
fprintf('La clase de "%s" es %s\n', par3, class(par3));

end

En este código se ha definido una función testFunction() que únicamente multiplica los dos primeros parámetros. El primero, ‘par1’ es necesariamente un escalar real positivo, mientras que el segundo es un vector de 1 por 2 también real. Adicionalmente la función también puede recibir un tercer parámetro que solamente puede ser una cadena de texto y tiene como valor por defecto 'No value'.

Ahora si los valores son correctos, la función trabaja correctamente tal cómo se muestra a continuación.

>> [out, par3] = testFunction(3, [1, 2])
La clase de 3 es double
La clase de (1, 2) es double
La clase de "No value" es string

out =

     3     6


par3 = 

    "No value"

En donde se puede ver que el segundo parámetro devuelve la cadena por defecto.

Pero, en el caso de que no sean correctos se producirá se producirá un fallo al llamarla. Por ejemplo, si el primer parámetro es negativo.

>> [out, par3] = testFunction(-3, [1, 2])
Error using testFunction
Invalid argument at position 1. Value must be nonnegative.

Este error se produce porque mediante la opción {mustBeNonnegative} obliga a que este parámetro sea solamente positivo. Lo que no sucede en el ejemplo anterior. Existen diferentes tipos de validadores que se pueden ver en la documentación

Otra posible causa de fallo sería pasar como segundo parámetro vector que no sea de 1 por 2.

>> [out, par3] = testFunction(3, [1, 2, 3])
Error using testFunction
Invalid argument at position 2. Value must be a vector with 2 elements.

Conclusiones

La validación de los argumentos en las funciones de Matlab era algo bastante tedioso debido a que no existía una opción para su configuración. Afortunadamente con la introducción de arguments en la versión 2019b esto se ha vuelto mucho más fácil debido a que ahora es simplemente una opción, como sucede en otros lenguajes.

Imagen de ThePixelman en Pixabay