aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSoikk2024-10-20 22:36:49 +0200
committerSoikk2024-10-20 22:36:49 +0200
commitf4a7808ab388dec9c7c3cde52f1e2803d7def653 (patch)
tree027d688579f0228cad7d06331a74843bbb5230d0 /README.md
parent33972d0df39a020f300d6ffa3ee09af01107962d (diff)
downloadsoikk-pearson_verify-f4a7808ab388dec9c7c3cde52f1e2803d7def653.tar.xz
soikk-pearson_verify-f4a7808ab388dec9c7c3cde52f1e2803d7def653.tar.zst
Fixed bug with file2. Changed error behaviour. Updated README to reflect change.
Diffstat (limited to 'README.md')
-rw-r--r--README.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/README.md b/README.md
index 11c823e..d9ad8db 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
# Pearson verify
This program is meant to be used to verify the ouput of the pearson section of [dv1674_a2](https://github.com/sm13294/dv1674_a2).\
\
-This program compares 64 bit floating point numbers stored in a separate line each from \<file1\> and \<file2\>. If all the pairs of numbers are the same up to the 15th decimal place, 0 will be returned. If not, this program will check if all numbers are the same up to the 11th decimal place, and if so 1 will be returned. If [stop] is 1, this program will stop as soon as this happens. If any numbers are not the same up to the 11th decimal place, 2 will be returned. If [stop] is 2, this program will stop as soon as this happens. If there is an error while executing this program, -1 will be returned.
+This program compares 64 bit floating point numbers stored in a separate line each from \<file1\> and \<file2\>. If all the pairs of numbers are the same up to the 15th decimal place, 0 will be returned. If not, this program will check if all numbers are the same up to the 11th decimal place, and if so 1 will be returned. If [stop] is 1, this program will stop as soon as this happens. If any numbers are not the same up to the 11th decimal place, 2 will be returned. If [stop] is 2, this program will stop as soon as this happens. If there is an error while executing this program, -1 will be returned, unless the error lies within the files' structures, in which case 2 will be returned, as it means there was a significant difference in the outputs. Compile with -DDEBUG (make debug) or define DEBUG in the program to print debug information.