Class UnmodifiableDoubleDoubleMap

    • Method Detail

      • 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
      • 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
      • 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
      • getAndPut

        public double getAndPut​(double key,
                                double putValue,
                                double defaultValue)
        Description copied from interface: MutableDoubleDoubleMap
        Retrieves the value associated with the key if one exists; associates a putValue with the key.
        Specified by:
        getAndPut in interface MutableDoubleDoubleMap
        Parameters:
        key - the key
        putValue - the value to associate with key if no such mapping exists
        defaultValue - the value to return if no mapping associated with key exists
        Returns:
        the value associated with key, if one exists, or defaultValue 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
      • 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
      • 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
      • 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
      • 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
      • 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​(java.lang.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 java.lang.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 java.lang.Object
      • toString

        public java.lang.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 java.lang.Object
        Returns:
        a string representation of this DoubleDoubleMap
        See Also:
        AbstractCollection.toString()
      • makeString

        public java.lang.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 java.lang.String makeString​(java.lang.String start,
                                           java.lang.String separator,
                                           java.lang.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.
      • 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.