<html> <head> <link rel="stylesheet" href="style.css" type="text/css"> <meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type"> <link rel="Start" href="index.html"> <link title="Index of types" rel=Appendix href="index_types.html"> <link title="Index of values" rel=Appendix href="index_values.html"> <link title="Index of modules" rel=Appendix href="index_modules.html"> <link title="Index of module types" rel=Appendix href="index_module_types.html"> <link title="OUnit" rel="Chapter" href="OUnit.html"> <link title="OUnitDiff" rel="Chapter" href="OUnitDiff.html"><title>OUnit user guide : Index of values</title> </head> <body> <div class="navbar"> <a class="up" href="index.html" title="Index">Up</a> </div> <h1>Index of values</h1> <table> <tr><td align="left"><br></td></tr> <tr><td><a href="OUnit.html#VAL(>:)">(>:)</a> [<a href="OUnit.html">OUnit</a>]</td> <td><div class="info"> Create a TestLabel for a test </div> </td></tr> <tr><td><a href="OUnit.html#VAL(>::)">(>::)</a> [<a href="OUnit.html">OUnit</a>]</td> <td><div class="info"> Create a TestLabel for a TestCase </div> </td></tr> <tr><td><a href="OUnit.html#VAL(>:::)">(>:::)</a> [<a href="OUnit.html">OUnit</a>]</td> <td><div class="info"> Create a TestLabel for a TestList </div> </td></tr> <tr><td><a href="OUnit.html#VAL(@?)">(@?)</a> [<a href="OUnit.html">OUnit</a>]</td> <td><div class="info"> Shorthand for assert_bool </div> </td></tr> <tr><td align="left"><br>A</td></tr> <tr><td><a href="OUnit.html#VALassert_bool">assert_bool</a> [<a href="OUnit.html">OUnit</a>]</td> <td><div class="info"> Signals a failure when bool is false. </div> </td></tr> <tr><td><a href="OUnit.html#VALassert_command">assert_command</a> [<a href="OUnit.html">OUnit</a>]</td> <td><div class="info"> <code class="code">assert_command prg args</code> Run the command provided. </div> </td></tr> <tr><td><a href="OUnitDiff.S.html#VALassert_equal">assert_equal</a> [<a href="OUnitDiff.S.html">OUnitDiff.S</a>]</td> <td><div class="info"> <a href="OUnitDiff.S.html#VALassert_equal"><code class="code"><span class="constructor">OUnitDiff</span>.<span class="constructor">S</span>.assert_equal</code></a> with <code class="code">~diff</code>, <code class="code">~cmp</code> and <code class="code">~printer</code> predefined for this collection events </div> </td></tr> <tr><td><a href="OUnit.html#VALassert_equal">assert_equal</a> [<a href="OUnit.html">OUnit</a>]</td> <td><div class="info"> <code class="code">assert_equal expected real</code> Compares two values, when they are not equal a failure is signaled. </div> </td></tr> <tr><td><a href="OUnit.html#VALassert_failure">assert_failure</a> [<a href="OUnit.html">OUnit</a>]</td> <td><div class="info"> Signals a failure. </div> </td></tr> <tr><td><a href="OUnit.html#VALassert_raises">assert_raises</a> [<a href="OUnit.html">OUnit</a>]</td> <td><div class="info"> Asserts if the expected exception was raised. </div> </td></tr> <tr><td><a href="OUnit.html#VALassert_string">assert_string</a> [<a href="OUnit.html">OUnit</a>]</td> <td><div class="info"> Signals a failure when the string is non-empty. </div> </td></tr> <tr><td align="left"><br>B</td></tr> <tr><td><a href="OUnit.html#VALbracket">bracket</a> [<a href="OUnit.html">OUnit</a>]</td> <td><div class="info"> <code class="code">bracket set_up test tear_down</code> The <code class="code">set_up</code> function runs first, then the <code class="code">test</code> function runs and at the end <code class="code">tear_down</code> runs. </div> </td></tr> <tr><td><a href="OUnit.html#VALbracket_tmpfile">bracket_tmpfile</a> [<a href="OUnit.html">OUnit</a>]</td> <td><div class="info"> <code class="code">bracket_tmpfile test</code> The <code class="code">test</code> function takes a temporary filename and matching output channel as arguments. </div> </td></tr> <tr><td align="left"><br>C</td></tr> <tr><td><a href="OUnit.html#VALcmp_float">cmp_float</a> [<a href="OUnit.html">OUnit</a>]</td> <td><div class="info"> Compare floats up to a given relative error. </div> </td></tr> <tr><td><a href="OUnitDiff.DIFF_ELEMENT.html#VALcompare">compare</a> [<a href="OUnitDiff.DIFF_ELEMENT.html">OUnitDiff.DIFF_ELEMENT</a>]</td> <td><div class="info"> Element comparison </div> </td></tr> <tr><td><a href="OUnitDiff.S.html#VALcompare">compare</a> [<a href="OUnitDiff.S.html">OUnitDiff.S</a>]</td> <td><div class="info"> Compare a collection of element </div> </td></tr> <tr><td align="left"><br>O</td></tr> <tr><td><a href="OUnitDiff.S.html#VALof_list">of_list</a> [<a href="OUnitDiff.S.html">OUnitDiff.S</a>]</td> <td><div class="info"> Create <code class="code">t</code> using of list </div> </td></tr> <tr><td align="left"><br>P</td></tr> <tr><td><a href="OUnit.html#VALperform_test">perform_test</a> [<a href="OUnit.html">OUnit</a>]</td> <td><div class="info"> Perform the test, allows you to build your own test runner </div> </td></tr> <tr><td><a href="OUnitDiff.html#VALpp_comma_separator">pp_comma_separator</a> [<a href="OUnitDiff.html">OUnitDiff</a>]</td> <td></td></tr> <tr><td><a href="OUnitDiff.S.html#VALpp_diff">pp_diff</a> [<a href="OUnitDiff.S.html">OUnitDiff.S</a>]</td> <td><div class="info"> Pretty printer for collection differences </div> </td></tr> <tr><td><a href="OUnitDiff.DIFF_ELEMENT.html#VALpp_print_sep">pp_print_sep</a> [<a href="OUnitDiff.DIFF_ELEMENT.html">OUnitDiff.DIFF_ELEMENT</a>]</td> <td><div class="info"> Pretty print element separator </div> </td></tr> <tr><td><a href="OUnitDiff.DIFF_ELEMENT.html#VALpp_printer">pp_printer</a> [<a href="OUnitDiff.DIFF_ELEMENT.html">OUnitDiff.DIFF_ELEMENT</a>]</td> <td><div class="info"> Pretty printer for an element </div> </td></tr> <tr><td><a href="OUnitDiff.S.html#VALpp_printer">pp_printer</a> [<a href="OUnitDiff.S.html">OUnitDiff.S</a>]</td> <td><div class="info"> Pretty printer a collection of element </div> </td></tr> <tr><td align="left"><br>R</td></tr> <tr><td><a href="OUnit.html#VALrun_test_tt">run_test_tt</a> [<a href="OUnit.html">OUnit</a>]</td> <td><div class="info"> A simple text based test runner. </div> </td></tr> <tr><td><a href="OUnit.html#VALrun_test_tt_main">run_test_tt_main</a> [<a href="OUnit.html">OUnit</a>]</td> <td><div class="info"> Main version of the text based test runner. </div> </td></tr> <tr><td align="left"><br>S</td></tr> <tr><td><a href="OUnit.html#VALskip_if">skip_if</a> [<a href="OUnit.html">OUnit</a>]</td> <td><div class="info"> <code class="code">skip cond msg</code> If <code class="code">cond</code> is true, skip the test for the reason explain in <code class="code">msg</code>. </div> </td></tr> <tr><td><a href="OUnit.html#VALstring_of_node">string_of_node</a> [<a href="OUnit.html">OUnit</a>]</td> <td><div class="info"> Make a string from a node </div> </td></tr> <tr><td><a href="OUnit.html#VALstring_of_path">string_of_path</a> [<a href="OUnit.html">OUnit</a>]</td> <td><div class="info"> Make a string from a path. </div> </td></tr> <tr><td align="left"><br>T</td></tr> <tr><td><a href="OUnit.html#VALtest_case_count">test_case_count</a> [<a href="OUnit.html">OUnit</a>]</td> <td><div class="info"> Returns the number of available test cases </div> </td></tr> <tr><td><a href="OUnit.html#VALtest_case_paths">test_case_paths</a> [<a href="OUnit.html">OUnit</a>]</td> <td><div class="info"> Returns a list with paths of the test </div> </td></tr> <tr><td><a href="OUnit.html#VALtest_decorate">test_decorate</a> [<a href="OUnit.html">OUnit</a>]</td> <td><div class="info"> <code class="code">test_decorate g tst</code> Apply <code class="code">g</code> to test function contains in <code class="code">tst</code> tree. </div> </td></tr> <tr><td><a href="OUnit.html#VALtest_filter">test_filter</a> [<a href="OUnit.html">OUnit</a>]</td> <td><div class="info"> <code class="code">test_filter paths tst</code> Filter test based on their path string representation. </div> </td></tr> <tr><td><a href="OUnit.html#VALtodo">todo</a> [<a href="OUnit.html">OUnit</a>]</td> <td><div class="info"> The associated test is still to be done, for the reason given. </div> </td></tr> </table> </body> </html>