summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorinternetlandlord <f.fredhenry@gmail.com>2022-10-26 12:21:15 -0500
committerinternetlandlord <f.fredhenry@gmail.com>2022-10-26 12:21:15 -0500
commit7ccfafb0c07b38524270ebcd61ed03984332ab5a (patch)
tree18f3a4e9e6554955c5587659913191e94642f61a
parentff55f26f024ff6eaa72b25239906768872bb94ff (diff)
Updated README.md with content and phrasing
-rw-r--r--README.md47
1 files changed, 22 insertions, 25 deletions
diff --git a/README.md b/README.md
index 32befaa..52e5872 100644
--- a/README.md
+++ b/README.md
@@ -1,39 +1,36 @@
-# algo-py
-
-## The python algorithm repository
+# algo-py: the python algorithm repository
The purpose of this repo is to explore and demonstrate the function of computer
science algorithms with file manipulation (using CSV files of random numbers).
The functional file contains I/O functions for ingressing and egressing data.
-### Algos covered:
-* Selection Sort
-* Insertion Sort
-* Quick Sort
-* Bubble Sort
-* Merge Sort
-* Heap Sort
-
-More to come!
-
-
-## Ideas
-- Reverse order sorting algorithms (to kick it up a notch)
-- time study (how long does each take) + complexity log
-- seperate appends depending on each algorithm used
+### featured algorithms:
+* Selection Sort - 0(n^2)
+* Insertion Sort - 0(n^2)
+* Quick Sort - 0(n*log(n))
+* Bubble Sort - 0(n^2)
+* Merge Sort - 0(n*log(n))
+* Heap Sort - 0(n*log(n))
-## Other funcions
+## additional included funcions
#### buildtest.sh
-* Used to generate a series of CSVs with increasingly larger row sizes
+Generates a series of CSVs in progressively larger sizes for running algorithms against
-#### input-output.py
-* Contains functions that are imported into algorithm scripts for ingressing/
-exporting data to csv
+#### inputoutput.py
+Library for functions that are used by the scripts to:
+* generate
+* ingest
+* export
+the contents of CSV files for sorting purposes
#### list-generator.py
-* Used to create randomly-generated CSVs for testing algorithm performance
+Uses the inputoutput file as a module for generating CSVs based on command line arguments
#### tripler.py
-* Serves as a proof-of-concept for file content manipulation
+Proof-of-concept for CSV content manipulation. Also serves as base for additional algorithms
+## ideas-list
+- Reverse order sorting algorithms (to kick it up a notch)
+- time study (how long does each take) + complexity log
+- seperate file appends depending on each algorithm used