t_ok

PURPOSE

SYNOPSIS

DESCRIPTION

T_OK  Tests whether 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 T_BEGIN was called with input QUIET equal true. Intended
   to be called between calls to T_BEGIN and T_END.

   Optionally returns a true or false value indicating whether or
   not the test succeeded.

   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

• t_insolvablepf T_INSOLVABLEPF Test for power flow insolvability condition
• t_insolvablepf_limitQ T_INSOLVABLEPF_LIMITQ Test for power flow insolvability condition
• t_insolvablepfsos T_INSOLVABLEPF Test for power flow insolvability condition
• t_insolvablepfsos_limitQ T_INSOLVABLEPF Test for power flow insolvability condition
• t_opf_sdpopf T_OPF_SDPOPF Tests for SDP-based AC optimal power flow.
• t_testglobalopt T_TESTGLOBALOPT Test for Global Optimality Condition
• t_sg_options T_SG_OPTIONS Tests for sg_options().
• t_sgvm_add_shunts T_SGVM_ADD_SHUNTS Tests for sgvm_add_shunts().
• t_sgvm_data2mpc T_SGVM_DATA2MPC Tests for sgvm_data2mpc().
• t_syngrid T_SYNGRID Tests for syngrid().
• t_syngrid_vm T_SYNGRID_VM Tests for syngrid() variations mode.
• t_apply_changes T_APPLY_CHANGES Tests for code in apply_changes.m.
• t_cpf T_CPF Tests for continuation power flow.
• t_dcline T_DCLINE Tests for DC line extension in TOGGLE_DCLINE.
• t_ext2int2ext T_EXT2INT2EXT Tests EXT2INT, INT2EXT, and related functions.
• t_feval_w_path T_FEVAL_W_PATH Tests for FEVAL_W_PATH.
• t_islands T_ISLANDS Tests for FIND_ISLANDS, EXTRACT_ISLANDS, CONNECTED_COMPONENTS and CASE_INFO.
• t_load2disp T_LOAD2DISP Tests for LOAD2DISP.
• t_loadcase T_LOADCASE Test that LOADCASE works with a struct as well as case file.
• t_miqps_matpower T_MIQPS_MATPOWER Tests of MIQPS_MATPOWER MIQP solvers.
• t_modcost T_MODCOST Tests for code in MODCOST.
• t_mpoption T_MPOPTION Tests for MPOPTION.
• t_opf_dc_bpmpd T_OPF_DC_BPMPD Tests for DC optimal power flow using BPMPD_MEX solver.
• t_opf_dc_clp T_OPF_DC_CLP Tests for DC optimal power flow using CLP solver.
• t_opf_dc_cplex T_OPF_DC_CPLEX Tests for DC optimal power flow using CPLEX solver.
• t_opf_dc_default T_OPF_DC_DEFAULT Tests for DC optimal power flow using DEFAULT solver.
• t_opf_dc_glpk T_OPF_DC_GLPK Tests for DC optimal power flow using GLPK solver.
• t_opf_dc_gurobi T_OPF_DC_GUROBI Tests for DC optimal power flow using Gurobi solver.
• t_opf_dc_ipopt T_OPF_DC_MIPS Tests for DC optimal power flow using MIPS solver.
• t_opf_dc_mips T_OPF_DC_MIPS Tests for DC optimal power flow using MIPS solver.
• t_opf_dc_mips_sc T_OPF_DC_MIPS_SC Tests for DC optimal power flow using MIPS-sc solver.
• t_opf_dc_mosek T_OPF_DC_MOSEK Tests for DC optimal power flow using MOSEK solver.
• t_opf_dc_osqp T_OPF_DC_OSQP Tests for DC optimal power flow using OSQP solver.
• t_opf_dc_ot T_OPF_DC_OT Tests for DC optimal power flow using Opt Tbx solvers.
• t_opf_default T_OPF_DEFAULT Tests for AC optimal power flow using default solver.
• t_opf_fmincon T_OPF_FMINCON Tests for FMINCON-based optimal power flow.
• t_opf_ipopt T_OPF_IPOPT Tests for IPOPT-based AC optimal power flow.
• t_opf_knitro T_OPF_FMINCON Tests for FMINCON-based optimal power flow.
• t_opf_minopf T_OPF_MINOPF Tests for MINOS-based optimal power flow.
• t_opf_mips T_OPF_MIPS Tests for MIPS-based AC optimal power flow.
• t_opf_model T_OPF_MODEL Tests for OPF_MODEL.
• t_opf_model_legacy T_OPF_MODEL_LEGACY Tests for OPF_MODEL, using the deprecated ADD_CONSTRAINTS.
• t_opf_softlims T_OPF_SOFTLIMS Tests for userfcn callbacks (softlims) w/OPF.
• t_opf_tspopf_pdipm T_OPF_TSPOPF_PDIPM Tests for PDIPM-based optimal power flow.
• t_opf_tspopf_scpdipm T_OPF_TSPOPF_SCPDIPM Tests for SCPDIPM-based optimal power flow.
• t_opf_tspopf_tralm T_OPF_TSPOPF_TRALM Tests for TRALM-based optimal power flow.
• t_opf_userfcns T_OPF_USERFCNS Tests for userfcn callbacks (reserves/iflims) w/OPF.
• t_pf_ac T_PF_AC Tests for AC power flow solvers.
• t_pf_dc T_PF_DC Tests for DC power flow solver.
• t_pf_radial T_PF_RADIAL Tests for distribution power flow solvers.
• t_printpf T_PRINTPF Tests for PRINTPF.
• t_psse T_PSSE Tests for PSSE2MPC and related functions.
• t_qps_matpower T_QPS_MATPOWER Tests of QPS_MATPOWER QP solvers.
• t_scale_load T_SCALE_LOAD Tests for code in SCALE_LOAD.
• t_vdep_load T_VDEP_LOAD Test voltage dependent ZIP load model for PF, CPF, OPF.
• t_mips T_MIPS Tests of MIPS NLP solver.
• t_mips_pardiso T_MIPS_PARDISO Tests of MIPS NLP solver, using PARDISO as linear solver.
• t_qps_mips T_QPS_MIPS Tests of QPS_MIPS QP solver.
• t_most_30b_1_1_0 T_MOST_30B_1_1_0 Tests for MOST.
• t_most_30b_1_1_0_uc T_MOST_30B_1_1_0_UC Tests for MOST.
• t_most_30b_1_1_17 T_MOST_30B_1_1_17 Tests for MOST.
• t_most_30b_3_1_0 T_MOST_30B_3_1_0 Tests for MOST.
• t_most_30b_3_1_17 T_MOST_30B_3_1_17 Tests for MOST.
• t_most_3b_1_1_0 T_MOST_3B_1_1_0 Tests for MOST.
• t_most_3b_1_1_2 T_MOST_3B_1_1_2 Tests for MOST.
• t_most_3b_3_1_0 T_MOST_3B_3_1_0 Tests for MOST.
• t_most_3b_3_1_2 T_MOST_3B_1_1_2 Tests for MOST.
• t_most_fixed_res T_MOST_FIXED_RES Tests MOST with fixed reserve requirements.
• t_most_mpopf T_MOST_MPOPF Tests of deterministic multiperiod DC OPF problems
• t_most_sp T_MOST_SP Tests of single-period continuous optimizations
• t_most_spuc T_MOST_SPUC Tests of single-period unit commitment optimizations
• t_most_suc T_MOST_SUC Tests of stochastic unit commitment optimizations.
• t_most_uc T_MOST_UC Tests of deteministic unit commitment optimizations
• t_have_fcn T_HAVE_FCN Tests for HAVE_FCN.
• t_miqps_master T_MIQPS_MASTER Tests of MILP/MIQP solvers via MIQPS_MASTER().
• t_nested_struct_copy T_NESTED_STUCT_COPY Tests for NESTED_STUCT_COPY.
• t_nleqs_master T_NLEQS_MASTER Tests of NLEQ solvers via NLEQS_MASTER().
• t_nlps_master T_NLPS_MASTER Tests of NLP solvers via NLPS_MASTER().
• t_om_solve_leqs T_OM_SOLVE_LEQS Tests of LEQ solvers via OM.SOLVE().
• t_om_solve_miqps T_OM_SOLVE_MIQPS Tests of MIQP solvers via OM.SOLVE().
• t_om_solve_nleqs T_OM_SOLVE_NLEQS Tests of NLEQ solvers via OM.SOLVE().
• t_om_solve_nlps T_OM_SOLVE_NLPS Tests of NLP solvers via OM.SOLVE().
• t_om_solve_qps T_OM_SOLVE_QPS Tests of QP solvers via OM.SOLVE().
• t_opt_model T_OPT_MODEL Tests for OPT_MODEL.
• t_qps_master T_QPS_MASTER Tests of LP/QP solvers via QPS_MASTER().
• mptest_ex1
• t_have_feature T_HAVE_FEATURE Tests for HAVE_FEATURE.
• t_test_fcns T_TEST_FCNS Test T_OK and T_IS and manually check output of failed tests.
• t_is T_IS Tests if two matrices are identical to some tolerance.

