From d6ad9bef58ed95ef12eab694868a432f0b3304eb Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?David=20Proch=C3=A1zka?= <david@prochazka.dev>
Date: Wed, 17 Mar 2021 17:38:10 +0100
Subject: [PATCH] FIX: better javadoc descriptions
---
src/mhtree/InsertType.java | 15 +++++++--------
src/mhtree/InternalNode.java | 5 +----
src/mhtree/LeafNode.java | 2 +-
src/mhtree/ObjectToNodeDistance.java | 2 +-
4 files changed, 10 insertions(+), 14 deletions(-)
diff --git a/src/mhtree/InsertType.java b/src/mhtree/InsertType.java
index b4bc8a8..33cd73f 100644
--- a/src/mhtree/InsertType.java
+++ b/src/mhtree/InsertType.java
@@ -1,21 +1,20 @@
package mhtree;
/**
- * Specifies how should new objects be added to the MH-Tree.
+ * Specifies how new objects should be added to the MH-Tree.
*/
public enum InsertType {
/**
- * When inserted object is not covered by node, all objects under such node are retrieved and a new hull is build,
- * replacing the current one.
+ * When the inserted object is not covered by a node, all objects under such node are retrieved,
+ * and a new hull is built, replacing the current one.
*/
GREEDY,
/**
- * When inserted object is not overed by node, we iterate over hull objects beginning with the nearest hull object.
- * We try to replace existing hull object by replacing current hull object by inserted object
- * and checking if the replaced hull objects is covered by the new hull.
- * This is repeated until such hull object is found or if not,
- * the inserted object is simply added as a new hull object.
+ * When the inserted object is not covered by node, we iterate over hull objects beginning with the nearest one.
+ * We try to replace the hull object by removing it from the hull and replacing it with the inserted object.
+ * If the removed hull object is covered by the new hull, we are done.
+ * If no such hull object is found, the inserted object is simply added as a new hull object.
*/
INCREMENTAL,
}
diff --git a/src/mhtree/InternalNode.java b/src/mhtree/InternalNode.java
index 44ca059..22929b5 100644
--- a/src/mhtree/InternalNode.java
+++ b/src/mhtree/InternalNode.java
@@ -9,7 +9,7 @@ import java.util.List;
import java.util.stream.Collectors;
/**
- * Represents internal node of MH-Tree, i.e. a non-leaf node.
+ * Represents an internal node in MH-Tree.
*/
class InternalNode extends Node implements Serializable {
@@ -18,9 +18,6 @@ class InternalNode extends Node implements Serializable {
*/
private static final long serialVersionUID = 2L;
- /**
- * List of children.
- */
private final List<Node> children;
InternalNode(PrecomputedDistances distances, InsertType insertType, ObjectToNodeDistance objectToNodeDistance, List<Node> children) {
diff --git a/src/mhtree/LeafNode.java b/src/mhtree/LeafNode.java
index e11bd7e..9d30a59 100644
--- a/src/mhtree/LeafNode.java
+++ b/src/mhtree/LeafNode.java
@@ -11,7 +11,7 @@ import java.util.ArrayList;
import java.util.List;
/**
- * Represents leaf node of MH-Tree.
+ * Represents a leaf node in MH-Tree.
*/
class LeafNode extends Node implements Serializable {
diff --git a/src/mhtree/ObjectToNodeDistance.java b/src/mhtree/ObjectToNodeDistance.java
index ecd6910..410d904 100644
--- a/src/mhtree/ObjectToNodeDistance.java
+++ b/src/mhtree/ObjectToNodeDistance.java
@@ -3,7 +3,7 @@ package mhtree;
import messif.objects.LocalAbstractObject;
/**
- * Specifies possible distances between an object and a node.
+ * Specifies possible distance measurements between an object and a node.
*/
public enum ObjectToNodeDistance {
/**
--
GitLab