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.

mustBeGreaterThan

Validate that value is greater than another value or issue error

Syntax

mustBeGreaterThan(A,B)

Description

example

mustBeGreaterThan(A,B) issues an error if all elements in A are not greater than the scalar B. This function does not return a value.

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

Examples

collapse all

Use mustBeGreaterThan to validate that the values in the first input are greater than the value of the second input.

mustBeGreaterThan([2 3 4],2)
Error using mustBeGreaterThan (line 19)
Value must be greater than 2.

This class constrains the value of Prop1 to be greater than 2.

classdef MyClass
   properties
      Prop1 {mustBeGreaterThan(Prop1,2)}
   end
end

Create an object and assign a value to its property.

obj = MyClass;
Obj.Prop1 = 2;
Error setting property 'Prop1' of class 'MyClass':
Value must be greater than 2.

When you assign a value to the property, MATLAB® calls mustBeGreaterThan with the value being assigned to the property. mustBeGreaterThan issues an error because the value 2 is not greater than 2.

Input Arguments

collapse all

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

Value that A must be greater than, specified as a scalar of one of the following:

Extended Capabilities

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

Introduced in R2017a

Was this topic helpful?