HTM Index 3.0.1 API Specification

This is the documentation of the htmIndex package.


edu.jhu.htm.core

The core package contains the java implementation of the HTM Index. The HTMindex interface has been introduced as guide to high level features of HTM. HTMindexImp is an implementatation of this. The current implementation only builds level-trees, i.e. different depths at different branches of the HTM quad-tree are not supported. HTMfunc contains some low level routines for HTM computation.

To read up on what the HTM Index is and what it is used for, please visit the HTM Home Page at the Johns Hopkins University.

edu.jhu.htm.geometry

This package allows the user to construc shapes such as Rect and then have a DOmain produced from this.

edu.jhu.htm.app

The app package contains executables to demonstrate the usage of the index. They are

Please browse the documentation on how to use these example code. Usually, you will take one of these examples as the starting position of your own development with htmIndex.

Feedback

If you intend to use the htmIndex, please drop an email to William O'Mullane so that you can be notified of any updates, bugfixes, etc in the future.

Also, if you have any bugs to report or wishes on functionality etc., please write to wil.