Class: matlab.unittest.qualifications.Assumable
Package: matlab.unittest.qualifications
Assume value is equal to specified value
assumeEqual(assumable,actual,expected)
assumeEqual(___,Name,Value)
assumeEqual(___,diagnostic)
assumeEqual(
assumes that assumable
,actual
,expected
)actual
is strictly equal to
expected
. If expected
is not a MATLAB^{®} or Java^{®} object, actual
and expected
must
have the same class, size, and value for the assumption to be met.
assumeEqual
compares actual
and
expected
in the same way as the IsEqualTo
constraint.
assumeEqual(___,
assumes equality
with additional options specified by one or more Name,Value
)Name,Value
pair arguments.
assumeEqual(___,
also associates the diagnostic information in
diagnostic
)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.

The 

The value to test. 

Expected value. 

Diagnostic information related to the qualification, specified as one of the following:
Diagnostic values can be nonscalar. For more information, see 
Specify optional
commaseparated pairs of Name,Value
arguments. Name
is
the argument name and Value
is the corresponding value.
Name
must appear inside quotes. You can specify several name and value
pair arguments in any order as
Name1,Value1,...,NameN,ValueN
.

Absolute tolerance, specified as a numeric array. The tolerance is applied only to values of the same data type. The value can be a scalar or array the same size as the actual and expected values. For an absolute tolerance to be satisfied, 

Relative tolerance, specified as a numeric array. The tolerance is applied only to values of the same data type. The value can be a scalar or array the same size as the actual and expected values. For a relative tolerance to be satisfied, 
This method is functionally equivalent to any of the following:
import matlab.unittest.constraints.IsEqualTo; assumable.assumeThat(actual, IsEqualTo(expected));
import matlab.unittest.constraints.IsEqualTo; import matlab.unittest.constraints.AbsoluteTolerance; assumable.assumeThat(actual, IsEqualTo(expected, ... 'Within', AbsoluteTolerance(abstol)));
import matlab.unittest.constraints.IsEqualTo; import matlab.unittest.constraints.RelativeTolerance; assumable.assumeThat(actual, IsEqualTo(expected, ... 'Within', RelativeTolerance(reltol)));
import matlab.unittest.constraints.IsEqualTo; import matlab.unittest.constraints.AbsoluteTolerance; import matlab.unittest.constraints.RelativeTolerance; assumable.assumeThat(actual, IsEqualTo(expected, ... 'Within', AbsoluteTolerance(abstol)  RelativeTolerance(reltol)));
There exists more functionality when using the IsEqualTo
,
AbsoluteTolerance
, and
RelativeTolerance
constraints 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
.