File Exchange

image thumbnail

Assertion function

version 1.3.0.1 (1.56 KB) by Malcolm Wood
A function similar to "assert" in C to assist in bug detection

1 Download

Updated 01 Sep 2016

View License

Widely used in languages such as C and (now) Java, assertions are a very useful way of detecting bugs as early as possible in development.
Simply assert in the code that you believe something to be true:
ASSERT(ischar(x) && ~isempty(x),'x is a non-empty string')
If, at runtime, x is not a non-empty string, the ASSERT function throws an error. Using the assertion, rather than waiting for something else to go wrong, guarantees that the problem doesn't go unnoticed, and gives you a meaningful error message.

It also serves as a kind of documentation: when you come back to this code in future to change the way that variable "x" is handled, you can be sure that you don't need to consider the case where "x" is empty or is not a string.

There are two reasons to use ASSERT rather than just using "error" itself.

Firstly, assertions are concise. The above line takes up less space (and arguably is more readable) than:

if ~ischar(x) || isempty(x)
error('x must be a non-empty string');
end

Secondly, when the assertion fails this function shows the message and the current callstack in the MATLAB command window even if the error is caught. By simply using "error", you run the risk that the problem can be hidden by over-zealous error handling code.

Note: The ASSERT function should not be thought of as run-time error detection. You should only assert things are true unless your code contains bugs. An obvious example of when *not* to use an assertion is:
f = fopen('myfile.txt')
ASSERT(f~=-1,'f is a valid file handle'); % do not do this!
This is a valid error condition, and "error" should be used.

Another note: Since R2007a, MATLAB has its own function called "assert", fairly similar to this one. Errors thrown by it aren't automatically shown in the command window, so it could be used for normal run-time error handling, which makes its purpose slightly different from the one supplied here. Take your pick.

Cite As

Malcolm Wood (2020). Assertion function (https://www.mathworks.com/matlabcentral/fileexchange/10366-assertion-function), MATLAB Central File Exchange. Retrieved .

Comments and Ratings (6)

Perfect for backwards-compatibility!
@Peter: this is the case since 2007, but if you are "forced" to work with older versions, the file is perfect.

Petter

Already present in standard Matlab since many years ago.

T Whipple

Please disregard my earlier comment. It works fine.

T Whipple

This doesn't seem to work in Matlab 2006b.

x=1;
assert('x==1')
??? Undefined function or method 'assert' for input arguments of type 'char'.

Naveen Mishra

Finally there is a builtin assert function in MATLAB R2007a.

Roger Krill

Is there any reason why the function name is uppercase? This is non-standard. Also, is there a way to show the test condition itself as part of the error message?

Updates

1.3.0.1

Updated license

1.3.0.0

Added copyright notice and discussion of MATLAB's "assert" function.

1.2.0.0

Added copyright line.

1.1.0.0

Review

MATLAB Release Compatibility
Created with R14SP3
Compatible with any release
Platform Compatibility
Windows macOS Linux
Acknowledgements

Inspired by: assert.m