assert(condition)
assert(condition, message)
assert(condition, message, value)
assert(condition, identifier, message)
assert(condition, identifier, message, value)
[res, msg] = assert(...)
| Parameter | Description |
|---|---|
| condition | Logical or real numeric scalar or array to test. Every entry must be nonzero. |
| message | Optional custom failure message. Format replacements are supported with following values. |
| identifier | Optional error identifier used when the assertion raises an error. |
| value | Optional value inserted in the message format. |
| Parameter | Description |
|---|---|
| res | true if the assertion passes, false otherwise. |
| msg | Assertion failure message, empty on success. |
assert raises an error when condition is false and no output is requested.
With outputs, assertion failures are returned as res and msg instead of being raised.
Use the asserts package for qualified assertion helpers, for example asserts.isequal(...).
assert(5 > 3);[res, msg] = assert(false, 'condition failed');[res, msg] = assert(false, 'value %.2f', 1.234);[res, msg] = assert(false, 'Nelson:asserts:example', 'condition failed');| Version | Description |
|---|---|
| 1.0.0 | initial version |
| 2.0.0 | added formatted messages, error identifiers and output mode |