assumeLessThan

Class: matlab.unittest.qualifications.Assumable
Package: matlab.unittest.qualifications

Assume value is less than specified value

Syntax

assumeLessThan(assumable,actual,ceiling)
assumeLessThan(assumable,actual,ceiling,diagnostic)


Description

assumeLessThan(assumable,actual,ceiling) assumes that all elements of actual are less than all the elements of ceiling.

assumeLessThan(assumable,actual,ceiling,diagnostic) also associates the diagnostic information in diagnostic with the qualification. Depending on the test runner configuration, the testing framework might display diagnostics when the qualification passes or fails. By default, the framework displays diagnostics only when the qualification fails. You can override the default behavior by customizing the test runner. For example, use a DiagnosticsOutputPlugin instance to display both failing and passing event diagnostics.

Input Arguments

assumable	The matlab.unittest.TestCase instance which is used to pass or fail the assumption in conjunction with the test running framework.
actual	The value to test. actual must be the same size as ceiling unless either one is scalar, at which point scalar expansion occurs.
ceiling	Maximum 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

See examples for verifyLessThan, and replace calls to LessThan with assumeLessThan.

Tips

• This method is functionally equivalent to:

  import matlab.unittest.constraints.IsLessThan;
  assumable.assumeThat(actual, IsLessThan(ceiling));

  There exists more functionality when using the IsLessThan constraint directly via assumeThat.

• 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. Alternatively,

  • 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. For more information, see matlab.unittest.qualifications.Verifiable.

  • 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.