aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSoikk2024-10-20 22:52:38 +0200
committerSoikk2024-10-20 22:52:38 +0200
commite99428c53e8240069c0feba2e84bd4c323532a1f (patch)
tree27bfc2798c7ea3e2e5b1f3035830497d4158ede2 /README.md
parente98f5e3ebb04c0d46ae1a31e3160bfa4c3efa02d (diff)
downloadsoikk-pearson_verify-e99428c53e8240069c0feba2e84bd4c323532a1f.tar.xz
soikk-pearson_verify-e99428c53e8240069c0feba2e84bd4c323532a1f.tar.zst
Added quiet mode
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 d9ad8db..5e6b07a 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, 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.
+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. Define DEBUG in the source code or compile with -DDEBUG (or use make debug) to print debug information. Define QUIET in the source code or compile with -DQUIET (or use make quiet) to prevent the program from printing anything.