Updates deps, better Javadoc

vsonnier · Oct 25, 2014 · 6157110 · 6157110
1 parent 8b03c76
commit 6157110
Show file tree

Hide file tree

Showing 9 changed files with 99 additions and 63 deletions.
diff --git a/CHANGES b/CHANGES
@@ -3,7 +3,7 @@
 
 HPPCRT-29 : Regression: setDefaultValue() method absent from v0.66 IndexedHeaps
 
-HPPCRT-30: ObjectOpen[VType]HashMap.putOrAdd() wrong in Robin-Hood version
+HPPCRT-30: Object[VType]OpenHashMap.putOrAdd() wrong in Robin-Hood version
 
 ** New features
 

diff --git a/hppcrt-core/pom.xml b/hppcrt-core/pom.xml
@@ -95,7 +95,7 @@
             <phase>generate-sources</phase>
             <configuration>
                 <fork>true</fork>
-                <meminitial>50m</meminitial>
+                <meminitial>256m</meminitial>
                 <maxmem>512m</maxmem>
               <target> 
                 <property name="classpath" refid="maven.plugin.classpath" />
@@ -228,7 +228,7 @@
               </excludes>
 
               <parallelism>auto</parallelism>
-              <maxMemory>500m</maxMemory>
+              <maxMemory>400m</maxMemory>
 
               <!-- Attach a simple listener. -->
               <listeners>

diff --git a/hppcrt-core/src/main/templates/com/carrotsearch/hppcrt/heaps/KTypeHeapPriorityQueue.java b/hppcrt-core/src/main/templates/com/carrotsearch/hppcrt/heaps/KTypeHeapPriorityQueue.java
@@ -12,8 +12,8 @@
  * A Heap-based, min-priority queue of <code>KType</code>s.
  * i.e. top() is the smallest element,
  * as defined by Sedgewick: Algorithms 4th Edition (2011).
