HMapIF (lintools-datatypes 1.0.0 API)

java.lang.Object
- tl.lin.data.map.HMapIF

All Implemented Interfaces:

Serializable, Cloneable, MapIF

Direct Known Subclasses:

HMapIFW
```
public class HMapIF
extends Object
implements MapIF, Cloneable, Serializable
```
Hash-based implementation of MapIF.

See Also:
Serialized Form

Field Summary
- Fields inherited from interface tl.lin.data.map.MapIF
  DEFAULT_VALUE

Constructor Summary

Constructors
Constructor and Description
`HMapIF()` Constructs an empty `HMapIF` with the default initial capacity (1024) and the default load factor (0.75).
`HMapIF(int initialCapacity)` Constructs an empty `HMapIF` with the specified initial capacity and the default load factor (0.75).
`HMapIF(int initialCapacity, float loadFactor)` Constructs an empty `HMapIF` with the specified initial capacity and load factor.
`HMapIF(MapIF m)` Constructs a new `HMapIF` with the same mappings as the specified `MapIF`.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`clear()` Removes all of the mappings from this map.
`Object`	`clone()` Returns a shallow copy of this `HMapIF` instance: the keys and values themselves are not cloned.
`boolean`	`containsKey(int key)` Returns `true` if this map contains a mapping for the specified key.
`boolean`	`containsValue(float value)` Returns `true` if this map contains one or more mappings with the specified value.
`double`	`dot(MapIF m)` Computes the dot product of this map with another map.
`Set<MapIF.Entry>`	`entrySet()` Returns a `Set` view of the mappings contained in this map.
`float`	`get(int key)` Returns the value to which the specified key is mapped, or throws `NoSuchElementException` if this map contains no mapping for the key.
`MapIF.Entry[]`	`getEntriesSortedByValue()` Returns entries sorted by descending value.
`MapIF.Entry[]`	`getEntriesSortedByValue(int n)` Returns top n entries sorted by descending value.
`void`	`increment(int key)` Increments the key.
`void`	`increment(int key, float value)` Increments the key by some value.
`boolean`	`isEmpty()` Returns `true` if this map contains no key-value mappings.
`Set<Integer>`	`keySet()` Returns a `Set` view of the keys contained in this map.
`float`	`length()` Returns the length of the vector represented by this map.
`void`	`normalize()` Normalizes values such that the vector represented by this map has unit length.
`void`	`plus(MapIF m)` Adds values of keys from another map to this map.
`float`	`put(int key, float value)` Associates the specified value with the specified key in this map.
`void`	`putAll(MapIF m)` Copies all of the mappings from the specified map to this map.
`float`	`remove(int key)` Removes the mapping for a key from this map if it is present.
`int`	`size()` Returns the number of key-value mappings in this map.
`String`	`toString()`
`Collection<Float>`	`values()` Returns a `Collection` view of the values contained in this map.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface tl.lin.data.map.MapIF
equals, hashCode

- Constructor Detail
  - HMapIF
```
public HMapIF(int initialCapacity,
      float loadFactor)
```
    Constructs an empty HMapIF with the specified initial capacity and load factor.
    
    Parameters:
    initialCapacity - the initial capacity
    loadFactor - the load factor
    
    Throws:
    
    IllegalArgumentException - if the initial capacity is negative or the load factor is nonpositive
  - HMapIF
```
public HMapIF(int initialCapacity)
```
    Constructs an empty HMapIF with the specified initial capacity and the default load factor (0.75).
    
    Parameters:
    initialCapacity - the initial capacity.
    
    Throws:
    
    IllegalArgumentException - if the initial capacity is negative.
  - HMapIF
```
public HMapIF()
```
    Constructs an empty HMapIF with the default initial capacity (1024) and the default load factor (0.75).
  - HMapIF
```
public HMapIF(MapIF m)
```
    Constructs a new HMapIF with the same mappings as the specified MapIF. The HMapIF is created with default load factor (0.75) and an initial capacity sufficient to hold the mappings in the specified MapIF.
    
    Parameters:
    m - the map whose mappings are to be placed in this map
    
    Throws:
    
    NullPointerException - if the specified map is null
- Method Detail
  - size
```
public int size()
```
    Description copied from interface: MapIF
    
    Returns the number of key-value mappings in this map.
    
    Specified by:
    
    size in interface MapIF
    
    Returns:
    the number of key-value mappings in this map
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: MapIF
    
    Returns true if this map contains no key-value mappings.
    
    Specified by:
    
    isEmpty in interface MapIF
    
    Returns:
    true if this map contains no key-value mappings
  - get
```
public float get(int key)
```
    Description copied from interface: MapIF
    
    Returns the value to which the specified key is mapped, or throws NoSuchElementException if this map contains no mapping for the key.
    
    Specified by:
    
    get in interface MapIF
    
    Parameters:
    key - the key whose associated value is to be returned
    
    Returns:
    the value to which the specified key is mapped
  - containsKey
```
public boolean containsKey(int key)
```
    Description copied from interface: MapIF
    
    Returns true if this map contains a mapping for the specified key.
    
    Specified by:
    
    containsKey in interface MapIF
    
    Parameters:
    key - key whose presence in this map is to be tested
    
    Returns:
    true if this map contains a mapping for the specified key
  - put
