Package org.eclipse.collections.impl.map.mutable.primitive

Class SynchronizedDoubleDoubleMap

java.lang.Object
org.eclipse.collections.impl.map.mutable.primitive.SynchronizedDoubleDoubleMap
All Implemented Interfaces:
Serializable, DoubleIterable, DoubleDoubleMap, DoubleValuesMap, MutableDoubleDoubleMap, MutableDoubleValuesMap, PrimitiveIterable
public class SynchronizedDoubleDoubleMap extends Object implements MutableDoubleDoubleMap, Serializable
A synchronized view of a MutableDoubleDoubleMap. It is imperative that the user manually synchronize on the collection when iterating over it using the MutableDoubleIterator as per Collections.synchronizedCollection(Collection).

This file was automatically generated from template file synchronizedPrimitivePrimitiveMap.stg.

Since:
3.1.
See Also:

  • Constructor Details

  • Method Details

    • clear

      public void clear()
      Description copied from interface: MutableDoubleValuesMap
      Removes all entries from this map.
      Specified by:
      clear in interface MutableDoubleValuesMap

    • put

      public void put(double key, double value)
      Description copied from interface: MutableDoubleDoubleMap
      Associates a value with the specified key. If a value is already associated with the key in this map, it will be replaced with value.
      Specified by:
      put in interface MutableDoubleDoubleMap
      Parameters:
      key - the key
      value - the value to associate with value

    • putPair

      public void putPair(DoubleDoublePair keyValuePair)
      Description copied from interface: MutableDoubleDoubleMap
      This method allows MutableDoubleDoubleMap the ability to add an element in the form of DoubleDoublePair.
      Specified by:
      putPair in interface MutableDoubleDoubleMap
      See Also:

    • putAll

      public void putAll(DoubleDoubleMap map)
      Description copied from interface: MutableDoubleDoubleMap
      Puts all of the key/value mappings from the specified map into this map. If this map already has a value associated with one of the keys in the map, it will be replaced with the value in map.
      Specified by:
      putAll in interface MutableDoubleDoubleMap
      Parameters:
      map - the map to copy into this map

    • updateValues

      public void updateValues(DoubleDoubleToDoubleFunction function)
      Description copied from interface: MutableDoubleDoubleMap
      Updates the values in-place.
      Specified by:
      updateValues in interface MutableDoubleDoubleMap
      Parameters:
      function - that takes a key and its value and that returns a new value for this key

    • removeKey

      public void removeKey(double key)
      Description copied from interface: MutableDoubleDoubleMap
      Removes the mapping associated with the key, if one exists, from the map.
      Specified by:
      removeKey in interface MutableDoubleDoubleMap
      Parameters:
      key - the key to remove
      See Also:

    • remove

      public void remove(double key)
      Description copied from interface: MutableDoubleDoubleMap
      Removes the mapping associated with the key, if one exists, from the map.
      Specified by:
      remove in interface MutableDoubleDoubleMap
      Parameters:
      key - the key to remove
      See Also:

    • removeKeyIfAbsent

      public double removeKeyIfAbsent(double key, double value)
      Description copied from interface: MutableDoubleDoubleMap
      Removes the mapping associated with the key, if one exists, from the map, returning the previously associated value with the key. If no mapping existed for the key, the specified default value is returned.
      Specified by:
      removeKeyIfAbsent in interface MutableDoubleDoubleMap
      Parameters:
      key - the key to remove
      value - the default value to return if no mapping for the key exists
      Returns:
      the value previously associated with the key, if one existed, or value if not

    • getIfAbsentPut

      public double getIfAbsentPut(double key, double value)
      Description copied from interface: MutableDoubleDoubleMap
      Retrieves the value associated with the key if one exists; if it does not, associates a value with the key.
      Specified by:
      getIfAbsentPut in interface MutableDoubleDoubleMap
      Parameters:
      key - the key
      value - the value to associate with key if no such mapping exists
      Returns:
      the value associated with key, if one exists, or value if not

    • getIfAbsentPut

      public double getIfAbsentPut(double key, DoubleFunction0 function)
      Description copied from interface: MutableDoubleDoubleMap
      Retrieves the value associated with the key if one exists; if it does not, invokes the supplier and associates the result with the key.
      Specified by:
      getIfAbsentPut in interface MutableDoubleDoubleMap
      Parameters:
      key - the key
      function - the supplier that provides the value if no mapping exists for key
      Returns:
      the value associated with the key, if one exists, or the result of invoking function if not

    • getIfAbsentPutWithKey

      public double getIfAbsentPutWithKey(double key, DoubleToDoubleFunction function)
      Description copied from interface: MutableDoubleDoubleMap
      Retrieves the value associated with the key if one exists; if it does not, associates the result of invoking the value function with the key.
      Specified by:
      getIfAbsentPutWithKey in interface MutableDoubleDoubleMap
      Parameters:
      key - the key
      function - the function that provides the value if no mapping exists. The key will be passed as the argument to the function.
      Returns:
      the value associated with the key, if one exists, or the result of invoking function with key if not

    • getIfAbsentPutWith

      public <P> double getIfAbsentPutWith(double key, DoubleFunction<? super P> function, P parameter)
      Description copied from interface: MutableDoubleDoubleMap
      Retrieves the value associated with the key if one exists; if it does not, invokes the value function with the parameter and associates the result with the key.
      Specified by:
      getIfAbsentPutWith in interface MutableDoubleDoubleMap
      Type Parameters:
      P - the type of the value function's parameter
      Parameters:
      key - the key
      function - the function that provides the value if no mapping exists. The specified parameter will be passed as the argument to the function.
      parameter - the parameter to provide to function if no value exists for key
      Returns:
      the value associated with the key, if one exists, or the result of invoking function with parameter if not

    • updateValue

      public double updateValue(double key, double initialValueIfAbsent, DoubleToDoubleFunction function)
      Description copied from interface: MutableDoubleDoubleMap
      Updates or sets the value associated with the key by applying the function to the existing value, if one exists, or to the specified initial value if one does not.
      Specified by:
      updateValue in interface MutableDoubleDoubleMap
      Parameters:
      key - the key
      initialValueIfAbsent - the initial value to supply to the function if no mapping exists for the key
      function - the function that returns the updated value based on the current value or the initial value, if no value exists
      Returns:
      the new value associated with the key, either as a result of applying function to the value already associated with the key or as a result of applying it to initialValueIfAbsent and associating the result with key

    • get

      public double get(double key)
      Description copied from interface: DoubleDoubleMap
      Retrieves the value associated with the key. If no mapping exists for the key, the default value (usually 0) is returned.
      Specified by:
      get in interface DoubleDoubleMap
      Parameters:
      key - the key
      Returns:
      the value associated with the key, or the default value if no such mapping exists

    • getIfAbsent

      public double getIfAbsent(double key, double ifAbsent)
      Description copied from interface: DoubleDoubleMap
      Retrieves the value associated with the key, returning the specified default value if no such mapping exists.
      Specified by:
      getIfAbsent in interface DoubleDoubleMap
      Parameters:
      key - the key
      ifAbsent - the default value to return if no mapping exists for key
      Returns:
      the value associated with the key, or ifAbsent if no such mapping exists.

    • getOrThrow

      public double getOrThrow(double key)
      Description copied from interface: DoubleDoubleMap
      Retrieves the value associated with the key, throwing an IllegalStateException if no such mapping exists.
      Specified by:
      getOrThrow in interface DoubleDoubleMap
      Parameters:
      key - the key
      Returns:
      the value associated with the key

    • containsKey

      public boolean containsKey(double key)
      Description copied from interface: DoubleDoubleMap
      Returns whether or not the key is present in the map.
      Specified by:
      containsKey in interface DoubleDoubleMap
      Parameters:
      key - the key
      Returns:
      if a mapping exists in this map for the key

    • containsValue

      public boolean containsValue(double value)
      Description copied from interface: DoubleValuesMap
      Returns whether or not this map contains the value.
      Specified by:
      containsValue in interface DoubleValuesMap
      Parameters:
      value - the value to test
      Returns:
      if this collection contains the value

    • forEachValue

      public void forEachValue(DoubleProcedure procedure)
      Description copied from interface: DoubleValuesMap
      Iterates through each value in this map.
      Specified by:
      forEachValue in interface DoubleValuesMap
      Parameters:
      procedure - the procedure to invoke for each value in this map.

    • forEachKey

      public void forEachKey(DoubleProcedure procedure)
      Description copied from interface: DoubleDoubleMap
      Iterates through each key in the map, invoking the procedure for each.
      Specified by:
      forEachKey in interface DoubleDoubleMap
      Parameters:
      procedure - the procedure to invoke for each key

    • forEachKeyValue

      public void forEachKeyValue(DoubleDoubleProcedure procedure)
      Description copied from interface: DoubleDoubleMap
      Iterates through each key/value pair in the map, invoking the procedure for each.
      Specified by:
      forEachKeyValue in interface DoubleDoubleMap
      Parameters:
      procedure - the procedure to invoke for each key/value pair

    • keysView

      public LazyDoubleIterable keysView()
      Description copied from interface: DoubleDoubleMap
      Returns a view of the keys in this map. This iterable is backed by the map, so any modifications to the underlying map will be reflected in the keys returned by the iterable.
      Specified by:
      keysView in interface DoubleDoubleMap
      Returns:
      a view of the keys in this map

    • keyValuesView

      public RichIterable<DoubleDoublePair> keyValuesView()
      Description copied from interface: DoubleDoubleMap
      Returns a view of the key/value pairs in this map. This iterable is backed by the map, so any modifications to the underlying map will be reflected in the pairs returned by the iterable.
      Specified by:
      keyValuesView in interface DoubleDoubleMap
      Returns:
      a view of the keys in this map

    • flipUniqueValues

      public MutableDoubleDoubleMap flipUniqueValues()
      Description copied from interface: DoubleDoubleMap
      Return the DoubleDoubleMap that is obtained by flipping the direction of this map and making the associations from value to key.
      Specified by:
      flipUniqueValues in interface DoubleDoubleMap
      Specified by:
      flipUniqueValues in interface MutableDoubleDoubleMap

    • select

      public MutableDoubleDoubleMap select(DoubleDoublePredicate predicate)
      Description copied from interface: DoubleDoubleMap
      Return a copy of this map containing only the key/value pairs that match the predicate.
      Specified by:
      select in interface DoubleDoubleMap
      Specified by:
      select in interface MutableDoubleDoubleMap
      Parameters:
      predicate - the predicate to determine which key/value pairs in this map should be included in the returned map
      Returns:
      a copy of this map with the matching key/value pairs

    • reject

      public MutableDoubleDoubleMap reject(DoubleDoublePredicate predicate)
      Description copied from interface: DoubleDoubleMap
      Return a copy of this map containing only the key/value pairs that do not match the predicate.
      Specified by:
      reject in interface DoubleDoubleMap
      Specified by:
      reject in interface MutableDoubleDoubleMap
      Parameters:
      predicate - the predicate to determine which key/value pairs in this map should be excluded from the returned map
      Returns:
      a copy of this map without the matching key/value pairs

    • doubleIterator

      public MutableDoubleIterator doubleIterator()
      This must be manually synchronized by the developer.
      Specified by:
      doubleIterator in interface DoubleIterable
      Specified by:
      doubleIterator in interface MutableDoubleValuesMap

    • forEach

      public void forEach(DoubleProcedure procedure)
      Description copied from interface: DoubleIterable
      Applies the DoubleProcedure to each element in the DoubleIterable.
      Specified by:
      forEach in interface DoubleIterable

    • each

      public void each(DoubleProcedure procedure)
      Description copied from interface: DoubleIterable
      A synonym for forEach.
      Specified by:
      each in interface DoubleIterable
      Since:
      7.0.

    • count

      public int count(DoublePredicate predicate)
      Description copied from interface: DoubleIterable
      Returns a count of the number of elements in the DoubleIterable that return true for the specified predicate.
      Specified by:
      count in interface DoubleIterable

    • anySatisfy

      public boolean anySatisfy(DoublePredicate predicate)
      Description copied from interface: DoubleIterable
      Returns true if any of the elements in the DoubleIterable return true for the specified predicate, otherwise returns false.
      Specified by:
      anySatisfy in interface DoubleIterable

    • allSatisfy

      public boolean allSatisfy(DoublePredicate predicate)
      Description copied from interface: DoubleIterable
      Returns true if all of the elements in the DoubleIterable return true for the specified predicate, otherwise returns false.
      Specified by:
      allSatisfy in interface DoubleIterable

    • noneSatisfy

      public boolean noneSatisfy(DoublePredicate predicate)
      Description copied from interface: DoubleIterable
      Returns true if none of the elements in the DoubleIterable return true for the specified predicate, otherwise returns false.
      Specified by:
      noneSatisfy in interface DoubleIterable

    • select

      public MutableDoubleBag select(DoublePredicate predicate)
      Description copied from interface: DoubleIterable
      Returns a new DoubleIterable with all of the elements in the DoubleIterable that return true for the specified predicate.
      Specified by:
      select in interface DoubleIterable
      Specified by:
      select in interface DoubleValuesMap
      Specified by:
      select in interface MutableDoubleValuesMap

    • reject

      public MutableDoubleBag reject(DoublePredicate predicate)
      Description copied from interface: DoubleIterable
      Returns a new DoubleIterable with all of the elements in the DoubleIterable that return false for the specified predicate.
      Specified by:
      reject in interface DoubleIterable
      Specified by:
      reject in interface DoubleValuesMap
      Specified by:
      reject in interface MutableDoubleValuesMap

    • collect

      public <V> MutableBag<V> collect(DoubleToObjectFunction<? extends V> function)
      Description copied from interface: DoubleIterable
      Returns a new collection with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
      Specified by:
      collect in interface DoubleIterable
      Specified by:
      collect in interface DoubleValuesMap
      Specified by:
      collect in interface MutableDoubleValuesMap

    • detectIfNone

      public double detectIfNone(DoublePredicate predicate, double ifNone)
      Specified by:
      detectIfNone in interface DoubleIterable

    • sum

      public double sum()
      Specified by:
      sum in interface DoubleIterable

    • max

      public double max()
      Specified by:
      max in interface DoubleIterable

    • maxIfEmpty

      public double maxIfEmpty(double defaultValue)
      Specified by:
      maxIfEmpty in interface DoubleIterable

    • min

      public double min()
      Specified by:
      min in interface DoubleIterable

    • minIfEmpty

      public double minIfEmpty(double defaultValue)
      Specified by:
      minIfEmpty in interface DoubleIterable

    • average

      public double average()
      Specified by:
      average in interface DoubleIterable

    • median

      public double median()
      Specified by:
      median in interface DoubleIterable

    • addToValue

      public double addToValue(double key, double toBeAdded)
      Description copied from interface: MutableDoubleDoubleMap
      Increments and updates the value associated with the key, if a value exists, or sets the value to be the specified value if one does not.
      Specified by:
      addToValue in interface MutableDoubleDoubleMap
      Parameters:
      key - the key
      toBeAdded - the amount to increment the existing value, if one exists, or to use as the initial value if one does not
      Returns:
      the value after incrementing toBeAdded to the existing value associated with key or toBeAdded if one does not

    • toSortedArray

      public double[] toSortedArray()
      Specified by:
      toSortedArray in interface DoubleIterable

    • toSortedList

      public MutableDoubleList toSortedList()
      Specified by:
      toSortedList in interface DoubleIterable

    • toArray

      public double[] toArray()
      Description copied from interface: DoubleIterable
      Converts the DoubleIterable to a primitive double array.
      Specified by:
      toArray in interface DoubleIterable

    • toArray

      public double[] toArray(double[] target)
      Description copied from interface: DoubleIterable
      Converts the DoubleIterable to a primitive double array. If the collection fits into the provided array it is used to store its elements and is returned from the method, otherwise a new array of the appropriate size is allocated and returned. If the iterable is empty, the target array is returned unchanged.
      Specified by:
      toArray in interface DoubleIterable

    • contains

      public boolean contains(double value)
      Description copied from interface: DoubleIterable
      Returns true if the value is contained in the DoubleIterable, and false if it is not.
      Specified by:
      contains in interface DoubleIterable

    • containsAll

      public boolean containsAll(double... source)
      Description copied from interface: DoubleIterable
      Returns true if all of the values specified in the source array are contained in the DoubleIterable, and false if they are not.
      Specified by:
      containsAll in interface DoubleIterable

    • containsAll

      public boolean containsAll(DoubleIterable source)
      Description copied from interface: DoubleIterable
      Returns true if all of the values specified in the source DoubleIterable are contained in the DoubleIterable, and false if they are not.
      Specified by:
      containsAll in interface DoubleIterable

    • toList

      public MutableDoubleList toList()
      Description copied from interface: DoubleIterable
      Converts the DoubleIterable to a new MutableDoubleList.
      Specified by:
      toList in interface DoubleIterable

    • toSet

      public MutableDoubleSet toSet()
      Description copied from interface: DoubleIterable
      Converts the DoubleIterable to a new MutableDoubleSet.
      Specified by:
      toSet in interface DoubleIterable

    • toBag

      public MutableDoubleBag toBag()
      Description copied from interface: DoubleIterable
      Converts the DoubleIterable to a new MutableDoubleBag.
      Specified by:
      toBag in interface DoubleIterable

    • asLazy

      public LazyDoubleIterable asLazy()
      Description copied from interface: DoubleIterable
      Returns a LazyDoubleIterable adapter wrapping the source DoubleIterable.
      Specified by:
      asLazy in interface DoubleIterable

    • withKeyValue

      public MutableDoubleDoubleMap withKeyValue(double key, double value)
      Description copied from interface: MutableDoubleDoubleMap
      Associates a value with the specified key. If a value is already associated with the key in this map, it will be replaced with value.
      Specified by:
      withKeyValue in interface MutableDoubleDoubleMap
      Parameters:
      key - the key
      value - the value to associate with value
      Returns:
      this map
      See Also:

    • withoutKey

      public MutableDoubleDoubleMap withoutKey(double key)
      Description copied from interface: MutableDoubleDoubleMap
      Removes the mapping associated with the key, if one exists, from this map.
      Specified by:
      withoutKey in interface MutableDoubleDoubleMap
      Parameters:
      key - the key to remove
      Returns:
      this map
      See Also:

    • withoutAllKeys

      public MutableDoubleDoubleMap withoutAllKeys(DoubleIterable keys)
      Description copied from interface: MutableDoubleDoubleMap
      Removes the mappings associated with all the keys, if they exist, from this map.
      Specified by:
      withoutAllKeys in interface MutableDoubleDoubleMap
      Parameters:
      keys - the keys to remove
      Returns:
      this map
      See Also:

    • asUnmodifiable

      public MutableDoubleDoubleMap asUnmodifiable()
      Description copied from interface: MutableDoubleDoubleMap
      Returns an unmodifiable view of this map, delegating all read-only operations to this map and throwing an UnsupportedOperationException for all mutating operations. This avoids the overhead of copying the map when calling DoubleDoubleMap.toImmutable() while still providing immutability.
      Specified by:
      asUnmodifiable in interface MutableDoubleDoubleMap
      Returns:
      an unmodifiable view of this map

    • asSynchronized

      public MutableDoubleDoubleMap asSynchronized()
      Description copied from interface: MutableDoubleDoubleMap
      Returns a synchronized view of this map, delegating all operations to this map but ensuring only one caller has access to the map at a time.
      Specified by:
      asSynchronized in interface MutableDoubleDoubleMap
      Returns:
      a synchronized view of this map

    • toImmutable

      public ImmutableDoubleDoubleMap toImmutable()
      Description copied from interface: DoubleDoubleMap
      Returns a copy of this map that is immutable (if this map is mutable) or itself if it is already immutable.
      Specified by:
      toImmutable in interface DoubleDoubleMap
      Returns:
      an immutable map that is equivalent to this one

    • size

      public int size()
      Description copied from interface: PrimitiveIterable
      Returns the number of items in this iterable.
      Specified by:
      size in interface PrimitiveIterable

    • isEmpty

      public boolean isEmpty()
      Description copied from interface: PrimitiveIterable
      Returns true if this iterable has zero items.
      Specified by:
      isEmpty in interface PrimitiveIterable

    • notEmpty

      public boolean notEmpty()
      Description copied from interface: PrimitiveIterable
      The English equivalent of !this.isEmpty()
      Specified by:
      notEmpty in interface PrimitiveIterable

    • keySet

      public MutableDoubleSet keySet()
      Description copied from interface: DoubleDoubleMap
      Returns a set containing all the keys in this map. The set is backed by the map, so any modifications to the returned set will affect this map.
      Specified by:
      keySet in interface DoubleDoubleMap
      Returns:
      a mutable set containing the keys in this map

    • values

      public MutableDoubleCollection values()
      Description copied from interface: DoubleValuesMap
      Returns the values in this map as a separate collection. The returned collection is backed by the map, so any changes made to the returned collection will affect the state of this map.
      Specified by:
      values in interface DoubleValuesMap
      Returns:
      the values as a collection backed by this map

    • equals

      public boolean equals(Object otherMap)
      Description copied from interface: DoubleDoubleMap
      Follows the same general contract as Map.equals(Object).
      Specified by:
      equals in interface DoubleDoubleMap
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Description copied from interface: DoubleDoubleMap
      Follows the same general contract as Map.hashCode().
      Specified by:
      hashCode in interface DoubleDoubleMap
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Description copied from interface: DoubleDoubleMap
      Follows the same general contract as AbstractMap.toString()
      Specified by:
      toString in interface DoubleDoubleMap
      Specified by:
      toString in interface PrimitiveIterable
      Overrides:
      toString in class Object
      Returns:
      a string representation of this DoubleDoubleMap
      See Also:

    • makeString

      public String makeString()
      Description copied from interface: PrimitiveIterable
      Returns a string representation of this collection by delegating to PrimitiveIterable.makeString(String) and defaulting the separator parameter to the characters ", " (comma and space).
      Specified by:
      makeString in interface PrimitiveIterable
      Returns:
      a string representation of this collection.

    • makeString

      public String makeString(String separator)
      Description copied from interface: PrimitiveIterable
      Returns a string representation of this collection by delegating to PrimitiveIterable.makeString(String, String, String) and defaulting the start and end parameters to "" (the empty String).
      Specified by:
      makeString in interface PrimitiveIterable
      Returns:
      a string representation of this collection.

    • makeString

      public String makeString(String start, String separator, String end)
      Description copied from interface: PrimitiveIterable
      Returns a string representation of this collection with the elements separated by the specified separator and enclosed between the start and end strings.
      Specified by:
      makeString in interface PrimitiveIterable
      Returns:
      a string representation of this collection.

    • appendString

      public void appendString(Appendable appendable)
      Description copied from interface: PrimitiveIterable
      Prints a string representation of this collection onto the given Appendable. Prints the string returned by PrimitiveIterable.makeString().
      Specified by:
      appendString in interface PrimitiveIterable

    • appendString

      public void appendString(Appendable appendable, String separator)
      Description copied from interface: PrimitiveIterable
      Prints a string representation of this collection onto the given Appendable. Prints the string returned by PrimitiveIterable.makeString(String).
      Specified by:
      appendString in interface PrimitiveIterable

    • appendString

      public void appendString(Appendable appendable, String start, String separator, String end)
      Description copied from interface: PrimitiveIterable
      Prints a string representation of this collection onto the given Appendable. Prints the string returned by PrimitiveIterable.makeString(String, String, String).
      Specified by:
      appendString in interface PrimitiveIterable

    • injectInto

      public <T> T injectInto(T injectedValue, ObjectDoubleToObjectFunction<? super T,? extends T> function)
      Specified by:
      injectInto in interface DoubleIterable

    • chunk

      public RichIterable<DoubleIterable> chunk(int size)
      Description copied from interface: DoubleIterable
      Partitions elements in fixed size chunks.
      Specified by:
      chunk in interface DoubleIterable
      Parameters:
      size - the number of elements per chunk
      Returns:
      A RichIterable containing DoubleIterables of size size, except the last will be truncated if the elements don't divide evenly.