mustBeFloat

Validate that value is floating-point array

Since R2020b

Syntax

mustBeFloat(value)

Description

mustBeFloat(value) throws an error if value is not a floating-point array. The floating-point types are single and double, and subclasses of single and double. This function does not return a value.

mustBeFloat calls the following function to determine if the input is a floating-point number:

• isfloat

Class support: All MATLAB^® classes

Examples

Validate That Input Is Floating-Point Array

Use the mustBeFloat to ensure that the input to a function is a floating-point value.

The myCalc function restricts the input to a floating-point array.

function r = myCalc(a)
    arguments
        a {mustBeFloat}
    end
    r = a .* pi/180;
end

Passing an array of int8 values results in an error.

a = int8([2 4 8 16]);
r = myCalc(a);

Error using myCalc (line 3)
 r = myCalc(a);
            ^
Invalid argument at position 1. Value must be a floating-point array.

Input Arguments

value — Value to validate

floating-point array

Value to validate, specified as a floating-point array.

Data Types: single | double

Tips

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

Extended Capabilities

C/C++ Code Generation
Generate C and C++ code using MATLAB® Coder™.

GPU Arrays

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

The mustBeFloat 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