```
public float put(int key,
        float value)
```
    Description copied from interface: MapIF
    
    Associates the specified value with the specified key in this map. If the map previously contained a mapping for the key, the old value is replaced by the specified value.
    
    Specified by:
    
    put in interface MapIF
    
    Parameters:
    key - key with which the specified value is to be associated
    value - value to be associated with the specified key
  - putAll
```
public void putAll(MapIF m)
```
    Description copied from interface: MapIF
    
    Copies all of the mappings from the specified map to this map.
    
    Specified by:
    
    putAll in interface MapIF
    
    Parameters:
    m - mappings to be stored in this map
  - remove
```
public float remove(int key)
```
    Description copied from interface: MapIF
    
    Removes the mapping for a key from this map if it is present. No action is performed if this map does not contain the key.
    
    Specified by:
    
    remove in interface MapIF
    
    Parameters:
    key - key whose mapping is to be removed from the map
  - clear
```
public void clear()
```
    Description copied from interface: MapIF
    
    Removes all of the mappings from this map. The map will be empty after this call returns.
    
    Specified by:
    
    clear in interface MapIF
  - containsValue
```
public boolean containsValue(float value)
```
    Description copied from interface: MapIF
    
    Returns true if this map contains one or more mappings with the specified value.
    
    Specified by:
    
    containsValue in interface MapIF
    
    Parameters:
    value - value whose presence in this map is to be tested
    
    Returns:
    true this map contains one or more mappings with the specified value
  - clone
```
public Object clone()
```
    Returns a shallow copy of this HMapIF instance: the keys and values themselves are not cloned.
    
    Overrides:
    
    clone in class Object
    
    Returns:
    a shallow copy of this map
  - keySet
```
public Set<Integer> keySet()
```
    Description copied from interface: MapIF
    
    Returns a Set view of the keys contained in this map. Note that this is a inefficient operation since it triggers autoboxing of the int keys, which is exactly what this implementation is trying to avoid. Unlike a standard Java Map, values in the backing map cannot be altered with this collection view.
    
    Specified by:
    
    keySet in interface MapIF
    
    Returns:
    a set view of the keys contained in this map
  - values
```
public Collection<Float> values()
```
    Description copied from interface: MapIF
    
    Returns a Collection view of the values contained in this map. Note that this is a inefficient operation since it triggers autoboxing of the float values, which is exactly what this implementation is trying to avoid. Unlike a standard Java Map, values in the backing map cannot be altered with this collection view.
    
    Specified by:
    
    values in interface MapIF
    
    Returns:
    a collection view of the values contained in this map
  - entrySet
```
public Set<MapIF.Entry> entrySet()
```
    Description copied from interface: MapIF
    
    Returns a Set view of the mappings contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa.
    
    Specified by:
    
    entrySet in interface MapIF
    
    Returns:
    a set view of the mappings contained in this map
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - plus
```
public void plus(MapIF m)
```
    Description copied from interface: MapIF
    
    Adds values of keys from another map to this map.
    
    Specified by:
    
    plus in interface MapIF
    
    Parameters:
    m - the other map
  - dot
```
public double dot(MapIF m)
```
    Description copied from interface: MapIF
    
    Computes the dot product of this map with another map.
    
    Specified by:
    
    dot in interface MapIF
    
    Parameters:
    m - the other map
  - increment
```
public void increment(int key)
```
    Description copied from interface: MapIF
    
    Increments the key. If the key does not exist in the map, its value is set to one.
    
    Specified by:
    
    increment in interface MapIF
    
    Parameters:
    key - key to increment
  - increment
```
public void increment(int key,
             float value)
```
    Description copied from interface: MapIF
    
    Increments the key by some value. If the key does not exist in the map, its value is set to the parameter value.
    
    Specified by:
    
    increment in interface MapIF
    
    Parameters:
    key - key to increment
    value - increment value
  - length
```
public float length()
```
    Returns the length of the vector represented by this map.
    
    Returns:
    length of the vector represented by this map
  - normalize
```
public void normalize()
```
    Normalizes values such that the vector represented by this map has unit length.
  - getEntriesSortedByValue
```
public MapIF.Entry[] getEntriesSortedByValue()
```
    Returns entries sorted by descending value. Ties broken by the key.
    
    Returns:
    entries sorted by descending value
  - getEntriesSortedByValue
```
public MapIF.Entry[] getEntriesSortedByValue(int n)
```
    Returns top n entries sorted by descending value. Ties broken by the key.
    
    Parameters:
    n - number of entries to return
    
    Returns:
    top n entries sorted by descending value

Class HMapIF

Field Summary

Fields inherited from interface tl.lin.data.map.MapIF

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface tl.lin.data.map.MapIF

Constructor Detail

HMapIF

HMapIF

HMapIF

HMapIF

Method Detail

size

isEmpty

get

containsKey

put

putAll

remove

clear

containsValue

clone

keySet

values

entrySet

toString

plus

dot

increment

increment

length

normalize

getEntriesSortedByValue

getEntriesSortedByValue