AbstractScalarMap (Cognitive Foundry)

java.lang.Object
- gov.sandia.cognition.util.AbstractCloneableSerializable
- - gov.sandia.cognition.collection.AbstractScalarMap<KeyType,NumberType>

Type Parameters:

KeyType - The type of the key in the Map.

NumberType - the type of Number in the Map.

All Implemented Interfaces:

NumericMap<KeyType>, ScalarMap<KeyType>, CloneableSerializable, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

AbstractLogNumberMap, AbstractMutableDoubleMap
```
public abstract class AbstractScalarMap<KeyType,NumberType extends java.lang.Number>
extends AbstractCloneableSerializable
implements ScalarMap<KeyType>
```
Partial implementation of ScalarMap

Since:

3.2.1

Author:

Justin Basilico

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface gov.sandia.cognition.collection.ScalarMap
  ScalarMap.Entry<KeyType>

Field Summary

Fields
Modifier and Type Field and Description

protected java.util.Map<KeyType,NumberType> map
Map backing that performs the storage.

Fields
Modifier and Type	Field and Description
`protected java.util.Map<KeyType,NumberType>`	`map` Map backing that performs the storage.

Constructor Summary

Constructors
Constructor and Description

AbstractScalarMap(java.util.Map<KeyType,NumberType> map)
Creates a new instance of AbstractScalarMap

Constructors
Constructor and Description
`AbstractScalarMap(java.util.Map<KeyType,NumberType> map)` Creates a new instance of AbstractScalarMap

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.Map<KeyType,NumberType>`	`asMap()` Gets a `java.util.Map` that contains the same data as in this scalar map.
`void`	`clear()` Removes all elements from the map.
`AbstractScalarMap<KeyType,NumberType>`	`clone()` This makes public the clone method on the `Object` class and removes the exception that it throws.
`boolean`	`containsKey(KeyType key)` Determines if this map contains the given key.
`double`	`decrement(KeyType key)` Decrements the value associated with a given key by 1.0.
`double`	`decrement(KeyType key, double value)` Decrements the value associated with the given key by the given amount.
`void`	`decrementAll(java.lang.Iterable<? extends KeyType> keys)` Decrements the values associated all of the given keys by 1.0.
`void`	`decrementAll(ScalarMap<? extends KeyType> other)` Decrements all the keys in this map by the values in the other one.
`double`	`getMaxValue()` The maximum value associated with any key in the map.
`KeyType`	`getMaxValueKey()` Gets the non-unique key associated with the maximum value in the map.
`java.util.Set<KeyType>`	`getMaxValueKeys()` Gets a set of all keys associated with the maximum value in the map.
`double`	`getMinValue()` The minimum value associated with any key in the map.
`KeyType`	`getMinValueKey()` Gets the non-unique key associated with the minimum value in the map.
`java.util.Set<KeyType>`	`getMinValueKeys()` Gets a set of all keys associated with the minimum value in the map.
`double`	`increment(KeyType key)` Increments the value associated with the given key by 1.0.
`double`	`increment(KeyType key, double value)` Increments the value associated with the given key by the given amount.
`void`	`incrementAll(java.lang.Iterable<? extends KeyType> keys)` Increments the values associated all of the given keys by 1.0.
`void`	`incrementAll(ScalarMap<? extends KeyType> other)` Increments all the keys in this map by the values in the other one.
`boolean`	`isEmpty()` Returns true if the map is empty.
`java.util.Set<KeyType>`	`keySet()` Gets the set of unique keys in the map.
`void`	`setAll(java.lang.Iterable<? extends KeyType> keys, double value)` Sets all the given keys to the given value.
`void`	`setAll(ScalarMap<? extends KeyType> other)` Sets all the given keys to the given value.
`int`	`size()` Gets the number of items in the map.

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

Methods inherited from interface gov.sandia.cognition.collection.ScalarMap
entrySet, get, set

- Field Detail
  - map
```
protected java.util.Map<KeyType,NumberType extends java.lang.Number> map
```
    Map backing that performs the storage.
- Constructor Detail
  - AbstractScalarMap
```
public AbstractScalarMap(java.util.Map<KeyType,NumberType> map)
```
    Creates a new instance of AbstractScalarMap
    
    Parameters:
    
    map - The backing map that the data is stored in.
- Method Detail
  - clone
```
public AbstractScalarMap<KeyType,NumberType> clone()
```
    Description copied from class: AbstractCloneableSerializable
    
    This makes public the clone method on the Object class and removes the exception that it throws. Its default behavior is to automatically create a clone of the exact type of object that the clone is called on and to copy all primitives but to keep all references, which means it is a shallow copy. Extensions of this class may want to override this method (but call super.clone() to implement a "smart copy". That is, to target the most common use case for creating a copy of the object. Because of the default behavior being a shallow copy, extending classes only need to handle fields that need to have a deeper copy (or those that need to be reset). Some of the methods in ObjectUtil may be helpful in implementing a custom clone method. Note: The contract of this method is that you must use super.clone() as the basis for your implementation.
    
    Specified by:
    
    clone in interface CloneableSerializable
    
    Overrides:
    
    clone in class AbstractCloneableSerializable
    
    Returns:
    
    A clone of this object.
  - asMap
```
public java.util.Map<KeyType,NumberType> asMap()
```
    Description copied from interface: ScalarMap
    
    Gets a java.util.Map that contains the same data as in this scalar map.
    
    Specified by:
    
    asMap in interface ScalarMap<KeyType>
    
    Returns:
    
    The Map version of this data structure.
  - setAll
```
public void setAll(java.lang.Iterable<? extends KeyType> keys,
                   double value)
