Skip to content
Snippets Groups Projects
Verified Commit d6ad9bef authored by David Procházka's avatar David Procházka
Browse files

FIX: better javadoc descriptions

parent 93de9f04
No related branches found
No related tags found
No related merge requests found
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,
}
......@@ -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) {
......
......@@ -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 {
......
......@@ -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 {
/**
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment