diff options
| -rw-r--r-- | readme.txt | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/readme.txt b/readme.txt new file mode 100644 index 0000000..62d7e92 --- /dev/null +++ b/readme.txt @@ -0,0 +1,45 @@ + +Number Wall Tools +================= + + + +This project consists of three tools: + +visualwall +This is a GUI program that creates a colored visual representation of a number wall. Numbers in the +wall that are equal to zero modulo a given modulus are colored in one color, while all other numbers +are colored in a different color. + +wallgen +This is a command line program that generates a number wall in comma separated value format from a +given sequence. Generation of values in the wall is stopped once a row is encountered which is all +zeros. + +wallsolve +This is a command line program that uses a number wall to calculate a recurrence relation that +describes a given sequence. The relation is then used to predict the next value in the sequence. + +When supplying sequence input to these tools by way of an input file, the required format is a +textfile that has a comma separated value unquoted integer sequence as its first line. All +additional lines in the file are ignored. + + + +The dependencies are: + +gnu make +lablgtk +ocaml +ocamlfind +zarith + + + +How to build/install: + +Once the dependencies are satisfied "make all" will build all binaries. In addition, "make tests" +can be used to build a test program that was created to check whether the implementation of +polynomials was working correctly. + + |