Définitions d’arguments

Accepter un nombre variable d’entrées ou de sorties et vérifier la validité des valeurs

La plupart des fonctions ne nécessitent pas de déclaration ni de validation d’argument car MATLAB^® est un langage non typé. Cependant, si votre fonction est largement utilisée et que vous avez besoin de vérifier le type, la taille ou d’autres aspects des entrées pour vous assurer que votre code fonctionne comme prévu, vous pouvez définir un bloc 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

Fonctions

développer tout

Déclarer et valider des arguments

Bloc arguments

arguments Declare function argument validation

Validation des valeurs numériques

`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 (depuis R2023b)
`mustBeReal`	Validate that value is real
`mustBeInteger`	Validate that value is integer
`mustBeNonmissing`	Validate that input does not contain missing values

Comparaisons

`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

Types de données

`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

Taille

`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 (depuis R2024b)
`mustBeColumn`	Validate that value is column vector (depuis R2024b)
`mustBeMatrix`	Validate that value is matrix (depuis R2024b)

Plage de valeurs et appartenance à un ensemble

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

Noms

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

Structure d’arguments nom-valeur

namedargs2cell Convert structure containing name-value pairs to cell array

Listes d’arguments de longueur variable

Entrées

`varargin`	Variable-length input argument list
`nargin`	Number of function input arguments
`narginchk`	Validate number of input arguments

Sorties

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

Vérifications supplémentaires

`validateattributes`	Check validity of array
`validatestring`	Check validity of text
`validatecolor`	Validate color values
`inputname`	Variable name of function input
`mfilename`	Filename of currently running code
`inputParser`	Input parser for functions

Rubriques

Validation des arguments

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

Nombre d’arguments

Support Variable Number of Inputs
Define a function that accepts a variable number of input arguments using varargin. The varargin argument is a cell array that contains the function inputs, where each input is in its own cell.
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.
Find Number of Function Arguments

Use nargin and nargout to determine how many input or output arguments your function receives.
- Validate Number of Function Arguments
- Checking Number of Arguments in Nested Functions

Ignorer des entrées

Ignore Inputs in Function Definitions
If your function accepts a predefined set of inputs, but does not use all the inputs, use the tilde (~) operator to ignore them in your function definition.