diff options
Diffstat (limited to 'src/de/lmu/ifi/dbs/elki/index/tree')
9 files changed, 29 insertions, 16 deletions
diff --git a/src/de/lmu/ifi/dbs/elki/index/tree/DistanceEntry.java b/src/de/lmu/ifi/dbs/elki/index/tree/DistanceEntry.java index 63aa5978..b7bf3e0c 100644 --- a/src/de/lmu/ifi/dbs/elki/index/tree/DistanceEntry.java +++ b/src/de/lmu/ifi/dbs/elki/index/tree/DistanceEntry.java @@ -30,6 +30,10 @@ import de.lmu.ifi.dbs.elki.distance.distancevalue.Distance; * belonging to this entry. * * @author Elke Achtert + * + * @apiviz.composedOf Distance + * @apiviz.uses Entry + * * @param <E> the type of Entry used in the index * @param <D> the type of Distance used */ diff --git a/src/de/lmu/ifi/dbs/elki/index/tree/IndexTree.java b/src/de/lmu/ifi/dbs/elki/index/tree/IndexTree.java index f16b0e0e..fa9c0e0a 100644 --- a/src/de/lmu/ifi/dbs/elki/index/tree/IndexTree.java +++ b/src/de/lmu/ifi/dbs/elki/index/tree/IndexTree.java @@ -33,6 +33,7 @@ import de.lmu.ifi.dbs.elki.utilities.exceptions.AbortException; * * @author Elke Achtert * + * @apiviz.composedOf PageFile * @apiviz.has Node oneway - - contains * @apiviz.has TreeIndexHeader oneway * diff --git a/src/de/lmu/ifi/dbs/elki/index/tree/IndexTreePath.java b/src/de/lmu/ifi/dbs/elki/index/tree/IndexTreePath.java index c8fa3e82..feb134e3 100644 --- a/src/de/lmu/ifi/dbs/elki/index/tree/IndexTreePath.java +++ b/src/de/lmu/ifi/dbs/elki/index/tree/IndexTreePath.java @@ -33,6 +33,7 @@ import java.util.List; * @author Elke Achtert * * @apiviz.composedOf TreeIndexPathComponent + * @apiviz.uses Entry * * @param <E> the type of Entry used in the index */ diff --git a/src/de/lmu/ifi/dbs/elki/index/tree/TreeIndexFactory.java b/src/de/lmu/ifi/dbs/elki/index/tree/TreeIndexFactory.java index fc479cba..b55700ec 100644 --- a/src/de/lmu/ifi/dbs/elki/index/tree/TreeIndexFactory.java +++ b/src/de/lmu/ifi/dbs/elki/index/tree/TreeIndexFactory.java @@ -46,11 +46,12 @@ import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.LongParameter; * @author Erich Schubert * * @apiviz.stereotype factory,interface - * @apiviz.uses Index oneway - - «create» + * @apiviz.has Index oneway - - «create» * * @param <O> Object type * @param <I> Index type */ +// TODO: actually, this class should be called PagedIndexFactory? public abstract class TreeIndexFactory<O, I extends Index> implements IndexFactory<O, I> { /** * Optional parameter that specifies the name of the file storing the index. diff --git a/src/de/lmu/ifi/dbs/elki/index/tree/TreeIndexPathComponent.java b/src/de/lmu/ifi/dbs/elki/index/tree/TreeIndexPathComponent.java index 1cc170f3..2309c7e5 100644 --- a/src/de/lmu/ifi/dbs/elki/index/tree/TreeIndexPathComponent.java +++ b/src/de/lmu/ifi/dbs/elki/index/tree/TreeIndexPathComponent.java @@ -30,6 +30,9 @@ package de.lmu.ifi.dbs.elki.index.tree; * index of the component in its parent. * * @author Elke Achtert + * + * @apiviz.uses Entry oneway - - «references» + * * @param <E> the type of Entry used in the index */ public class TreeIndexPathComponent<E extends Entry> { diff --git a/src/de/lmu/ifi/dbs/elki/index/tree/metrical/mtreevariants/mktrees/mkapp/MkAppEntry.java b/src/de/lmu/ifi/dbs/elki/index/tree/metrical/mtreevariants/mktrees/mkapp/MkAppEntry.java index cc56d1fb..ef50e3bc 100644 --- a/src/de/lmu/ifi/dbs/elki/index/tree/metrical/mtreevariants/mktrees/mkapp/MkAppEntry.java +++ b/src/de/lmu/ifi/dbs/elki/index/tree/metrical/mtreevariants/mktrees/mkapp/MkAppEntry.java @@ -32,10 +32,10 @@ import de.lmu.ifi.dbs.elki.index.tree.metrical.mtreevariants.MTreeEntry; * provided. * * @author Elke Achtert + * + * @apiviz.composedOf PolynomialApproximation */ - interface MkAppEntry<D extends NumberDistance<D, ?>> extends MTreeEntry<D> { - /** * Returns the approximated value at the specified k. * @@ -57,4 +57,4 @@ interface MkAppEntry<D extends NumberDistance<D, ?>> extends MTreeEntry<D> { * @param approximation the polynomial approximation to be set */ public void setKnnDistanceApproximation(PolynomialApproximation approximation); -} +}
\ No newline at end of file diff --git a/src/de/lmu/ifi/dbs/elki/index/tree/metrical/mtreevariants/mktrees/mkcop/ConvexHull.java b/src/de/lmu/ifi/dbs/elki/index/tree/metrical/mtreevariants/mktrees/mkcop/ConvexHull.java index d87986cb..7924c13d 100644 --- a/src/de/lmu/ifi/dbs/elki/index/tree/metrical/mtreevariants/mktrees/mkcop/ConvexHull.java +++ b/src/de/lmu/ifi/dbs/elki/index/tree/metrical/mtreevariants/mktrees/mkcop/ConvexHull.java @@ -23,7 +23,6 @@ package de.lmu.ifi.dbs.elki.index.tree.metrical.mtreevariants.mktrees.mkcop; along with this program. If not, see <http://www.gnu.org/licenses/>. */ - /** * Holds the lower and upper hull for some values. * diff --git a/src/de/lmu/ifi/dbs/elki/index/tree/metrical/mtreevariants/mktrees/mkcop/MkCoPEntry.java b/src/de/lmu/ifi/dbs/elki/index/tree/metrical/mtreevariants/mktrees/mkcop/MkCoPEntry.java index bdc83f17..cd1155c3 100644 --- a/src/de/lmu/ifi/dbs/elki/index/tree/metrical/mtreevariants/mktrees/mkcop/MkCoPEntry.java +++ b/src/de/lmu/ifi/dbs/elki/index/tree/metrical/mtreevariants/mktrees/mkcop/MkCoPEntry.java @@ -28,19 +28,21 @@ import de.lmu.ifi.dbs.elki.distance.distancevalue.NumberDistance; import de.lmu.ifi.dbs.elki.index.tree.metrical.mtreevariants.MTreeEntry; /** - * Defines the requirements for an entry in an MkCop-Tree node. - * Additionally to an entry in an M-Tree conservative approximation of the - * knn distances is provided. - * - * @author Elke Achtert + * Defines the requirements for an entry in an MkCop-Tree node. Additionally to + * an entry in an M-Tree conservative approximation of the knn distances is + * provided. + * + * @author Elke Achtert + * + * @apiviz.composedOf ApproximationLine */ interface MkCoPEntry<D extends NumberDistance<D, ?>> extends MTreeEntry<D> { /** * Returns the conservative approximated knn distance of the entry. - * + * * @param <O> Object type - * @param k the parameter k of the knn distance + * @param k the parameter k of the knn distance * @param distanceFunction the distance function * @return the conservative approximated knn distance of the entry */ @@ -48,15 +50,16 @@ interface MkCoPEntry<D extends NumberDistance<D, ?>> extends MTreeEntry<D> { /** * Returns the conservative approximation line. - * + * * @return the conservative approximation line */ public ApproximationLine getConservativeKnnDistanceApproximation(); /** * Sets the conservative approximation line - * - * @param conservativeApproximation the conservative approximation line to be set + * + * @param conservativeApproximation the conservative approximation line to be + * set */ public void setConservativeKnnDistanceApproximation(ApproximationLine conservativeApproximation); -} +}
\ No newline at end of file diff --git a/src/de/lmu/ifi/dbs/elki/index/tree/metrical/mtreevariants/mktrees/mkcop/MkCoPTree.java b/src/de/lmu/ifi/dbs/elki/index/tree/metrical/mtreevariants/mktrees/mkcop/MkCoPTree.java index e6abc753..a2f684ad 100644 --- a/src/de/lmu/ifi/dbs/elki/index/tree/metrical/mtreevariants/mktrees/mkcop/MkCoPTree.java +++ b/src/de/lmu/ifi/dbs/elki/index/tree/metrical/mtreevariants/mktrees/mkcop/MkCoPTree.java @@ -57,6 +57,7 @@ import de.lmu.ifi.dbs.elki.utilities.datastructures.heap.UpdatableHeap; * @author Elke Achtert * * @apiviz.has MkCoPTreeNode oneway - - contains + * @apiviz.uses ConvexHull * * @param <O> Object type * @param <D> Distance type |