Expose trimToSize in all primitive maps and sets

- only trim when necessary - also deprecate compact() Signed-off-by: Victor Noël <victor.noel@brennus-analytics.com>
eclipse · Jan 12, 2023 · d98a770 · d98a770
1 parent c618acd
commit d98a770
Show file tree

Hide file tree

Showing 8 changed files with 130 additions and 0 deletions.
diff --git a/...collections-code-generator/src/main/resources/impl/map/mutable/objectPrimitiveHashMap.stg b/...collections-code-generator/src/main/resources/impl/map/mutable/objectPrimitiveHashMap.stg
@@ -1211,9 +1211,26 @@ public class Object<name>HashMap\<K> implements MutableObject<name>Map\<K>, Exte
     }
     <endif>
 
+    /**
+    * @since 12.0
+    */
+    public boolean trimToSize()
+    {
+        int newCapacity = this.smallestPowerOfTwoGreaterThan(this.size());
+        if (this.keys.length > newCapacity)
+        {
+            this.rehash(newCapacity);
+            return true;
+        }
+        return false;
+    }
+
     /**
      * Rehashes every element in the set into a new backing table of the smallest possible size and eliminating removed sentinels.
+     *
+     * @deprecated since 12.0 - Use {@link #trimToSize()} instead
      */
+    @Deprecated
     public void compact()
     {
         this.rehash(this.smallestPowerOfTwoGreaterThan(this.size()));

diff --git a/...nerator/src/main/resources/impl/map/mutable/objectPrimitiveHashMapWithHashingStrategy.stg b/...nerator/src/main/resources/impl/map/mutable/objectPrimitiveHashMapWithHashingStrategy.stg
@@ -1238,9 +1238,26 @@ public class Object<name>HashMapWithHashingStrategy\<K> implements MutableObject
     }
     <endif>
 
+    /**
+    * @since 12.0
+    */
+    public boolean trimToSize()
+    {
+        int newCapacity = this.smallestPowerOfTwoGreaterThan(this.size());
+        if (this.keys.length > newCapacity)
+        {
+            this.rehash(newCapacity);
+            return true;
+        }
+        return false;
+    }
+
     /**
      * Rehashes every element in the set into a new backing table of the smallest possible size and eliminating removed sentinels.
+     *
+     * @deprecated since 12.0 - Use {@link #trimToSize()} instead
      */
+    @Deprecated
     public void compact()
     {
         this.rehash(this.smallestPowerOfTwoGreaterThan(this.size()));

diff --git a/...ollections-code-generator/src/main/resources/impl/map/mutable/primitiveBooleanHashMap.stg b/...ollections-code-generator/src/main/resources/impl/map/mutable/primitiveBooleanHashMap.stg
@@ -289,9 +289,26 @@ public class <name>BooleanHashMap extends AbstractMutableBooleanValuesMap implem
         this.values = new BitSet(sizeToAllocate);
     }
 
+    /**
+    * @since 12.0
+    */
+    public boolean trimToSize()
+    {
+        int newCapacity = this.smallestPowerOfTwoGreaterThan(this.size());
+        if (this.keys.length > newCapacity)
+        {
+            this.rehash(newCapacity);
+            return true;
+        }
+        return false;
+    }
+
     /**
      * Rehashes every element in the set into a new backing table of the smallest possible size and eliminating removed sentinels.
+     *
+     * @deprecated since 12.0 - Use {@link #trimToSize()} instead
      */
+    @Deprecated
     public void compact()
     {
         this.rehash(this.smallestPowerOfTwoGreaterThan(this.size()));

diff --git a/...collections-code-generator/src/main/resources/impl/map/mutable/primitiveObjectHashMap.stg b/...collections-code-generator/src/main/resources/impl/map/mutable/primitiveObjectHashMap.stg
@@ -2910,9 +2910,26 @@ public class <name>ObjectHashMap\<V> implements Mutable<name>ObjectMap\<V>, Exte
         return new KeySet();
     }
 
