about summary refs log tree commit diff
path: root/.venv/lib/python3.12/site-packages/numpy/core/tests/data/umath-validation-set-README.txt
diff options
context:
space:
mode:
Diffstat (limited to '.venv/lib/python3.12/site-packages/numpy/core/tests/data/umath-validation-set-README.txt')
-rw-r--r--.venv/lib/python3.12/site-packages/numpy/core/tests/data/umath-validation-set-README.txt15
1 files changed, 15 insertions, 0 deletions
diff --git a/.venv/lib/python3.12/site-packages/numpy/core/tests/data/umath-validation-set-README.txt b/.venv/lib/python3.12/site-packages/numpy/core/tests/data/umath-validation-set-README.txt
new file mode 100644
index 00000000..cfc9e414
--- /dev/null
+++ b/.venv/lib/python3.12/site-packages/numpy/core/tests/data/umath-validation-set-README.txt
@@ -0,0 +1,15 @@
+Steps to validate transcendental functions:
+1) Add a file 'umath-validation-set-<ufuncname>.txt', where ufuncname is name of
+   the function in NumPy you want to validate
+2) The file should contain 4 columns: dtype,input,expected output,ulperror
+    a. dtype: one of np.float16, np.float32, np.float64
+    b. input: floating point input to ufunc in hex. Example: 0x414570a4
+       represents 12.340000152587890625
+    c. expected output: floating point output for the corresponding input in hex.
+       This should be computed using a high(er) precision library and then rounded to
+       same format as the input.
+    d. ulperror: expected maximum ulp error of the function. This
+       should be same across all rows of the same dtype. Otherwise, the function is
+       tested for the maximum ulp error among all entries of that dtype.
+3) Add file umath-validation-set-<ufuncname>.txt to the test file test_umath_accuracy.py
+   which will then validate your ufunc.