diff --git a/src/main/java/ch/ethz/globis/phtree/util/Refs.java b/src/main/java/ch/ethz/globis/phtree/util/Refs.java index 83423a7..efc4157 100644 --- a/src/main/java/ch/ethz/globis/phtree/util/Refs.java +++ b/src/main/java/ch/ethz/globis/phtree/util/Refs.java @@ -141,7 +141,7 @@ public static T[] arrayCreate(int size) { * @return Same array or expanded array. * @param array type */ - @Deprecated + // TODO remove? was @Deprecated public static T[] arrayEnsureSize(T[] oldA, int requiredSize) { if (isCapacitySufficient(oldA, requiredSize)) { return oldA; @@ -178,8 +178,8 @@ public static T[] arrayClone(T[] oldA) { private static boolean isCapacitySufficient(T[] a, int requiredSize) { return a.length >= requiredSize; } - - @Deprecated + + // TODO remove? was @Deprecated @SuppressWarnings("unchecked") public static T[] arrayTrim(T[] oldA, int requiredSize) { int reqSize = calcArraySize(requiredSize); @@ -192,7 +192,7 @@ public static T[] arrayTrim(T[] oldA, int requiredSize) { return newA; } - @Deprecated + // TODO remove? was @Deprecated public static void insertAtPos(T[] values, int pos, T value) { copyRight(values, pos, values, pos+1, values.length-pos-1); values[pos] = value; @@ -217,8 +217,8 @@ public static T[] insertSpaceAtPos(T[] values, int pos, int requiredSize) { copyRight(values, pos, dst, pos+1, requiredSize-1-pos); return dst; } - - @Deprecated + + // TODO remove? was @Deprecated public static void removeAtPos(T[] values, int pos) { if (pos < values.length-1) { copyLeft(values, pos+1, values, pos, values.length-pos-1); diff --git a/src/main/java/ch/ethz/globis/phtree/v11/NodeIteratorListReuse.java b/src/main/java/ch/ethz/globis/phtree/v11/NodeIteratorListReuse.java index aba4250..bea6a11 100644 --- a/src/main/java/ch/ethz/globis/phtree/v11/NodeIteratorListReuse.java +++ b/src/main/java/ch/ethz/globis/phtree/v11/NodeIteratorListReuse.java @@ -72,14 +72,9 @@ private final class NodeIterator { /** * - * @param node - * @param dims - * @param valTemplate A null indicates that no values are to be extracted. + * @param node node * @param lower The minimum HC-Pos that a value should have. - * @param upper - * @param minValue The minimum value that any found value should have. - * If the found value is lower, the search continues. - * @param maxValue + * @param upper The maximum HC-Pos that a value should have. */ void reinitAndRun(Node node, long lower, long upper) { this.node = node; diff --git a/src/main/java/ch/ethz/globis/phtree/v8/Node.java b/src/main/java/ch/ethz/globis/phtree/v8/Node.java index b3384d3..a79ae6a 100644 --- a/src/main/java/ch/ethz/globis/phtree/v8/Node.java +++ b/src/main/java/ch/ethz/globis/phtree/v8/Node.java @@ -487,8 +487,9 @@ void removeSub(long pos, final int DIM) { /** * Compare two post-fixes. Takes as parameter not the position but the post-offset-bits. - * @param pob - * @param key + * @param offsPostKey offsPostKey + * @param hcPos hcPos + * @param key key * @return true, if the post-fixes match */ boolean postEqualsPOB(int offsPostKey, long hcPos, long[] key) { @@ -953,10 +954,12 @@ T getPostPOB(int offsPostKey, long pos, long[] key) { /** * Get post-fix. - * @param offsPostKey - * @param key - * @param range After the method call, this contains the postfix if the postfix matches the - * range. Otherwise it contains only part of the postfix. + * @param offsPostKey offsPostKey + * @param hcPos hcPos + * @param key key + * @param rangeMin After the method call, this contains the postfix if the postfix matches + * the range. Otherwise it contains only part of the postfix. + * @param rangeMax rangeMax * @return NodeEntry if the postfix matches the range, otherwise null. * @Deprecated Use next method instead. */ @@ -984,10 +987,12 @@ NodeEntry getPostPOB(int offsPostKey, long hcPos, long[] key, /** * Get post-fix. - * @param offsPostKey - * @param key - * @param range After the method call, this contains the postfix if the postfix matches the + * @param offsPostKey offsPostKey + * @param hcPos hcPos + * @param e entry + * @param rangeMin After the method call, this contains the postfix if the postfix matches the * range. Otherwise it contains only part of the postfix. + * @param rangeMax rangeMax * @return NodeEntry if the postfix matches the range, otherwise null. */ boolean getPostPOB(int offsPostKey, long hcPos, PhEntry e, @@ -1041,10 +1046,15 @@ NodeEntry getPostPOB_E(int offsPostKey, long hcPos, long[] key) { /** * Get post-fix. - * @param offsPostKey - * @param key - * @param range After the method call, this contains the postfix if the postfix matches the - * range. Otherwise it contains only part of the postfix. + * @param offsPostKey offsPostKey + * @param hcPos hcPos + * @param DIM dim + * @param valTemplate valTemplate + * @param rangeMin After the method call, this contains the postfix if the postfix matches + * the range. Otherwise it contains only part of the postfix. + * @param rangeMax rangeMax + * @param minToCheck minToCheck + * @param maxToCheck maxToCheck * @return true, if the postfix matches the range. */ @SuppressWarnings("unchecked") @@ -1430,14 +1440,6 @@ int getBitPos_Infix() { return HC_BITS;// + DIM+1 + DIM+1; } - /** - * - * @param offs - * @param pos - * @param DIM - * @param bufSubCnt use -1 to have it calculated by this method - * @return - */ private int offs2ValPos(int offs, long pos, int DIM) { if (isPostHC()) { return (int) pos; @@ -1453,8 +1455,8 @@ private int offs2ValPos(int offs, long pos, int DIM) { /** * - * @param pos - * @param DIM + * @param pos position + * @param DIM dim * @return The position (in bits) of the postfix VALUE. For LHC, the key is stored * directly before the value. */ diff --git a/src/main/java/ch/ethz/globis/phtree/v8/NodeIteratorListReuse.java b/src/main/java/ch/ethz/globis/phtree/v8/NodeIteratorListReuse.java index 1f03ea4..88f13f1 100644 --- a/src/main/java/ch/ethz/globis/phtree/v8/NodeIteratorListReuse.java +++ b/src/main/java/ch/ethz/globis/phtree/v8/NodeIteratorListReuse.java @@ -96,14 +96,9 @@ private final class NodeIterator { /** * - * @param node - * @param DIM - * @param valTemplate A null indicates that no values are to be extracted. + * @param node node * @param lower The minimum HC-Pos that a value should have. - * @param upper - * @param minValue The minimum value that any found value should have. If the found value is - * lower, the search continues. - * @param maxValue + * @param upper The maximum HC-Pos that a value should have. */ void reinitAndRun(Node node, long lower, long upper) { this.node = node; diff --git a/src/main/java/org/zoodb/index/critbit/CritBit.java b/src/main/java/org/zoodb/index/critbit/CritBit.java index 1177381..5db58cf 100644 --- a/src/main/java/org/zoodb/index/critbit/CritBit.java +++ b/src/main/java/org/zoodb/index/critbit/CritBit.java @@ -2004,7 +2004,7 @@ private void unsetBitAfterSplit(long[] keyOrigTemplate, int posBitInt) { /** * Full comparison on the parameter. Assigns the parameter to 'nextKey' if comparison * fits. - * @param keyTemplate keyTemplate + * @param keyOrigTemplate keyOrigTemplate * @return Whether we have a match or not */ private boolean checkMatchOrigKDFullIntoNextVal(long[] keyOrigTemplate, V value) { @@ -2092,11 +2092,11 @@ private void readPostFixAndSplit(long[] postVal, int posFirstBit, long[] current } /** - * - * @param src Interleaved src array + * QUESTIONS: TZ: hack: I fixed the javadoc errors without checking if the javadoc is correct! + * @param srcVal Interleaved(?) src array * @param posFirstBit First bit to be transferred * @param stopBit Stop bit (last bit to be transferred + 1) - * @param dst Non-interleaved destination array + * @param dstVal Non-interleaved(?) destination array */ private void readAndSplit(long[] srcVal, int posFirstBit, long stopBit, long[] dstVal) { long maskSrc = 0x8000000000000000L >>> (posFirstBit & 0x3F); diff --git a/src/main/java/org/zoodb/index/critbit/CritBit64.java b/src/main/java/org/zoodb/index/critbit/CritBit64.java index e0c7069..f0b4f25 100644 --- a/src/main/java/org/zoodb/index/critbit/CritBit64.java +++ b/src/main/java/org/zoodb/index/critbit/CritBit64.java @@ -333,9 +333,9 @@ private static long extractPrefix(long v, int endPos) { } /** - * + * @param posDiff posDIff * @param v key - * @param startPos start position + * @param prefix prefix * @return True if the prefix matches the value or if no prefix is defined */ private boolean doesPrefixMatch(int posDiff, long v, long prefix) {