Initializing help system before first use

assert

Purpose
Abort execution if a condition is not satisfied.
Synopsis
procedure assert(c:boolean)
procedure assert(c:boolean,m:string)
procedure assert(c:boolean,m:string,e:integer)
Arguments
c 
Condition to verify
m 
Error message to display in case of failure
e 
Error code to return in case of failure (default: 8)
Example 
assert(and(i in I) mydata(i)>0)
assert(isodd(a),"a is not odd!!")
Further information
1. If the condition c is satisfied, this procedure has no effect, otherwise it displays an error message, calls dumpcallstack(0), and aborts execution by calling exit. The versions of the procedure with 2 and 3 parameters can be used to replace the default message (location of the statement in the source) and default exit value (8).
2. If the message m starts with the symbols "." or ":" ( e.g. ": my error") the resulting message will be prefixed by the location of the statement in the source. Otherwise the provided message will replace the default text and be printed unchanged.
3. Assertions are usually used as a debugging tool and are ignored ( i.e. the statemens are not included at all) when the model is compiled without debugging information ( i.e. none of options -g or -G is used) or if the compiler flag -na is used. It is however possible to keep assert statements even when no debugging information is included by specifying the compiler directive keepassert (see Section The compiler directives).
Related topics
exit, dumpcallstack

Parent Topic Predefined functions and procedures

© 2001-2022 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.