matlab.unittest.constraints Package

Summary of classes in MATLAB Constraints Interface

Description

You can use constraints to specify business rules for qualifying calculated (actual) values in tests. To test whether or not an actual value satisfies a constraint, use the constraint in conjunction with the matlab.unittest.qualifications qualification methods assertThat, assumeThat, fatalAssertThat, or verifyThat. While constraints are primarily intended for qualifications, you also can use them with the classes in the matlab.unittest.selectors package to select test elements and with the mocking framework to specify behavior and qualify interactions.

The matlab.unittest.constraints package consists of the following classes.

Classes

Constraint Implementations

Fundamental Constraint-Related Interfaces

`matlab.unittest.constraints.BooleanConstraint`	Interface class for Boolean combinations of constraints
`matlab.unittest.constraints.Constraint`	Fundamental interface class for comparisons

General Purpose

`matlab.unittest.constraints.Eventually`	Poll for value to asynchronously satisfy constraint
`matlab.unittest.constraints.HasField`	Constraint specifying structure containing particular field
`matlab.unittest.constraints.IsAnything`	Constraint specifying any value
`matlab.unittest.constraints.IsEqualTo`	General constraint to compare for equality
`matlab.unittest.constraints.IsFalse`	Constraint specifying false value
`matlab.unittest.constraints.IsSameHandleAs`	Constraint specifying handle instance same as another
`matlab.unittest.constraints.IsTrue`	Constraint specifying true value
`matlab.unittest.constraints.ReturnsTrue`	Constraint specifying function handle that returns true

Errors and Warnings

`matlab.unittest.constraints.IssuesNoWarnings`	Constraint specifying function that issues no warnings
`matlab.unittest.constraints.IssuesWarnings`	Constraint specifying function that issues expected warning profile
`matlab.unittest.constraints.Throws`	Constraint specifying function handle that throws MException

Inequalities

`matlab.unittest.constraints.IsGreaterThan`	Constraint specifying value greater than another value
`matlab.unittest.constraints.IsGreaterThanOrEqualTo`	Constraint specifying value greater than or equal to another value
`matlab.unittest.constraints.IsLessThan`	Constraint specifying value less than another value
`matlab.unittest.constraints.IsLessThanOrEqualTo`	Constraint specifying value less than or equal to another value

Array Size

`matlab.unittest.constraints.HasElementCount`	Constraint specifying expected number of elements
`matlab.unittest.constraints.HasLength`	Constraint specifying expected length of array
`matlab.unittest.constraints.HasSize`	Constraint specifying expected size of array
`matlab.unittest.constraints.IsEmpty`	Constraint specifying empty value
`matlab.unittest.constraints.IsScalar`	Constraint specifying scalar value

Type

`matlab.unittest.constraints.IsInstanceOf`	Constraint specifying inclusion in given class hierarchy
`matlab.unittest.constraints.IsOfClass`	Constraint specifying class type

Strings

`matlab.unittest.constraints.ContainsSubstring`	Constraint specifying string containing substring
`matlab.unittest.constraints.EndsWithSubstring`	Constraint specifying string ending with substring
`matlab.unittest.constraints.IsSubstringOf`	Constraint specifying substring of another string
`matlab.unittest.constraints.Matches`	Constraint specifying string matches regular expression
`matlab.unittest.constraints.StartsWithSubstring`	Constraint specifying string starting with substring

Finiteness

`matlab.unittest.constraints.HasInf`	Constraint specifying array containing any infinite value
`matlab.unittest.constraints.HasNaN`	Constraint specifying array containing NaN value
`matlab.unittest.constraints.IsFinite`	Constraint specifying finite value

Numeric Attributes

`matlab.unittest.constraints.IsReal`	Constraint specifying real valued array
`matlab.unittest.constraints.IsSparse`	Constraint specifying sparse array

Set

`matlab.unittest.constraints.HasUniqueElements`	Constraint specifying set contains unique elements
`matlab.unittest.constraints.IsSameSetAs`	Constraint specifying set contains same elements as another set
`matlab.unittest.constraints.IsSubsetOf`	Constraint specifying actual set is subset of expected set
`matlab.unittest.constraints.IsSupersetOf`	Constraint specifying actual set is superset of expected set

Files and Folders

`matlab.unittest.constraints.IsFile`	Constraint specifying value points to file
`matlab.unittest.constraints.IsFolder`	Constraint specifying value points to folder

Actual Value Proxies

`matlab.unittest.constraints.AnyCellOf`	Test if any element of cell array meets constraint
`matlab.unittest.constraints.AnyElementOf`	Test if any element of array meets constraint
`matlab.unittest.constraints.EveryCellOf`	Test if all elements of cell array meet constraint
`matlab.unittest.constraints.EveryElementOf`	Test if all elements of array meet constraint

Tolerances

`matlab.unittest.constraints.AbsoluteTolerance`	Absolute numeric tolerance
`matlab.unittest.constraints.RelativeTolerance`	Relative numeric tolerance
`matlab.unittest.constraints.Tolerance`	Abstract interface class for tolerances

Comparators

`matlab.unittest.constraints.CellComparator`	Comparator for cell arrays
`matlab.unittest.constraints.LogicalComparator`	Comparator for two logical values
`matlab.unittest.constraints.NumericComparator`	Comparator for numeric data types
`matlab.unittest.constraints.ObjectComparator`	Comparator for MATLAB or Java objects
`matlab.unittest.constraints.PublicPropertyComparator`	Comparator for public properties of MATLAB objects
`matlab.unittest.constraints.StringComparator`	Comparator for two strings, character arrays, or cell arrays of character arrays
`matlab.unittest.constraints.StructComparator`	Comparator for MATLAB structure arrays
`matlab.unittest.constraints.TableComparator`	Comparator for MATLAB tables

Documentation