SOURCE CODE

0001 function ok = t_ok(cond, msg)
0002 %T_OK  Tests whether 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 T_BEGIN was called with input QUIET equal true. Intended
0007 %   to be called between calls to T_BEGIN and T_END.
0008 %
0009 %   Optionally returns a true or false value indicating whether or
0010 %   not the test succeeded.
0011 %
0012 %   Example:
0013 %       quiet = 0;
0014 %       t_begin(5, quiet);
0015 %       t_ok(pi > 3, 'size of pi');
0016 %       t_skip(3, 'not yet written');
0017 %       t_is(2+2, 4, 12, '2+2 still equals 4');
0018 %       t_end;
0019 %
0020 %   See also T_IS, T_SKIP, T_BEGIN, T_END, T_RUN_TESTS.
0021 
0022 %   MP-Test
0023 %   Copyright (c) 2004-2020, Power Systems Engineering Research Center (PSERC)
0024 %   by Ray Zimmerman, PSERC Cornell
0025 %
0026 %   This file is part of MP-Test.
0027 %   Covered by the 3-clause BSD License (see LICENSE file for details).
0028 %   See https://github.com/MATPOWER/mptest for more info.
0029 
0030 global t_quiet;
0031 global t_counter;
0032 global t_ok_cnt;
0033 global t_not_ok_cnt;
0034 
0035 if nargin < 2 || strcmp(msg, '')
0036     msg = '';
0037 else
0038     msg = [' - ', msg];
0039 end
0040 if cond
0041     t_ok_cnt = t_ok_cnt + 1;
0042 else
0043     t_not_ok_cnt = t_not_ok_cnt + 1;
0044     if ~t_quiet
0045         fprintf('not ');
0046     end
0047 end
0048 if ~t_quiet
0049     fprintf('ok %d%s\n', t_counter, msg);
0050 end
0051 t_counter = t_counter + 1;
0052 if nargout
0053     ok = cond;
0054 end