+    /**
+    * @since 12.0
+    */
+    public boolean trimToSize()
+    {
+        int newCapacity = this.smallestPowerOfTwoGreaterThan(this.size());
+        if (this.keys.length > newCapacity)
+        {
+            this.rehash(newCapacity);
+            return true;
+        }
+        return false;
+    }
+
     /**
      * Rehashes every element in the set into a new backing table of the smallest possible size and eliminating removed sentinels.
+     *
+     * @deprecated since 12.0 - Use {@link #trimToSize()} instead
      */
+    @Deprecated
     public void compact()
     {
         this.rehash(this.smallestPowerOfTwoGreaterThan(this.size()));

diff --git a/...lections-code-generator/src/main/resources/impl/map/mutable/primitivePrimitiveHashMap.stg b/...lections-code-generator/src/main/resources/impl/map/mutable/primitivePrimitiveHashMap.stg
@@ -954,9 +954,26 @@ public class <name1><name2>HashMap extends AbstractMutable<name2>ValuesMap imple
         }
     }
 
+    /**
+    * @since 12.0
+    */
+    public boolean trimToSize()
+    {
+        int newCapacity = this.smallestPowerOfTwoGreaterThan(this.size());
+        if (this.<keyArray>.length > newCapacity)
+        {
+            this.rehash(newCapacity);
+            return true;
+        }
+        return false;
+    }
+
     /**
      * Rehashes every element in the set into a new backing table of the smallest possible size and eliminating removed sentinels.
+     *
+     * @deprecated since 12.0 - Use {@link #trimToSize()} instead
      */
+    @Deprecated
     public void compact()
     {
         this.rehash(this.smallestPowerOfTwoGreaterThan(this.size()));

diff --git a/eclipse-collections-code-generator/src/main/resources/impl/set/mutable/primitiveHashSet.stg b/eclipse-collections-code-generator/src/main/resources/impl/set/mutable/primitiveHashSet.stg
@@ -942,9 +942,26 @@ public class <name>HashSet extends Abstract<name>Set implements Mutable<name>Set
         return new <name>HashSet();
     }
 
+    /**
+    * @since 12.0
+    */
+    public boolean trimToSize()
+    {
+        int newCapacity = this.smallestPowerOfTwoGreaterThan(this.size());
+        if (this.table.length > newCapacity)
+        {
+            this.rehash(newCapacity);
+            return true;
+        }
+        return false;
+    }
+
     /**
      * Rehashes every element in the set into a new backing table of the smallest possible size and eliminating removed sentinels.
+     *
+     * @deprecated since 12.0 - Use {@link #trimToSize()} instead
      */
+    @Deprecated
     public void compact()
     {
         this.rehash(this.smallestPowerOfTwoGreaterThan(this.size()));

diff --git a/...rc/main/java/org/eclipse/collections/impl/map/mutable/primitive/ObjectBooleanHashMap.java b/...rc/main/java/org/eclipse/collections/impl/map/mutable/primitive/ObjectBooleanHashMap.java
@@ -1109,6 +1109,20 @@ private int maxOccupiedWithData()
         return Math.min(capacity - 1, capacity / OCCUPIED_DATA_RATIO);
     }
 
+    /**
+    * @since 12.0
+    */
+    public boolean trimToSize()
+    {
+        int newCapacity = this.smallestPowerOfTwoGreaterThan(this.size());
+        if (this.keys.length > newCapacity)
+        {
+            this.rehash(newCapacity);
+            return true;
+        }
+        return false;
+    }
+
     private void rehashAndGrow()
     {
         this.rehash(this.keys.length << 1);

diff --git a/...lipse/collections/impl/map/mutable/primitive/ObjectBooleanHashMapWithHashingStrategy.java b/...lipse/collections/impl/map/mutable/primitive/ObjectBooleanHashMapWithHashingStrategy.java
@@ -1132,6 +1132,20 @@ private int maxOccupiedWithData()
         return Math.min(capacity - 1, capacity / OCCUPIED_DATA_RATIO);
     }
 
+    /**
+    * @since 12.0
+    */
+    public boolean trimToSize()
+    {
+        int newCapacity = this.smallestPowerOfTwoGreaterThan(this.size());
+        if (this.keys.length > newCapacity)
+        {
+            this.rehash(newCapacity);
+            return true;
+        }
+        return false;
+    }
+
     private void rehashAndGrow()
     {
         this.rehash(this.keys.length << 1);