```
    Description copied from interface: ScalarMap
    
    Sets all the given keys to the given value.
    
    Specified by:
    
    setAll in interface ScalarMap<KeyType>
    
    Parameters:
    
    keys - A list of keys.
    
    value - The value to associate with all the given keys.
  - setAll
```
public void setAll(ScalarMap<? extends KeyType> other)
```
    Description copied from interface: ScalarMap
    
    Sets all the given keys to the given value.
    
    Specified by:
    
    setAll in interface ScalarMap<KeyType>
    
    Parameters:
    
    other - The other map.
  - increment
```
public double increment(KeyType key)
```
    Description copied from interface: ScalarMap
    
    Increments the value associated with the given key by 1.0.
    
    Specified by:
    
    increment in interface ScalarMap<KeyType>
    
    Parameters:
    
    key - A key.
    
    Returns:
    
    The new value associated with the key.
  - increment
```
public double increment(KeyType key,
                        double value)
```
    Description copied from interface: ScalarMap
    
    Increments the value associated with the given key by the given amount.
    
    Specified by:
    
    increment in interface ScalarMap<KeyType>
    
    Parameters:
    
    key - A key.
    
    value - The amount to increment the value associated with the given key by.
    
    Returns:
    
    The new value associated with the key.
  - incrementAll
```
public void incrementAll(java.lang.Iterable<? extends KeyType> keys)
```
    Description copied from interface: ScalarMap
    
    Increments the values associated all of the given keys by 1.0.
    
    Specified by:
    
    incrementAll in interface ScalarMap<KeyType>
    
    Parameters:
    
    keys - A list of keys.
  - incrementAll
```
public void incrementAll(ScalarMap<? extends KeyType> other)
```
    Description copied from interface: ScalarMap
    
    Increments all the keys in this map by the values in the other one.
    
    Specified by:
    
    incrementAll in interface ScalarMap<KeyType>
    
    Parameters:
    
    other - The other map.
  - decrement
```
public double decrement(KeyType key)
```
    Description copied from interface: ScalarMap
    
    Decrements the value associated with a given key by 1.0.
    
    Specified by:
    
    decrement in interface ScalarMap<KeyType>
    
    Parameters:
    
    key - A key.
    
    Returns:
    
    The new value associated with the key.
  - decrement
```
public double decrement(KeyType key,
                        double value)
