com.carrotsearch.hppcrt.IntLongMap Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hppcrt Show documentation

High Performance Primitive Collections Realtime (fork of HPPC of Carrotsearch) Fundamental data structures (maps, sets, lists, stacks, queues, heaps, sorts) generated for combinations of object and primitive types to conserve JVM memory and speed up execution. The Realtime fork intend of extending collections while tweaking and optimizations to remove any dynamic allocations at runtime, and low variance execution times.

There is a newer version: 0.7.5

Show newest version

package com.carrotsearch.hppcrt;

import com.carrotsearch.hppcrt.cursors.IntLongCursor;

/**
 * An associative container with unique binding from keys to a single value.
 */
  
 @javax.annotation.Generated(date = "2015-02-27T19:21:18+0100", value = "HPPC-RT generated from: IntLongMap.java") 
public interface IntLongMap
extends IntLongAssociativeContainer
{
    /**
     * Place a given key and value in the container.
     * @return Returns the value previously stored under the given key in the map if an equal key is part of the map, and replaces the existing
     *  value only  with the argument value. If no previous key existed,
     * the default value is returned and the (key, value) pair is inserted.
     */
    long put(int key, long value);

    /**
     * Trove-inspired API method. An equivalent
     * of the following code:
     *      * if (!map.containsKey(key))
     *      map.put(key, value);
     * 
     * 
     * @param key The key of the value to check.
     * @param value The value to put if key does not exist.
     * @return true if key did not exist and value
     * was placed in the map.
     */
    boolean putIfAbsent(final int key, final long value);

      
    /**
     * An equivalent of calling
     *      *  putOrAdd(key, additionValue, additionValue);
     * 
     * 
     * @param key The key of the value to adjust.
     * @param additionValue The value to put or add to the existing value if key exists.
     * @return Returns the current value associated with key (after changes).
     */
      
          long addTo(int key, long additionValue);
     

     
    /**
     * Trove-inspired API method. A logical
     * equivalent of the following code (but does not update {@link #lastSlot):
     *      *  if (containsKey(key))
     *  {
     *      long v = (long) (lget() + additionValue);
     *      lset(v);
     *      return v;
     *  }
     *  else
     *  {
     *     put(key, putValue);
     *     return putValue;
     *  }
     * 
     * 
     * @param key The key of the value to adjust.
     * @param putValue The value to put if key does not exist.
     * @param additionValue The value to add to the existing value if key exists.
     * @return Returns the current value associated with key (after changes).
     */
      
         long putOrAdd(int key, long putValue, long additionValue);
     

    /**
     * @return Returns the value associated with the given key or the default value
     * for the value type, if the key is not associated with any value.
     *
     */
    long get(int key);

    /**
     * Puts all keys from another container to this map, replacing the values
     * of existing keys, if such keys are present.
     * 
     * @return Returns the number of keys added to the map as a result of this
     * call (not previously present in the map). Values of existing keys are overwritten.
     */
    int putAll(IntLongAssociativeContainer container);

    /**
     * Puts all keys from an iterable cursor to this map, replacing the values
     * of existing keys, if such keys are present.
     * 
     * @return Returns the number of keys added to the map as a result of this
     * call (not previously present in the map). Values of existing keys are overwritten.
     */
    int putAll(Iterable iterable);

    /**
     * Remove all values at the given key. The default value for the key type is returned
     * if the value does not exist in the map.
     */
    long remove(int key);
}