- * It assure O(log(N)) complexity for insertion,  deletion and update priority of the first element,
- * and constant time to examine the first element by {@link #top()}.
+ * It assure O(log(N)) complexity for insertion,  deletion and update priority of the min element,
+ * and constant time to examine the min element by {@link #top()}.
  * <p><b>Important: </b>
  * Ordering of elements must be defined either
  * #if ($TemplateOptions.KTypeGeneric)
@@ -482,7 +482,7 @@ public KType popTop()
                 /*! #if ($TemplateOptions.KTypeGeneric) !*/
                 this.buffer[1] = Intrinsics.<KType> defaultKTypeValue();
                 /*! #end !*/
-                //diminuish size
+                //diminish size
                 this.elementsCount = 0;
             }
             else
@@ -497,7 +497,7 @@ public KType popTop()
                 this.buffer[this.elementsCount] = Intrinsics.<KType> defaultKTypeValue();
                 /*! #end !*/
 
-                //diminuish size
+                //diminish size
                 this.elementsCount--;
 
                 //percolate down the first element
@@ -734,8 +734,8 @@ public KType[] toArray(final KType[] target)
     /*! #if ($TemplateOptions.KTypeGeneric) !*/
     public Comparator<? super KType>
             /*! #else
-                                                                            public KTypeComparator<? super KType>
-                                                                            #end !*/
+                                                                                    public KTypeComparator<? super KType>
+                                                                                    #end !*/
             comparator() {
 
         return this.comparator;

diff --git a/...-core/src/main/templates/com/carrotsearch/hppcrt/heaps/KTypeIndexedHeapPriorityQueue.java b/...-core/src/main/templates/com/carrotsearch/hppcrt/heaps/KTypeIndexedHeapPriorityQueue.java
@@ -14,7 +14,7 @@
  * as defined by Sedgewick: Algorithms 4th Edition (2011).
  * This class is also a {@link IntKTypeMap}, and acts like a (K,V) = (int, KType) map with >= 0 keys.
  * It assures O(log(N)) complexity for insertion, deletion, updating priorities,
- * and constant time to examine the first element by {@link #top()} and for {@link #containsKey(int)}.
+ * and constant time to examine the min element by {@link #top()} and for {@link #containsKey(int)}.
  * <p><b>Important: </b>
  * Ordering of elements must be defined either
  * #if ($TemplateOptions.KTypeGeneric)
@@ -150,7 +150,7 @@ public void reset(final EntryIterator obj)
      * @see BoundedProportionalArraySizingStrategy
      */
     public KTypeIndexedHeapPriorityQueue(/*! #if ($TemplateOptions.KTypeGeneric) !*/final Comparator<? super KType> comp
-    /*! #else
+            /*! #else
     KTypeComparator<? super KType> comp
     #end !*/)
     {
@@ -1499,10 +1499,10 @@ public void setDefaultValue(final KType defaultValue)
      */
 /*! #if ($TemplateOptions.KTypeGeneric) !*/
     public Comparator<? super KType>
-            /*! #else
+    /*! #else
                                                                                     public KTypeComparator<? super KType>
                                                                                     #end !*/
-            comparator() {
+    comparator() {
 
         return this.comparator;
     }
@@ -1659,22 +1659,22 @@ private void swimComparable(int k)
             //swap k and its parent
             parent = k >> 1;
 
-            //swap k and parent
-            tmp = buffer[k];
-            buffer[k] = buffer[parent];
-            buffer[parent] = tmp;
+        //swap k and parent
+        tmp = buffer[k];
+        buffer[k] = buffer[parent];
+        buffer[parent] = tmp;
 
-            //swap references
-            indexK = qp[k];
-            indexParent = qp[parent];
+        //swap references
+        indexK = qp[k];
+        indexParent = qp[parent];
 
-            pq[indexK] = parent;
-            pq[indexParent] = k;
+        pq[indexK] = parent;
+        pq[indexParent] = k;
 
-            qp[k] = indexParent;
-            qp[parent] = indexK;
+        qp[k] = indexParent;
+        qp[parent] = indexK;
 
-            k = parent;
+        k = parent;
         }
     }
 
@@ -1703,22 +1703,22 @@ private void swimComparator(int k)
             //swap k and its parent
             parent = k >> 1;
 
-            //swap k and parent
-            tmp = buffer[k];
-            buffer[k] = buffer[parent];
-            buffer[parent] = tmp;
+        //swap k and parent
+        tmp = buffer[k];
+        buffer[k] = buffer[parent];
+        buffer[parent] = tmp;
 
-            //swap references
-            indexK = qp[k];
-            indexParent = qp[parent];
+        //swap references
+        indexK = qp[k];
+        indexParent = qp[parent];
 
-            pq[indexK] = parent;
-            pq[indexParent] = k;
+        pq[indexK] = parent;
+        pq[indexParent] = k;
 
-            qp[k] = indexParent;
-            qp[parent] = indexK;
+        qp[k] = indexParent;
+        qp[parent] = indexK;
 
-            k = parent;
+        k = parent;
         }
     }
 

diff --git a/hppcrt-core/src/main/templates/com/carrotsearch/hppcrt/maps/KTypeVTypeOpenHashMap.java b/hppcrt-core/src/main/templates/com/carrotsearch/hppcrt/maps/KTypeVTypeOpenHashMap.java
@@ -163,15 +163,28 @@ public class KTypeVTypeOpenHashMap<KType, VType>
     /*! #end !*/
     /*! #if ($RH) !*/
     public int[] allocated;
-    /*! #elseif ($SA)
-     //True if key = 0 is in the map.
-     public boolean allocatedDefaultKey = false;
-     //if allocatedDefaultKey = true, contains the associated V to the key = 0
-     public VType defaultKeyValue;
-    #else
+    /*! #elseif (!$SA)
     public boolean[] allocated;
     #end !*/
 
+    /**
+     #if ($SA)
+     *True if key = 0 is in the map.
+     #end
+     */
+    /*! #if ($SA)
+    public boolean allocatedDefaultKey = false;
+    #end !*/
+
+    /**
+     #if ($SA)
+     * if allocatedDefaultKey = true, contains the associated V to the key = 0
+     #end
+     */
+    /*! #if ($SA)
+    public VType defaultKeyValue;
+    #end !*/
+
     /**
      * Cached number of assigned slots in {@link #keys}.
      */

diff --git a/...t-core/src/main/templates/com/carrotsearch/hppcrt/maps/KTypeVTypeOpenIdentityHashMap.java b/...t-core/src/main/templates/com/carrotsearch/hppcrt/maps/KTypeVTypeOpenIdentityHashMap.java
@@ -37,7 +37,7 @@
  */
 /*! ${TemplateOptions.generatedAnnotation} !*/
 public class KTypeVTypeOpenIdentityHashMap<KType, VType>
-        implements KTypeVTypeMap<KType, VType>, Cloneable
+implements KTypeVTypeMap<KType, VType>, Cloneable
 {
     /**
      * Minimum capacity for the map.
@@ -110,12 +110,25 @@ public class KTypeVTypeOpenIdentityHashMap<KType, VType>
      * @see #assigned
      */
     public boolean[] allocated;
-    /*! #else
-    //True if key = null is in the map.
+    /*! #end !*/
+
+    /**
+     #if ($SA)
+     * True if key = null is in the map.
+     #end
+     */
+    /*! #if ($SA)
     public boolean allocatedDefaultKey = false;
-    //if allocatedDefaultKey = true, contains the associated V to the key = 0
+    #end !*/
+
+    /**
+     #if ($SA)
+     * if allocatedDefaultKey = true, contains the associated V to the key = null
+     #end
+     */
+    /*! #if ($SA)
     public VType defaultKeyValue;
-    #end
+     #end !*/
 
     /**
      * Cached number of assigned slots in {@link #keys}.
@@ -1249,7 +1262,7 @@ public KeysContainer keys()
      * A view of the keys inside this hash map.
      */
     public final class KeysContainer
-            extends AbstractKTypeCollection<KType> implements KTypeLookupContainer<KType>
+    extends AbstractKTypeCollection<KType> implements KTypeLookupContainer<KType>
     {
         private final KTypeVTypeOpenIdentityHashMap<KType, VType> owner =
                 KTypeVTypeOpenIdentityHashMap.this;
@@ -1851,7 +1864,7 @@ public KTypeVTypeOpenIdentityHashMap<KType, VType> clone()
         @SuppressWarnings("unchecked")
         final/* #end */
         KTypeVTypeOpenIdentityHashMap<KType, VType> cloned =
-                new KTypeVTypeOpenIdentityHashMap<KType, VType>(this.size(), this.loadFactor);
+        new KTypeVTypeOpenIdentityHashMap<KType, VType>(this.size(), this.loadFactor);
 
         cloned.putAll(this);
 

diff --git a/hppcrt-core/src/main/templates/com/carrotsearch/hppcrt/sets/KTypeOpenHashSet.java b/hppcrt-core/src/main/templates/com/carrotsearch/hppcrt/sets/KTypeOpenHashSet.java
@@ -76,8 +76,8 @@
  */
 /*! ${TemplateOptions.generatedAnnotation} !*/
 public class KTypeOpenHashSet<KType>
-extends AbstractKTypeCollection<KType>
-implements KTypeLookupContainer<KType>, KTypeSet<KType>, Cloneable
+        extends AbstractKTypeCollection<KType>
+        implements KTypeLookupContainer<KType>, KTypeSet<KType>, Cloneable
 {
     /**
      * Minimum capacity for the map.
@@ -136,13 +136,19 @@ public class KTypeOpenHashSet<KType>
     /*! #end !*/
     /*! #if ($RH) !*/
     public int[] allocated;
-    /*! #elseif ($SA)
-     //True if key = 0 is in the set.
-     public boolean allocatedDefaultKey = false;
-    #else
+    /*! #elseif (!$SA)
     public boolean[] allocated;
     #end !*/
 
+    /**
+     #if ($SA)
+     * True if key = 0 is in the map.
+     #end
+     */
+    /*! #if ($SA)
+    public boolean allocatedDefaultKey = false;
+    #end !*/
+
     /**
      * Cached number of assigned slots in {@link #keys}.
      */

diff --git a/hppcrt-core/src/main/templates/com/carrotsearch/hppcrt/sets/KTypeOpenIdentityHashSet.java b/hppcrt-core/src/main/templates/com/carrotsearch/hppcrt/sets/KTypeOpenIdentityHashSet.java
@@ -94,12 +94,16 @@ public class KTypeOpenIdentityHashSet<KType>
      * or empty.
      * @see #assigned
      */
-    /*! #end !*/
-    /*! #if (!$SA) !*/
     public boolean[] allocated;
-    /*! #else
-     //True if key = null is in the set.
-     public boolean allocatedDefaultKey = false;
+    /*! #end !*/
+
+    /**
+     #if ($SA)
+     * True if key = null is in the map.
+     #end
+     */
+    /*! #if ($SA)
+    public boolean allocatedDefaultKey = false;
     #end !*/
 
     /**

diff --git a/pom.xml b/pom.xml
@@ -114,7 +114,7 @@
         <plugin>
           <groupId>org.apache.maven.plugins</groupId>
           <artifactId>maven-compiler-plugin</artifactId>
-          <version>3.1</version>
+          <version>3.2</version>
         </plugin>
 
 
@@ -207,7 +207,7 @@
         <plugin>
           <groupId>org.apache.maven.plugins</groupId>
           <artifactId>maven-source-plugin</artifactId>
-          <version>2.3</version>
+          <version>2.4</version>
 		   <configuration>
 				<excludes>
 					<exclude>**/KType*</exclude>