Definiciones de argumentos

Acepte un número variable de entradas y salidas, y compruebe los valores válidos

La mayoría de las funciones no requieren declaraciones o validación del argumento porque MATLAB^® es un lenguaje sin tipificar. Sin embargo, si la función tiene un uso amplio y necesita verificar el tipo, el tamaño u otros aspectos de las entradas para garantizar que el código funciona según lo previsto, puede definir un bloque de arguments.

function z = mySharedFunction(x,y,NameValueArgs)
   arguments
      x (1,1) double     % scalar
      y double {mustBeVector,mustBePositive} 
      NameValueArgs.A string
      NameValueArgs.B string = "default"
   end 
...
end

Funciones

expandir todo

Declarar y validar argumentos

Bloque de argumentos

arguments Declare function argument validation

Validación de valores numéricos

`mustBePositive`	Validate that value is positive
`mustBeNonpositive`	Validate that value is nonpositive
`mustBeNonnegative`	Validate that value is nonnegative
`mustBeNegative`	Validate that value is negative
`mustBeFinite`	Validate that value is finite
`mustBeNonNan`	Validate that input contains `NaN`
`mustBeNonzero`	Validate that value is nonzero
`mustBeNonsparse`	Validate that value is nonsparse
`mustBeSparse`	Validate that value is sparse (Desde R2023b)
`mustBeReal`	Validate that value is real
`mustBeInteger`	Validate that value is integer
`mustBeNonmissing`	Validate that input does not contain missing values

Comparaciones

`mustBeGreaterThan`	Validate that value is greater than another value
`mustBeLessThan`	Validate that value is less than another value
`mustBeGreaterThanOrEqual`	Validate that value is greater than or equal to another value
`mustBeLessThanOrEqual`	Validate that value is less than or equal to another value

Tipos de datos

`mustBeA`	Validate that value comes from one of specified classes
`mustBeNumeric`	Validate that value is numeric
`mustBeNumericOrLogical`	Validate that value is numeric or logical
`mustBeFloat`	Validate that value is floating-point array
`mustBeText`	Validate that value is string array, character vector, or cell array of character vectors
`mustBeTextScalar`	Validate that value is single piece of text
`mustBeNonzeroLengthText`	Validate that value is text with nonzero length
`mustBeUnderlyingType`	Validate that value has specified underlying type

Tamaño

`mustBeNonempty`	Validate that value is nonempty
`mustBeScalarOrEmpty`	Validate that value is scalar or empty
`mustBeVector`	Validate that value is vector
`mustBeRow`	Validate that value is row vector (Desde R2024b)
`mustBeColumn`	Validate that value is column vector (Desde R2024b)
`mustBeMatrix`	Validate that value is matrix (Desde R2024b)

Pertenencia de intervalos y conjuntos

`mustBeBetween`	Validate that all elements are within specified range (Desde R2025a)
`mustBeInRange`	Validate that value is in the specified range
`mustBeMember`	Validate that value is member of specified set

Nombres

`mustBeFile`	Validate that path refers to file
`mustBeFolder`	Validate that input path refers to folder
`mustBeValidVariableName`	Validate that input name is valid variable name

Estructura de argumentos nombre-valor

namedargs2cell Convert structure containing name-value pairs to cell array

Listas de argumentos variable-longitud

Entradas

`varargin`	Lista de argumentos de entrada de longitud variable
`nargin`	Número de argumentos de entrada de una función
`narginchk`	Validate number of input arguments

Salidas

`varargout`	Variable-length output argument list
`nargout`	Number of function output arguments
`nargoutchk`	Validate number of output arguments

Comprobaciones adicionales

`validateattributes`	Check validity of array
`validatestring`	Check validity of text
`validatecolor`	Validate color values
`inputname`	Variable name of function input
`mfilename`	Nombre de archivo del código que se está ejecutando actualmente
`inputParser`	Input parser for functions

Temas

Validación de argumentos

Function Argument Validation

Declare argument class and size, and enforce restrictions on argument values.
Argument Validation Functions

Validate specific requirements of arguments using validation functions. Write your own functions to check for specific argument requirements.
- Use Validation Functions to Avoid Unwanted Class and Size Conversions
- Use nargin Functions During Argument Validation
Check Function Inputs with validateattributes
This example shows how to verify that the inputs to your function conform to a set of requirements using the validateattributes function.
Parse Function Inputs

Define required and optional inputs, assign defaults to optional inputs, and validate all inputs to a custom function using the Input Parser.
- Input Parser Validation Functions

Número de argumentos

Admitir un número variable de entradas
Defina una función que acepte un número variable de argumentos de entrada con varargin. El argumento varargin es un arreglo de celdas que contiene entradas de función, donde cada entrada está en su propia celda.
Support Variable Number of Outputs
Define a function that returns a variable number of output arguments using varargout. Output varargout is a cell array that contains the function outputs, where each output is in its own cell.
Buscar el número de argumentos de funciones

Utilice nargin y nargout para determinar cuántos argumentos de entrada o de salida recibe la función.
- Validate Number of Function Arguments
- Checking Number of Arguments in Nested Functions

Ignorar entradas

Ignorar entradas en definiciones de funciones
Si la función acepta un conjunto predefinido de entradas, pero no utiliza todas las entradas, utilice el operador de tilde (~) para ignorarlas en la definición de función.