Name

assert_checktrue — Check that condition is true.

Calling Sequence

   flag = assert_checktrue ( condition )
   flag = assert_checktrue ( condition )
   [flag,errmsg] = assert_checktrue ( condition )
   
   

Parameters

condition:

a matrix of booleans

flag :

a 1x1 matrix of boolean, %t if computed is close to expected, %f if not

errmsg :

a 1x1 matrix of strings, the error message. If flag==%t, then errormsg=="". If flag==%f, then errmsg contains the error message.

Description

Performs silently if all entries in condition are true.

Generates an error if any entry in the condition matrix is false. Generates an error if the condition variable is not a boolean.

If any entry in condition is false,

  • if the errmsg output variable is not used, an error is generated,
  • if the errmsg output variable is used, no error is generated.

Examples

// Tests which pass
assert_checktrue ( %t );
flag = assert_checktrue ( %t )
[flag,errmsg] = assert_checktrue ( %t )
[flag,errmsg] = assert_checktrue ( [%t %t] );

// Tests which fail
assert_checktrue ( [%t %f] );
flag = assert_checktrue ( [%t %f] )
// No error generated
[flag,errmsg] = assert_checktrue ( [%t %f] )

// Wrong calls
assert_checktrue ( "a" )

   

Authors

Michael Baudin, 2010