Assertion functions

The assert_functions module provides assertion tools for unit tests, runtime contracts and diagnostic checks.

All assertions share the same contract: with no output they raise an error on failure; with outputs they return [res, msg].

The canonical API uses qualified assertion names, for example asserts.isequal, asserts.warning and asserts.satisfies.

assert
Check that a condition is true.
assert_checkerror
Historical name for asserts.checkerror.
assert_isapprox
Historical name for asserts.isapprox.
assert_isequal
Historical name for asserts.isequal.
assert_isfalse
Historical name for asserts.isfalse.
assert_istrue
Historical name for asserts.istrue.
asserts.allfalse
Check that every logical entry is false.
asserts.alltrue
Check that every logical entry is true.
asserts.checkerror
Check that a command raises an expected error.
asserts.class
Check that a value has the expected class.
asserts.columnVector
Check that a value is a column vector.
asserts.columns
Check the column count.
asserts.contains
Check that text contains a pattern.
asserts.containsAll
Check that text contains all expected patterns.
asserts.containsAny
Check that text contains at least one expected pattern.
asserts.diff
Return equality diagnostics without throwing.
asserts.empty
Check that a value is empty.
asserts.endsWith
Check that text ends with a suffix.
asserts.fail
Force an assertion failure.
asserts.fields
Check the exact set of structure fields.
asserts.finite
Check that every numeric entry is finite.
asserts.greaterOrEqual
Check that every value is greater than or equal to a limit.
asserts.greaterThan
Check that every value is strictly greater than a limit.
asserts.hasField
Check that a structure has a field.
asserts.hasFields
Check that a structure has all expected fields.
asserts.inRange
Check that every value is inside an inclusive range.
asserts.isapprox
Check that computed and expected numeric values are approximately equal.
asserts.isequal
Check that computed and expected values are equal.
asserts.isfalse
Check that a logical condition is false.
asserts.istrue
Check that a logical condition is true.
asserts.length
Check the length of a value.
asserts.lessOrEqual
Check that every value is less than or equal to a limit.
asserts.lessThan
Check that every value is strictly less than a limit.
asserts.match
Check that text matches a regular expression.
asserts.matchesAll
Check that text matches all regular expressions.
asserts.matchesAny
Check that text matches at least one regular expression.
asserts.matrix
Check that a value is two-dimensional.
asserts.ndims
Check the number of dimensions.
asserts.noError
Check that a command completes without error.
asserts.nonNan
Check that no numeric entry is NaN.
asserts.notApprox
Check that two numeric values are not approximately equal.
asserts.notEqual
Check that two values are not equal.
asserts.notempty
Check that a value is not empty.
asserts.numel
Check the number of elements of a value.
asserts.real
Check that a value is real.
asserts.rowVector
Check that a value is a row vector.
asserts.rows
Check the row count.
asserts.sameSize
Check that two values have the same size.
asserts.satisfies
Check a value with a custom predicate.
asserts.scalar
Check that a value is scalar.
asserts.size
Check that a value has the expected dimensions.
asserts.squareMatrix
Check that a value is a square matrix.
asserts.startsWith
Check that text starts with a prefix.
asserts.throws
Check that a command throws an error containing expected text.
asserts.type
Check that a value has one of the expected classes.
asserts.vector
Check that a value is a vector.
asserts.warning
Check that a command emits the expected warning.
asserts.warningFree
Check that a command completes without warning.