gov.sandia.cognition.collection

Class AbstractMutableDoubleMap<KeyType>

java.lang.Object

gov.sandia.cognition.util.AbstractCloneableSerializable

gov.sandia.cognition.collection.AbstractScalarMap<KeyType,MutableDouble>

gov.sandia.cognition.collection.AbstractMutableDoubleMap<KeyType>

Type Parameters:

KeyType - Type of key in the Map

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractDataDistribution, DefaultInfiniteVector

public class AbstractMutableDoubleMap<KeyType>
extends AbstractScalarMap<KeyType,MutableDouble>

A partial implementation of a ScalarMap with a MutableDouble value

Since:

3.2.1

Author:

Kevin R. Dixon

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AbstractMutableDoubleMap.Entry<KeyType> Interface for entries.
protected static class	AbstractMutableDoubleMap.SimpleEntry<KeyType> Entry for the AbstractScalarMap
protected static class	AbstractMutableDoubleMap.SimpleEntrySet<KeyType> Simple Entry Set for DefaultInfiniteVector
protected static class	AbstractMutableDoubleMap.SimpleIterator<KeyType> Simple iterator for DefaultInfiniteVector

Field Summary

Fields inherited from class gov.sandia.cognition.collection.AbstractScalarMap

map

Constructor Summary

Constructors

Constructor and Description
AbstractMutableDoubleMap(java.util.Map<KeyType,MutableDouble> map) Creates a new instance of AbstractMutableDoubleMap

Method Summary

Modifier and Type	Method and Description
java.util.Map<KeyType,MutableDouble>	asMap() Gets a java.util.Map that contains the same data as in this scalar map.
AbstractMutableDoubleMap<KeyType>	clone() This makes public the clone method on the Object class and removes the exception that it throws.
void	compact() Removes entries from the map with value of 0.0
java.util.Set<AbstractMutableDoubleMap.Entry<KeyType>>	entrySet() Gets the set of entries in this scalar map.
double	get(KeyType key) Gets the value associated with a given key.
double	increment(KeyType key, double value) Increments the value associated with the given key by the given amount.
void	set(KeyType key, double value) Sets the value associated with a given key.

Methods inherited from class gov.sandia.cognition.collection.AbstractScalarMap

clear, containsKey, decrement, decrement, decrementAll, decrementAll, getMaxValue, getMaxValueKey, getMaxValueKeys, getMinValue, getMinValueKey, getMinValueKeys, increment, incrementAll, incrementAll, isEmpty, keySet, setAll, setAll, size

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractMutableDoubleMap

public AbstractMutableDoubleMap(java.util.Map<KeyType,MutableDouble> map)

Creates a new instance of AbstractMutableDoubleMap

Parameters:

map - The backing map that the data is stored in.

Method Detail

clone

public AbstractMutableDoubleMap<KeyType> 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 AbstractScalarMap<KeyType,MutableDouble>

Returns:

A clone of this object.

asMap

public java.util.Map<KeyType,MutableDouble> 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>

Overrides:

asMap in class AbstractScalarMap<KeyType,MutableDouble>

Returns:

The Map version of this data structure.

compact

public void compact()

Removes entries from the map with value of 0.0

get

public double get(KeyType key)

Description copied from interface: ScalarMap

Gets the value associated with a given key. If the key does not exist, then 0.0 is returned.

Parameters:

key - A key.

Returns:

The value associated with the key or 0.0 if it does not exist.

set

public void set(KeyType key,
                double value)

Description copied from interface: ScalarMap

Sets the value associated with a given key. In some cases if the value is 0.0, the key may be removed from the map.

Parameters:

key - A key.

value - The value to associate 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>

Overrides:

increment in class AbstractScalarMap<KeyType,MutableDouble>

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.

entrySet

public java.util.Set<AbstractMutableDoubleMap.Entry<KeyType>> entrySet()

Description copied from interface: ScalarMap

Gets the set of entries in this scalar map.

Returns:

The set of entries in the scalar map.