Argument Definitions

Accept a variable number of inputs or outputs, check for valid values

Since MATLAB^® is an untyped language, most functions do not require argument declarations or validation. However, if your function has wide usage and you need to verify the type, size, or other aspects of inputs to ensure that your code works as expected, you can define an arguments block (since R2019b). For details, see Function Argument Validation.

Additionally, you can check how many inputs or outputs your function receives, the names of input variables, and more.

Functions

expand all

Declare and Validate Arguments

Arguments Block

arguments Declare function argument validation

Numeric Value Validation

`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 value is not NaN
`mustBeNonzero`	Validate that value is nonzero
`mustBeNonsparse`	Validate that value is nonsparse
`mustBeReal`	Validate that value is real
`mustBeInteger`	Validate that value is integer
`mustBeNonmissing`	Validate that value is not missing

Comparisons

`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

Data Types

`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

Size

`mustBeNonempty`	Validate that value is nonempty
`mustBeScalarOrEmpty`	Validate that value is scalar or empty
`mustBeVector`	Validate that value is vector

Range and Set Membership

`mustBeInRange`	Validate that value is in the specified range
`mustBeMember`	Validate that value is member of specified set

Names

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

Name-Value Arguments Structure

namedargs2cell Convert structure containing name-value pairs to cell array

Variable-Length Argument Lists

Inputs

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

Outputs

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

Additional Checks

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

Topics

Argument Values

Ways to Parse Function Inputs

Choose a technique for checking the validity of input arguments.

Function Argument Validation

Declare input argument class and size and enforce restrictions on argument values.

Argument Validation Functions

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

Number of 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.

Pass-Through Inputs

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.