mustBeNonmissing

Validate that input does not contain missing values

Syntax

mustBeNonmissing(value)

Description

mustBeNonmissing(value) throws an error if value contains missing values. This function does not return a value.

mustBeNonmissing calls the anymissing function to determine if the input contains missing values.

Class support: single, double, string, cell of character vectors, categorical, datetime, duration, calendarDuration, table, timetable, and MATLAB^® classes that overload anymissing or ismissing.

Examples

Test for Missing Array Elements

The labelPlot function uses the elements of a 1-by-3 string array to label the x- and y-axes of a plot and add a title. The function does not allow missing array elements.

function labelPlot(labels)
    arguments
        labels (1,3) string  {mustBeNonmissing}
    end
    xlabel(labels(1))
    ylabel(labels(2))
    title(labels(3))
end

Create a plot and use the labelPlot function to add labels and a title. The function input array contains a missing element so the mustBeNonmissing function throws an error.

plot(1:10)
strLabels = ["X Label",string(missing),"My Plot"];
labelPlot(strLabels)

Error using labelPlot (line 3)
 labelPlot(strLabels)
           ^^^^^^^^^
Invalid argument at position 1. Value must not have missing data.

Input Arguments

value — Value to validate

scalar | array | cell array of character vectors

Value to validate, specified as a scalar or an array of one of these types or as a cell array of character vectors:

• single, double, string, char, categorical, datetime, duration, calendarDuration, table, or timetable

• All MATLAB classes that overload anymissing or ismissing

Data Types: single | double | string | char | cell | categorical | datetime | duration | calendarDuration | table | timetable

Tips

• mustBeNonmissing is designed to be used for property and function argument validation.

• For information on what constitutes a missing value for different types of values, see the anymissing function.

Extended Capabilities

C/C++ Code Generation

Generate C and C++ code using MATLAB® Coder™.

Usage notes and limitations:

• String input array is not supported.

GPU Arrays

Accelerate code by running on a graphics processing unit (GPU) using Parallel Computing Toolbox™.

The mustBeNonmissing function fully supports GPU arrays. To run the function on a GPU, specify the input data as a gpuArray (Parallel Computing Toolbox). For more information, see Run MATLAB Functions on a GPU (Parallel Computing Toolbox).

Distributed Arrays

Partition large arrays across the combined memory of your cluster using Parallel Computing Toolbox™.

This function fully supports distributed arrays. For more information, see Run MATLAB Functions with Distributed Arrays (Parallel Computing Toolbox).

Version History

Introduced in R2020b

R2022b: Character arrays have no standard missing value

Character arrays have no default definition of a standard missing value. Therefore, mustBeNonmissing now treats blank character array elements (' ') as nonmissing. For example, mustBeNonmissing(['a b']) determines that ['a b'] is not missing. Previously, it determined that ['a b'] contains missing values and threw an error.

R2022a: mustBeNonmissing calls anymissing

mustBeNonmissing calls the anymissing function to determine if the input contains missing values. Previously, it called the ismissing function. This change does not affect the behavior of mustBeNonmissing.