Home > matpower4.0 > t > t_ok.m

t_ok

PURPOSE ^

T_OK Tests if a condition is true.

SYNOPSIS ^

function t_ok(cond, msg)

DESCRIPTION ^

T_OK  Tests if a condition is true.
   T_OK(EXPR, MSG) increments the global test count and if the EXPR
   is true it increments the passed tests count, otherwise increments
   the failed tests count. Prints 'ok' or 'not ok' followed by the
   MSG, unless the global variable t_quiet is true. Intended to be
   called between calls to T_BEGIN and T_END.

   Example:
       quiet = 0;
       t_begin(5, quiet);
       t_ok(pi > 3, 'size of pi');
       t_skip(3, 'not yet written');
       t_is(2+2, 4, 12, '2+2 still equals 4');
       t_end;

   See also T_IS, T_SKIP, T_BEGIN, T_END, T_RUN_TESTS.

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 function t_ok(cond, msg)
0002 %T_OK  Tests if a condition is true.
0003 %   T_OK(EXPR, MSG) increments the global test count and if the EXPR
0004 %   is true it increments the passed tests count, otherwise increments
0005 %   the failed tests count. Prints 'ok' or 'not ok' followed by the
0006 %   MSG, unless the global variable t_quiet is true. Intended to be
0007 %   called between calls to T_BEGIN and T_END.
0008 %
0009 %   Example:
0010 %       quiet = 0;
0011 %       t_begin(5, quiet);
0012 %       t_ok(pi > 3, 'size of pi');
0013 %       t_skip(3, 'not yet written');
0014 %       t_is(2+2, 4, 12, '2+2 still equals 4');
0015 %       t_end;
0016 %
0017 %   See also T_IS, T_SKIP, T_BEGIN, T_END, T_RUN_TESTS.
0018 
0019 %   MATPOWER
0020 %   $Id: t_ok.m,v 1.7 2010/04/26 19:45:26 ray Exp $
0021 %   by Ray Zimmerman, PSERC Cornell
0022 %   Copyright (c) 2004-2010 by Power System Engineering Research Center (PSERC)
0023 %
0024 %   This file is part of MATPOWER.
0025 %   See http://www.pserc.cornell.edu/matpower/ for more info.
0026 %
0027 %   MATPOWER is free software: you can redistribute it and/or modify
0028 %   it under the terms of the GNU General Public License as published
0029 %   by the Free Software Foundation, either version 3 of the License,
0030 %   or (at your option) any later version.
0031 %
0032 %   MATPOWER is distributed in the hope that it will be useful,
0033 %   but WITHOUT ANY WARRANTY; without even the implied warranty of
0034 %   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
0035 %   GNU General Public License for more details.
0036 %
0037 %   You should have received a copy of the GNU General Public License
0038 %   along with MATPOWER. If not, see <http://www.gnu.org/licenses/>.
0039 %
0040 %   Additional permission under GNU GPL version 3 section 7
0041 %
0042 %   If you modify MATPOWER, or any covered work, to interface with
0043 %   other modules (such as MATLAB code and MEX-files) available in a
0044 %   MATLAB(R) or comparable environment containing parts covered
0045 %   under other licensing terms, the licensors of MATPOWER grant
0046 %   you additional permission to convey the resulting work.
0047 
0048 global t_quiet;
0049 global t_counter;
0050 global t_ok_cnt;
0051 global t_not_ok_cnt;
0052 
0053 if nargin < 2 || strcmp(msg, '')
0054     msg = '';
0055 else
0056     msg = [' - ', msg];
0057 end
0058 if cond
0059     t_ok_cnt = t_ok_cnt + 1;
0060 else
0061     t_not_ok_cnt = t_not_ok_cnt + 1;
0062     if ~t_quiet
0063         fprintf('not ');
0064     end
0065 end
0066 if ~t_quiet
0067     fprintf('ok %d%s\n', t_counter, msg);
0068 end
0069 t_counter = t_counter + 1;

Generated on Mon 26-Jan-2015 14:56:45 by m2html © 2005