Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

javadoc regressions #32

Merged
merged 1 commit into from
Aug 12, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
[#29](https://github.com/tzaeschke/tinspin-indexes/pull/29)

### Fixed
- Fix javadoc regressions. [#32](https://github.com/tzaeschke/tinspin-indexes/pull/32)
- Test candidates should counsistently use integers as values.
[#31](https://github.com/tzaeschke/tinspin-indexes/pull/31)
- Remove erroneous references to GPL 3.0. This library is APL 2.0 only.
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/tinspin/index/BoxMap.java
Original file line number Diff line number Diff line change
Expand Up @@ -206,6 +206,7 @@ static <T> BoxMap<T> createRStarTree(int dims) {
* @param dims Number of dimensions.
* @param entries All entries of the tree. Entries can be created with
* {@link RTreeEntry#createBox(double[], double[], Object)}
* @param <T> Value type
* @return New STR-loaded R*Tree
*/
static <T> BoxMap<T> createAndLoadStrRTree(int dims, RTreeEntry<T>[] entries) {
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/tinspin/index/BoxMultimap.java
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,7 @@ static <T> BoxMultimap<T> createRStarTree(int dims) {
* @param dims Number of dimensions.
* @param entries All entries of the tree. Entries can be created with
* {@link RTreeEntry#createBox(double[], double[], Object)}
* @param <T> Value type
* @return New STR-loaded R*Tree
*/
static <T> BoxMultimap<T> createAndLoadStrRTree(int dims, RTreeEntry<T>[] entries) {
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/tinspin/index/PointMap.java
Original file line number Diff line number Diff line change
Expand Up @@ -271,6 +271,7 @@ static <T> PointMap<T> createRStarTree(int dims) {
* @param dims Number of dimensions.
* @param entries All entries of the tree. Entries can be created with
* {@link RTreeEntry#createPoint(double[], Object)}
* @param <T> Value type
* @return New STR-loaded R*Tree
*/
static <T> PointMap<T> createAndLoadStrRTree(int dims, RTreeEntry<T>[] entries) {
Expand Down
1 change: 1 addition & 0 deletions src/main/java/org/tinspin/index/PointMultimap.java
Original file line number Diff line number Diff line change
Expand Up @@ -285,6 +285,7 @@ static <T> PointMultimap<T> createRStarTree(int dims) {
* @param dims Number of dimensions.
* @param entries All entries of the tree. Entries can be created with
* {@link RTreeEntry#createPoint(double[], Object)}
* @param <T> Value type
* @return New STR-loaded R*Tree
*/
static <T> PointMultimap<T> createAndLoadStrRTree(int dims, RTreeEntry<T>[] entries) {
Expand Down
8 changes: 6 additions & 2 deletions src/main/java/org/tinspin/index/rtree/RTreeEntry.java
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,11 @@ public class RTreeEntry<T> extends BoxEntry<T> {

/**
* Create a new entry based on an axis aligned box.
* @param min Box minimum
* @param max Box maximum
* @param min Box minimum
* @param max Box maximum
* @param value The value associated with the box.
* @param <T> Value type
* @return New BoxEntry
*/
public static <T> RTreeEntry<T> createBox(double[] min, double[] max, T value) {
return new RTreeEntry<>(min, max, value);
Expand All @@ -36,6 +38,8 @@ public static <T> RTreeEntry<T> createBox(double[] min, double[] max, T value) {
* Create a new R-Tree entry based on a point coordinate.
* @param point The point.
* @param value The value associated with the point.
* @param <T> Value type
* @return New PointEntry
*/
public static <T> RTreeEntry<T> createPoint(double[] point, T value) {
return new RTreeEntry<>(point, point, value);
Expand Down