assert

Assert that a condition is true; throw an error if not.

Syntax

assert(expression)
assert(expression, msg)
assert(expression, msgId, msg, ...)

Description

If expression evaluates to false, throws an error with the supplied message (or a default message). Use to enforce preconditions and invariants. Errors thrown by assert propagate normally and can be caught with try/catch.

Examples

assert(x > 0, 'x must be positive')
assert(size(A) == size(B), 'matrices must match')

See also

• error — Throw an error.
• warning — Display a warning message.