Documentation

This is machine translation

Translated by Microsoft
Mouseover text to see original. Click the button below to return to the English verison of the page.

Note: This page has been translated by MathWorks. Please click here
To view all translated materals including this page, select Japan from the country navigator on the bottom of this page.

mustBeNumericOrLogical

Validate that value is numeric or logical or issue error

Syntax

mustBeNumericOrLogical(A)

Description

example

mustBeNumericOrLogical(A) issues an error if A is not numeric or logical. This function does not return a value.

mustBeNumericOrLogical accepts user-defined objects if the class of the object implements these methods:

Examples

collapse all

Validate that the value of an object property is a numeric or logical value.

a = axes;
mustBeNumericOrLogical(a.Visible)
Error using mustBeNumericOrLogical (line 11)
Values must be numeric or logical.

In this case, the value of the Visible property is a char vector, which results in an error.

This class constrains the value of Prop1 to numeric values.

classdef MyClass
   properties
      Prop1 {mustBeNumericOrLogical}
   end
end

Create an object and assign a value to its property.

obj = MyClass;
obj.Prop1 = get(gca,'Visible');
Error setting 'Prop1' property of 'MyClass' class:
Values must be numeric or logical.

When you assign a value to the property, MATLAB® calls mustBeNumericOrLogical with the value being assigned to the property. mustBeNumericOrLogical issues an error because the value assigned to Prop1 is a char vector.

Input Arguments

collapse all

Value to validate, specified as a scalar or array of any one of the following:

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | logical
Complex Number Support: Yes

Extended Capabilities

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

Introduced in R2017a

Was this topic helpful?