Version 1.0b1 API Documentation generated by Endo 2006-08-14

Function summary

• assert_almost_equal(actual, desired, decimal = 7, err_msg = '', verbose = True)
• assert_approx_equal(actual, desired, significant = 7, err_msg = '', verbose = True)
• assert_array_almost_equal(x, y, decimal = 6, err_msg = '', verbose = True)
• assert_array_compare(comparision, x, y, err_msg = '', verbose = True, header = '')
• assert_array_equal(x, y, err_msg = '', verbose = True)
• assert_array_less(x, y, err_msg = '', verbose = True)
• assert_equal(actual, desired, err_msg = '', verbose = True)
• build_err_msg(arrays, err_msg, header = 'Items are not equal:', verbose = True, names = ('ACTUAL', 'DESIRED'))
• rand(args)
• runstring(astr, dict)

Functions

• assert_almost_equal(actual, desired, decimal = 7, err_msg = '', verbose = True)

  Raise an assertion if two items are not equal.

  I think this should be part of unittest.py

  The test is equivalent to abs(desired-actual) < 0.5 * 10**(-decimal)

• assert_approx_equal(actual, desired, significant = 7, err_msg = '', verbose = True)

  Raise an assertion if two items are not equal. I think this should be part of unittest.py Approximately equal is defined as the number of significant digits correct

• assert_array_almost_equal(x, y, decimal = 6, err_msg = '', verbose = True)
• assert_array_compare(comparision, x, y, err_msg = '', verbose = True, header = '')
• assert_array_equal(x, y, err_msg = '', verbose = True)
• assert_array_less(x, y, err_msg = '', verbose = True)
• assert_equal(actual, desired, err_msg = '', verbose = True)

  Raise an assertion if two items are not equal. I think this should be part of unittest.py

• build_err_msg(arrays, err_msg, header = 'Items are not equal:', verbose = True, names = ('ACTUAL', 'DESIRED'))
• rand(args)

  Returns an array of random numbers with the given shape.

  This only uses the standard library, so it is useful for testing purposes.

• runstring(astr, dict)

Imported names