verifyGreaterThan

Class: matlab.unittest.qualifications.Verifiable
Package: matlab.unittest.qualifications

Verify value is greater than specified value

expand all in page

Syntax

verifyGreaterThan(verifiable,actual,floor)
verifyGreaterThan(___,diagnostic)

Description

verifyGreaterThan(verifiable,actual,floor) verifies that all elements of actual are greater than all the elements of floor.

verifyGreaterThan(___,diagnostic) also displays the diagnostic information in diagnostic upon a failure.

Input Arguments

verifiable

The matlab.unittest.TestCase instance which is used to pass or fail the verification in conjunction with the test running framework.

actual

The value to test. actual must be the same size as floor unless either one is scalar, at which point scalar expansion occurs.

floor

Minimum value, exclusive.

diagnostic

Diagnostic information related to the qualification, specified as one of the following:

  • string array

  • character array

  • function handle

  • matlab.unittest.diagnostics.Diagnostic object

Diagnostic values can be nonscalar. For more information, see matlab.unittest.diagnostics.Diagnostic.

Examples

expand all

Create a TestCase object for interactive testing.

testCase = matlab.unittest.TestCase.forInteractiveUse;

Verify 3 is greater than 2.

verifyGreaterThan(testCase, 3, 2);

Interactive verification passed.

Test if 5 is greater than 9.

verifyGreaterThan(testCase, 5, 9);

Interactive verification failed.

---------------------
Framework Diagnostic:
---------------------
verifyGreaterThan failed.
--> The value must be greater than the minimum value.

Actual Value:
         5
Minimum Value (Exclusive):
         9

Test failed.

Test if each element is greater than the FLOOR value, 2.

testCase = matlab.unittest.TestCase.forInteractiveUse;
verifyGreaterThan(testCase, [5 6 7], 2);

Interactive verification passed.

Test if value 5 is greater than each element in the FLOOR array, [1 2 3].

verifyGreaterThan(testCase, 5, [1 2 3]);

Interactive verification passed.

Test if each element in the matrix is greater than the FLOOR value, 4.

verifyGreaterThan(testCase, [1 2 3; 4 5 6], 4);

Interactive verification failed.

---------------------
Framework Diagnostic:
---------------------
verifyGreaterThan failed.
--> Each element must be greater than the minimum value.
    
    Failing Indices:
             1     2     3     5

Actual Value:
         1     2     3
         4     5     6
Minimum Value (Exclusive):
         4

Test failed.

Test if each element is greater than each corresponding element of the FLOOR array, [4 -9 0].

testCase = matlab.unittest.TestCase.forInteractiveUse;
verifyGreaterThan(testCase, [5 -3 2], [4 -9 0]);
Interactive verification passed.

Compare an array to itself.

verifyGreaterThan(testCase, eye(2), eye(2));
Interactive verification failed.

---------------------
Framework Diagnostic:
---------------------
verifyGreaterThan failed.
--> Each element must be greater than each corresponding element of the minimum value array.
    
    Failing Indices:
             1     2     3     4

Actual Value:
         1     0
         0     1
Minimum Value (Exclusive):
         1     0
         0     1

Test failed.

Tips

  • This method is functionally equivalent to:

    matlab.unittest.constraints.IsGreaterThan;
verifiable.verifyThat(actual, IsGreaterThan(floor));

    There exists more functionality when using the IsGreaterThan constraint directly via verifyThat.

  • Use verification qualifications to produce and record failures without throwing an exception. Since verifications do not throw exceptions, all test content runs to completion even when verification failures occur. Typically verifications are the primary qualification for a unit test since they typically do not require an early exit from the test. Use other qualification types to test for violation of preconditions or incorrect test setup. Alternatively,

    • Use assumption qualifications to ensure that the test environment meets preconditions that otherwise do not result in a test failure. Assumption failures result in filtered tests, and the testing framework marks the tests as Incomplete. For more information, see matlab.unittest.qualifications.Assumable.

    • Use assertion qualifications when the failure condition invalidates the remainder of the current test content, but does not prevent proper execution of subsequent test methods. A failure at the assertion point renders the current test method as failed and incomplete. For more information, see matlab.unittest.qualifications.Assertable.

    • Use fatal assertion qualifications to abort the test session upon failure. These qualifications are useful when the failure mode is so fundamental that there is no point in continuing testing. These qualifications are also useful when fixture teardown does not restore the MATLAB® state correctly and it is preferable to abort testing and start a fresh session. For more information, see matlab.unittest.qualifications.FatalAssertable.

See Also

| | | | | | | |

Topics

Introduced in R2013a

MATLAB Documentation

Support