Skip to content

Latest commit

 

History

History
85 lines (64 loc) · 4.72 KB

README.md

File metadata and controls

85 lines (64 loc) · 4.72 KB
Raw

Tree Similarity Library

We actively develop this library and things change continuously.

The goal of this repository is to be the home of all code corresponding to tree similarity. This code base is a starting point for new research ideas and students project. Implementation of new features should be consistent with this code base.

Currently this README serves everyone, users and contributors. It is disorganised with an idea that having disorganised and correct content is better than no content. It should be expanded on a regular basis and possibly split into README.md and README_CONTRIBUTOR.md.

Please find additional information at our project website.

Licence

All code in this repository is currently under the MIT licence. Each source file must contain the licence and the list of copyright holders (contributors to the source).

Building process

Install CMake for building and testing.

Clone the repository. To build the project, execute the following from the root directory (this will build all targets).

mkdir build
cd build
cmake ..
make

Execute make test to run all tests (currently there are only correctness tests).

In the build directory you find the binary ted that executes the algorithms from command line. Currently there is no help or documentation for this binary.

Generating documentation

Install Doxygen for generating the documentation.

Execute the following (in the project's root directory) to generate the documentation.

doxygen doxygen.config

Then, open doc/html/index.html in your browser.

Notes on user workflow

  1. Convert the input data into the Bracket Notation Format or implement a new parser (e.g., http://www.antlr.org/).
  2. If necessary, implement custom Label class and/or custom CostModel class.
  3. Modify the types of Parser, Label, and CostModel inside tree_similarity.cc if you do not want to use the default types.
  4. Call make to (re-)build the framework.

TODOs

This is a list of of all TODOs split into a few categories.

Features.

  • Command line: make nicer and document.
  • Edit mapping: Implement with subtree-pairs distance matrix as input such that not only the matrix of Zhang and Shasha can be input. There is C++ code here (review and tests required).

README.md

  • Describe functionalities of the library.
  • Explain how to use the tool: command line interface and output.
  • Explain (with examples) how to extend the library with custom labels and cost models.
  • Explain how to use the library in an external project (API).
  • State how to cite the library.

README_CONTRIBUTOR.md

  • Expand the details of including licence and copyright into source files.
  • Describe directory structure and file naming.
  • Describe C++ coding guidelines. Point to:
  • List documentation requirements.
  • Describe requirements for correctness testing of new algorithms.
    • Include test naming convention.
  • Explain how to extend labels and cost models.
  • Explain how to extend input formats (create nodes-labels structure from raw input, parsing raw input).
  • Describe Git workflows (be explicit with the git commands, especially for educational purposes):

Random:

  • Add a meaningful documentation to all parts of the codebase in the Doxygen format.
  • Refactor parts of the codebase if necessary.
  • Enforce (and probably extend) the coding policy/style described on the master branch and create a clang-format configuration to simplify enforcing the coding style for future collaborators.
  • Every pushed code is reviewed by a second person, or there is a discussion about it beforehand.