diff options
| -rw-r--r-- | readme.md | 74 | ||||
| -rw-r--r-- | readme.txt | 45 |
2 files changed, 74 insertions, 45 deletions
diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..cd73cf6 --- /dev/null +++ b/readme.md @@ -0,0 +1,74 @@ + +## Number Wall Tools + +This project consists of three tools based around using numbers walls (also +known as [quotient-difference tables](https://mathworld.wolfram.com/Quotient-DifferenceTable.html)) +to analyse integer sequences. It was inspired by a video on youtube by +[Burkard Polster](https://www.qedcat.com/) otherwise known as the Mathologer. + +> ###### 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. + +Examples of this format can be found in the `data` subdirectory. + + + +#### Dependencies + +Build time: +<ul> + <li>GNU Make</li> + <li>LablGTK</li> + <li>OCaml</li> + <li>ocamlfind</li> + <li>Zarith</li> +</ul> + +Run time: +<ul> + <li>LablGTK</li> + <li>Zarith</li> +</ul> + + + +#### Building Instructions + +Once the dependencies are satisfied `make all` will build all binaries. + +Additionally `make tests` can be used to build a test program that was created +to check whether the implementation of polynomials is working correctly. + +To get rid of compilation artifacts use `make clean` and to delete the compiled +binaries use `make distclean`. + + + +#### Credits and Licensing + +Written by Jedidiah Barber. + +Licensed under the Sunset License v1.0. Consult `license.txt` for further +information. + + diff --git a/readme.txt b/readme.txt deleted file mode 100644 index 62d7e92..0000000 --- a/readme.txt +++ /dev/null @@ -1,45 +0,0 @@ - -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. - - |