com.io7m.jspatial 3.0.0-beta0001 Documentation
Package Information
Orientation
Overview
The com.io7m.jspatial package
implements several spatial data structures, such as octtrees and
quadtrees.
Simplicity
The com.io7m.jspatial package
strives for simplicity in interface and implementation. Most
implementations of the data structures included are less than
700
lines of code (including comments and annotations).
The intention is to allow for ease of understanding of the structures
and algorithms involved, to increase confidence in their correctness
and to ease auditing.
Efficiency
The package provides specialized implementations of the specified
APIs, with versions for long integer and double precision floating
point coordinates.
Correctness
The package includes a large battery of automated tests that attempt
to verify the correctness of the included implementations. As of the
time of writing, the tests manage over 96% coverage for all code
.
Installation
Source compilation
The project can be compiled and installed with
Maven:
Maven
Regular releases are made to the
Central Repository,
so it's possible to use the
com.io7m.jspatial
package in your projects with the following Maven dependency:
<dependency>
<groupId>com.io7m.jspatial</groupId>
<artifactId>io7m-jspatial-api</artifactId>
<version>[3.0.0, 4.0.0)</version>
</dependency>
<dependency>
<groupId>com.io7m.jspatial</groupId>
<artifactId>io7m-jspatial-implementation</artifactId>
<version>[3.0.0, 4.0.0)</version>
</dependency>
All
io7m.com
packages use Semantic Versioning
, which implies that it is always safe to use version ranges
with an exclusive upper bound equal to the next major version - the API of
the package will not change in a backwards-incompatible manner before the
next major version.
Platform Specific Issues
There are currently no known platform-specific issues.
License
All files distributed with the
package are placed under the following license:
Copyright © 2016 http://io7m.com
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
API Reference
Javadoc
API documentation for the package is provided via the
included
Javadoc.