You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+16-22Lines changed: 16 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,29 +21,23 @@ If you use this library in your research, please cite the following paper:
21
21
22
22
## Overview
23
23
24
-
The JavaPermutationTools (JPT) API provides Java classes that enable representing and generating
25
-
permutations and sequences, as well as performing computation on permutations and sequences.
26
-
It includes implementations of a variety of permutation distance metrics as well as distance
27
-
metrics on sequences (i.e., Strings, arrays, and other ordered data types).
24
+
The JavaPermutationTools (JPT) library provides Java classes and interfaces, etc that
25
+
enable representing and generating permutations and sequences, as well as performing
26
+
computation on permutations and sequences. It includes implementations of a variety
27
+
of permutation distance metrics as well as distance metrics on sequences (i.e., Strings,
28
+
arrays, and other ordered data types).
29
+
30
+
## Repository Organization
31
+
32
+
The GitHub repository is organized as follows:
33
+
* The [/build](build) directory contains an ant build file, and other resources related to building the library.
34
+
* The [/dist](dist) directory contains the compiled jar files of the library.
35
+
* The [/docs](docs) directory contains the javadoc documentation in a sub-directory /docs/api. The /docs directory is also the location of the website for the project hosted via GitHub pages at https://jpt.cicirello.org/.
36
+
* The [/examples](examples) directory contains several example programs that use the library, and which demonstrate usage of various features.
37
+
* The [/replication](replication) directory includes source code that recreates results found in publications associated with the library.
38
+
* The [/src](src) directory contains all of the source code.
39
+
* The [/tests](tests) directory contains JUnit test cases for all functionality of the library.
28
40
29
-
JPT is organized into the following packages:
30
-
*__org.cicirello.permutations__: Permutation class and a class for iterating over permutations.
31
-
*__org.cicirello.permutations.distance__: Collection of permutation distance metric implementations.
32
-
*__org.cicirello.sequences__: Classes that perform a variety of operations on sequences (such as arrays, etc).
33
-
*__org.cicirello.sequences.distance__: Collection of distance metrics on Strings and other sequences.
34
-
*__org.cicirello.math.la__ : Linear algebra related classes.
35
-
*__org.cicirello.math.rand__ : Classes related to efficient, or specialized, random number generation.
36
-
*__org.cicirello.math.stats__: Statistics related classes.
37
-
38
-
Javadoc documentation is in the /docs folder as well as at https://jpt.cicirello.org/
39
-
40
-
Source code is found in the /src folder. JUnit test classes are found in the /tests folder, which
41
-
mirrors the package structure of /src.
42
-
43
-
Compiled jar files of the library are in the /dist folder.
44
-
45
-
The /examples folder includes source code to illustrate how to use the library. The /replication
46
-
folder includes source code that recreates results found in publications associated with the library.
0 commit comments