DoubleHashMap (de.mpg.mpi-inf:javatools 1.1 API)

java.lang.Object
- java.util.AbstractCollection<E>
- - java.util.AbstractSet<K>
  - - javatools.datatypes.DoubleHashMap<K>

All Implemented Interfaces:

Iterable<K>, Collection<K>, Set<K>
```
public class DoubleHashMap<K>
extends AbstractSet<K>
```
Copyright 2016 Fabian M. Suchanek Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. This class implements a HashMap with double values.

Field Summary

Fields
Modifier and Type Field and Description

protected Object[] keys
Holds the keys

protected int size
Holds size

protected double[] values
Holds the values

Fields
Modifier and Type	Field and Description
`protected Object[]`	`keys` Holds the keys
`protected int`	`size` Holds size
`protected double[]`	`values` Holds the values

Constructor Summary

Constructors
Constructor and Description

DoubleHashMap()
Constructor

DoubleHashMap(K... keys)
Creates a DoubleHashMap with these keys set to 1

Constructors
Constructor and Description
`DoubleHashMap()` Constructor
`DoubleHashMap(K... keys)` Creates a DoubleHashMap with these keys set to 1

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(Collection<K> set)` increases the counters
`void`	`add(DoubleHashMap<K> countBindings)` Adds all integer values up
`boolean`	`add(K e)`
`boolean`	`add(K key, double delta)` Increases a value, true for 'added new key with delta as value', false for 'increased existing value'
`void`	`clear()`
`double`	`computeSum()` Computes the sum
`boolean`	`contains(Object o)`
`boolean`	`containsKey(Object key)` True if value is there
`List<K>`	`decreasingKeys()` returns the keys in decreasing order
`boolean`	`equals(Object o)`
`protected int`	`find(Object key)` Finds a key, keys[find] will be NULL if non-existent
`double`	`findMax()` Finds the maximum value
`double`	`get(K key)` Retrieves a value
`double`	`get(K key, int defaultValue)` Retrieves a value
`int`	`hashCode()`
`boolean`	`increase(K key)` Increases a value, true for 'added new key with value 1', false for 'increased existing value'
`List<K>`	`increasingKeys()` returns the keys in increasing order
`protected int`	`index(Object key)` Returns an index where to store the object
`protected int`	`index(Object key, int len)` Returns an index where to store the object
`Iterator<K>`	`iterator()`
`PeekIterator<K>`	`keys()` Returns keys.
`static void`	`main(String[] args)` Test
`boolean`	`put(K key, double value)` Adds a key, true for 'added the key as new', false for 'overwrote existing value'
`protected boolean`	`put(Object[] keys, double[] values, Object key, double value)` Adds a key, true for 'added the key as new', false for 'overwrote existing value'
`protected void`	`rehash()` Rehashes
`int`	`size()`
`String`	`toString()`

Methods inherited from class java.util.AbstractSet
removeAll

Methods inherited from class java.util.AbstractCollection
addAll, containsAll, isEmpty, remove, retainAll, toArray, toArray

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

Methods inherited from interface java.util.Set
addAll, containsAll, isEmpty, remove, retainAll, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable
forEach

- Field Detail
  - keys
```
protected Object[] keys
```
    Holds the keys
  - values
```
protected double[] values
```
    Holds the values
  - size
```
protected int size
```
    Holds size
- Constructor Detail
  - DoubleHashMap
```
public DoubleHashMap()
```
    Constructor
  - DoubleHashMap
```
public DoubleHashMap(K... keys)
```
    Creates a DoubleHashMap with these keys set to 1
- Method Detail
  - index
```
protected int index(Object key,
                    int len)
```
    Returns an index where to store the object
  - index
```
protected int index(Object key)
```
    Returns an index where to store the object
  - get
```
public double get(K key)
```
    Retrieves a value
  - find
```
protected int find(Object key)
```
    Finds a key, keys[find] will be NULL if non-existent
  - get
```
public double get(K key,
                  int defaultValue)
```
    Retrieves a value
  - containsKey
```
public boolean containsKey(Object key)
```
    True if value is there
  - add
```
public boolean add(K key,
                   double delta)
```
    Increases a value, true for 'added new key with delta as value', false for 'increased existing value'
  - increase
```
public boolean increase(K key)
```
    Increases a value, true for 'added new key with value 1', false for 'increased existing value'
  - keys
```
public PeekIterator<K> keys()
```
    Returns keys. Can be used only once.
  - put
```
public boolean put(K key,
                   double value)
```
    Adds a key, true for 'added the key as new', false for 'overwrote existing value'
  - put
```
protected boolean put(Object[] keys,
                      double[] values,
                      Object key,
                      double value)
```
    Adds a key, true for 'added the key as new', false for 'overwrote existing value'
  - rehash
```
protected void rehash()
```
    Rehashes
  - main
```
public static void main(String[] args)
                 throws Exception
```
    Test
    
    Throws:
    
    Exception
  - iterator
```
public Iterator<K> iterator()
```
    Specified by:
    
    iterator in interface Iterable<K>
    
    Specified by:
    
    iterator in interface Collection<K>
    
    Specified by:
    
    iterator in interface Set<K>
    
    Specified by:
    
    iterator in class AbstractCollection<K>
  - size
```
public int size()
```
    Specified by:
    
    size in interface Collection<K>
    
    Specified by:
    
    size in interface Set<K>
    
    Specified by:
    
    size in class AbstractCollection<K>
  - add
```
public boolean add(K e)
```
    Specified by:
    
    add in interface Collection<K>
    
    Specified by:
    
    add in interface Set<K>
    
    Overrides:
    
    add in class AbstractCollection<K>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Collection<K>
    
    Specified by:
    
    clear in interface Set<K>
    
    Overrides:
    
    clear in class AbstractCollection<K>
  - contains
```
public boolean contains(Object o)
```
    Specified by:
    
    contains in interface Collection<K>
    
    Specified by:
    
    contains in interface Set<K>
    
    Overrides:
    
    contains in class AbstractCollection<K>
  - add
```
public void add(DoubleHashMap<K> countBindings)
```
    Adds all integer values up
  - add
```
public void add(Collection<K> set)
```
    increases the counters
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class AbstractCollection<K>
  - increasingKeys
```
public List<K> increasingKeys()
```
    returns the keys in increasing order
  - decreasingKeys
```
public List<K> decreasingKeys()
```
    returns the keys in decreasing order
  - equals
```
public boolean equals(Object o)
```
    Specified by:
    
    equals in interface Collection<K>
    
    Specified by:
    
    equals in interface Set<K>
    
    Overrides:
    
    equals in class AbstractSet<K>
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface Collection<K>
    
    Specified by:
    
    hashCode in interface Set<K>
    
    Overrides:
    
    hashCode in class AbstractSet<K>
  - findMax
```
public double findMax()
```
    Finds the maximum value
  - computeSum
```
public double computeSum()
```
    Computes the sum

Class DoubleHashMap<K>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.util.AbstractSet

Methods inherited from class java.util.AbstractCollection

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Set

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Field Detail

keys

values

size

Constructor Detail

DoubleHashMap

DoubleHashMap

Method Detail

index

index

get

find

get

containsKey

add

increase

keys

put

put

rehash

main

iterator

size

add

clear

contains

add

add

toString

increasingKeys

decreasingKeys

equals

hashCode

findMax

computeSum