```
    Description copied from interface: ScalarMap
    
    Decrements the value associated with the given key by the given amount.
    
    Specified by:
    
    decrement in interface ScalarMap<KeyType>
    
    Parameters:
    
    key - A key.
    
    value - The amount to decrement the value associated with the given key by.
    
    Returns:
    
    The new value associated with the key.
  - decrementAll
```
public void decrementAll(java.lang.Iterable<? extends KeyType> keys)
```
    Description copied from interface: ScalarMap
    
    Decrements the values associated all of the given keys by 1.0.
    
    Specified by:
    
    decrementAll in interface ScalarMap<KeyType>
    
    Parameters:
    
    keys - A list of keys.
  - decrementAll
```
public void decrementAll(ScalarMap<? extends KeyType> other)
```
    Description copied from interface: ScalarMap
    
    Decrements all the keys in this map by the values in the other one.
    
    Specified by:
    
    decrementAll in interface ScalarMap<KeyType>
    
    Parameters:
    
    other - The other map.
  - getMaxValue
```
public double getMaxValue()
```
    Description copied from interface: ScalarMap
    
    The maximum value associated with any key in the map.
    
    Specified by:
    
    getMaxValue in interface ScalarMap<KeyType>
    
    Returns:
    
    The maximum value associated with any key in the map. If the map is empty, then Double.NEGATIVE_INFINITY is returned.
  - getMinValue
```
public double getMinValue()
```
    Description copied from interface: ScalarMap
    
    The minimum value associated with any key in the map.
    
    Specified by:
    
    getMinValue in interface ScalarMap<KeyType>
    
    Returns:
    
    The minimum value associated with any key in the map. If the map is empty, then Double.POSITIVE_INFINITY is returned.
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: NumericMap
    
    Returns true if the map is empty.
    
    Specified by:
    
    isEmpty in interface NumericMap<KeyType>
    
    Returns:
    
    True if the map is empty, which means the size is 0.
  - getMaxValueKey
```
public KeyType getMaxValueKey()
```
    Description copied from interface: NumericMap
    
    Gets the non-unique key associated with the maximum value in the map. There can be several keys returning the maximum and this method returns one of them. If the map is empty, it returns null.
    
    Specified by:
    
    getMaxValueKey in interface NumericMap<KeyType>
    
    Returns:
    
    Non-unique key associated with the maximum value in the map.
  - getMaxValueKeys
```
public java.util.Set<KeyType> getMaxValueKeys()
```
    Description copied from interface: NumericMap
    
    Gets a set of all keys associated with the maximum value in the map.
    
    Specified by:
    
    getMaxValueKeys in interface NumericMap<KeyType>
    
    Returns:
    
    Set of all keys associated with the maximum value in the map.
  - getMinValueKey
```
public KeyType getMinValueKey()
```
    Description copied from interface: NumericMap
    
    Gets the non-unique key associated with the minimum value in the map. There can be several keys returning the minimum and this method returns one of them. If the map is empty, it returns null.
    
    Specified by:
    
    getMinValueKey in interface NumericMap<KeyType>
    
    Returns:
    
    Non-unique key associated with the minimum value in the map.
  - getMinValueKeys
```
public java.util.Set<KeyType> getMinValueKeys()
```
    Description copied from interface: NumericMap
    
    Gets a set of all keys associated with the minimum value in the map.
    
    Specified by:
    
    getMinValueKeys in interface NumericMap<KeyType>
    
    Returns:
    
    Set of all keys associated with the minimum value in the map.
  - clear
```
public void clear()
```
    Description copied from interface: NumericMap
    
    Removes all elements from the map.
    
    Specified by:
    
    clear in interface NumericMap<KeyType>
  - keySet
```
public java.util.Set<KeyType> keySet()
```
    Description copied from interface: NumericMap
    
    Gets the set of unique keys in the map.
    
    Specified by:
    
    keySet in interface NumericMap<KeyType>
    
    Returns:
    
    The set of unique keys in the map.
  - containsKey
```
public boolean containsKey(KeyType key)
```
    Description copied from interface: NumericMap
    
    Determines if this map contains the given key.
    
    Specified by:
    
    containsKey in interface NumericMap<KeyType>
    
    Parameters:
    
    key - A key.
    
    Returns:
    
    True if the map contains the key; otherwise false.
  - size
```
public int size()
```
    Description copied from interface: NumericMap
    
    Gets the number of items in the map. This is equal to the number of unique keys.
    
    Specified by:
    
    size in interface NumericMap<KeyType>
    
    Returns:
    
    The number of items in the map. Must be positive.

Class AbstractScalarMap<KeyType,NumberType extends java.lang.Number>

Nested Class Summary

Nested classes/interfaces inherited from interface gov.sandia.cognition.collection.ScalarMap

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface gov.sandia.cognition.collection.ScalarMap

Field Detail

map

Constructor Detail

AbstractScalarMap

Method Detail

clone

asMap

setAll

setAll

increment

increment

incrementAll

incrementAll

decrement

decrement

decrementAll

decrementAll

getMaxValue

getMinValue

isEmpty

getMaxValueKey

getMaxValueKeys

getMinValueKey

getMinValueKeys

clear

keySet

containsKey

size