diff --git a/docs/Home.md b/docs/Home.md deleted file mode 100644 index c8fcadc..0000000 --- a/docs/Home.md +++ /dev/null @@ -1,9 +0,0 @@ -# B-Trees in Erlang - -[![Build Status](https://travis-ci.org/walter-weinmann/b_trees.svg?branch=master)](https://travis-ci.org/walter-weinmann/b_trees) - -The additional documentation consists of the following parts: - -1. [Performance] (https://github.com/walter-weinmann/b_trees/wiki/Performance) gives an idea about the performance of the functions in comparison to the OTP module gb_trees. -2. [References:] (https://github.com/walter-weinmann/b_trees/wiki/References) points out some external documentation. -3. [Testing:] (https://github.com/walter-weinmann/b_trees/wiki/Testing) gives a general overview of the test facilities. diff --git a/docs/Performance.md b/docs/Performance.md deleted file mode 100644 index 484390b..0000000 --- a/docs/Performance.md +++ /dev/null @@ -1,8 +0,0 @@ -### 1. Environment - -All functions were tested with a processor Intel Core i7-6500U including 16 GB of ram. Each function (except largest/1 and smallest/1) was stress tested 10'000 times. - -### 2. Results - -The results of the performance measurements can be found in the following Microsoft Excel file: [Performance] (https://github.com/walter-weinmann/b_trees/wiki/Performance_10000.xlsx). - diff --git a/docs/Performance_10000.xlsx b/docs/Performance_10000.xlsx deleted file mode 100644 index 9576737..0000000 Binary files a/docs/Performance_10000.xlsx and /dev/null differ diff --git a/docs/References.md b/docs/References.md deleted file mode 100644 index 3efc52b..0000000 --- a/docs/References.md +++ /dev/null @@ -1,14 +0,0 @@ -### 1. Original paper - -- [Bayer, Rudolf; McCreight, E. (July 1970), Organization and Maintenance of Large Ordered Indices, Mathematical and Information Sciences Report No. 20, Boeing Scientific Research Laboratories.](http://www.minet.uni-jena.de/dbis/lehre/ws2005/dbs1/Bayer_hist.pdf) - -### 2. Books - -- [Cormen, Thomas; Leiserson, Charles; Rivest, Ronald; Stein, Clifford (2009), Introduction to Algorithms (Third ed.), The MIT Press, pp. 484–504, ISBN 978-0-262-03384-8. Chapter 18: B-Trees.](https://mitpress.mit.edu/books/introduction-algorithms) -- [Knuth, Donald (1998), Sorting and Searching, The Art of Computer Programming, Volume 3 (Second ed.), Addison-Wesley, ISBN 0-201-89685-0. Section 6.2.4: Multiway Trees, pp. 481–491. Also, pp. 476–477 of section 6.2.3 (Balanced Trees) discusses 2-3 trees.](http://www.pearsoned.co.uk/bookshop/detail.asp?item=174970) - - -### 3. Erlang - -- [Documentation of the OTP module gb_trees.](http://erlang.org/doc/man/gb_trees.html) - diff --git a/docs/Testing.md b/docs/Testing.md deleted file mode 100644 index 95a515e..0000000 --- a/docs/Testing.md +++ /dev/null @@ -1,31 +0,0 @@ -### 1. Test Environment - -All files related to **common test** and **eunit** can be found in the directory `test`. The test components in directory `test` are: - -- the **common test** suites `b_trees_SUITE.erl` and `performance_SUITE.erl`, -- the **eunit** test file `b_trees_test.erl`. - -Both `b_trees_SUITE.erl` and `b_trees_test.erl` apply the same tests. Furthermore, the following files have been adjusted: - -- `.gitignore`: defines the test beam files and the test result files to be ignored, -- `.travis.yml`: adds a `./rebar3 ct` command (`after success`), -- `rebar.config`: defines the parameters for **common test**, **coverage analysis** and **eunit**. - -### 2. Running Tests - -**Common Test**, **eunit** and **coverage analysis** can all be executed from the command line with the appropriate `rebar3` commands. The execution of **common test** is also included in Travis CI. - -### 3. Checking Test Results - -The results of the **common test** execution can be checked in the following file: - - file:///.../b_trees/_build/test/logs/index.html - -The results of the **coverage analysis** can be checked in the following file: - - file:///.../b_trees/_build/test/cover/index.html - -### 4 Travis CI - -**Common Test** is currently configured as an `after success` script in Travis CI. This has the disadvantage, that the build of **b_trees** is marked as successful even if **common test** fails. -