Mercurial > hg > octave-lyh

comparison scripts/testfun/assert.m @ 9051:1bf0ce0930be

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Grammar check TexInfo in all .m files Cleanup documentation sources to follow a few consistent rules. Spellcheck was NOT done. (but will be in another changeset)
author Rik <rdrider0-list@yahoo.com>
date Fri, 27 Mar 2009 22:31:03 -0700
parents 46a12e3f882c
children 330672f4daaa
comparison
equal deleted inserted replaced
9044:656ad518f385 9051:1bf0ce0930be
21 ## @deftypefnx {Function File} {} assert (@var{cond}, @var{errmsg}, @dots{}) 21 ## @deftypefnx {Function File} {} assert (@var{cond}, @var{errmsg}, @dots{})
22 ## @deftypefnx {Function File} {} assert (@var{cond}, @{var{msg_id}, @var{errmsg}, @dots{}) 22 ## @deftypefnx {Function File} {} assert (@var{cond}, @{var{msg_id}, @var{errmsg}, @dots{})
23 ## @deftypefnx {Function File} {} assert (@var{observed},@var{expected}) 23 ## @deftypefnx {Function File} {} assert (@var{observed},@var{expected})
24 ## @deftypefnx {Function File} {} assert (@var{observed},@var{expected},@var{tol}) 24 ## @deftypefnx {Function File} {} assert (@var{observed},@var{expected},@var{tol})
25 ## 25 ##
26 ## Produces an error if the condition is not met. @code{assert} can be 26 ## Produces an error if the condition is not met. @code{assert} can be
27 ## called in three different ways. 27 ## called in three different ways.
28 ## 28 ##
29 ## @table @code 29 ## @table @code
30 ## @item assert (@var{cond}) 30 ## @item assert (@var{cond})
31 ## @itemx assert (@var{cond}, @var{errmsg}, @dots{}) 31 ## @itemx assert (@var{cond}, @var{errmsg}, @dots{})
32 ## @itemx assert (@var{cond}, @var{msg_id}, @var{errmsg}, @dots{}) 32 ## @itemx assert (@var{cond}, @var{msg_id}, @var{errmsg}, @dots{})
33 ## Called with a single argument @var{cond}, @code{assert} produces an 33 ## Called with a single argument @var{cond}, @code{assert} produces an
34 ## error if @var{cond} is zero. If called with a single argument a 34 ## error if @var{cond} is zero. If called with a single argument a
35 ## generic error message. With more than one argument, the additional 35 ## generic error message. With more than one argument, the additional
36 ## arguments are passed to the @code{error} function. 36 ## arguments are passed to the @code{error} function.
37 ## 37 ##
38 ## @item assert (@var{observed}, @var{expected}) 38 ## @item assert (@var{observed}, @var{expected})
39 ## Produce an error if observed is not the same as expected. Note that 39 ## Produce an error if observed is not the same as expected. Note that
40 ## observed and expected can be strings, scalars, vectors, matrices, 40 ## observed and expected can be strings, scalars, vectors, matrices,
41 ## lists or structures. 41 ## lists or structures.
42 ## 42 ##
43 ## @item assert(@var{observed}, @var{expected}, @var{tol}) 43 ## @item assert(@var{observed}, @var{expected}, @var{tol})
44 ## Accept a tolerance when comparing numbers. 44 ## Accept a tolerance when comparing numbers.