gov.sandia.cognition.collection

Class AbstractLogNumberMap<KeyType>

java.lang.Object

gov.sandia.cognition.util.AbstractCloneableSerializable

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

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

Type Parameters:

KeyType - Type of key in the Map

All Implemented Interfaces:

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

public class AbstractLogNumberMap<KeyType>
extends AbstractScalarMap<KeyType,LogNumber>

A partial implementation of a ScalarMap with a LogNumber value

Since:

3.4.2

Author:

Kevin R. Dixon

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

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

ScalarMap.Entry<KeyType>

Field Summary

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

map

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
AbstractLogNumberMap<KeyType>	clone() This makes public the clone method on the Object class and removes the exception that it throws.
AbstractLogNumberMap.SimpleEntrySet<KeyType>	entrySet() Gets the set of entries in this scalar map.
double	get(KeyType key) Gets the value associated with a given key.
LogNumber	getLog(KeyType key) Gets the LogNumber at the given key
void	set(KeyType key, double value) Sets the value associated with a given key.
void	setLog(KeyType key, LogNumber logValue) Sets the LogNumber at the given key

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

asMap, clear, containsKey, decrement, decrement, decrementAll, decrementAll, getMaxValue, getMaxValueKey, getMaxValueKeys, getMinValue, getMinValueKey, getMinValueKeys, increment, 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

AbstractLogNumberMap

public AbstractLogNumberMap(java.util.Map<KeyType,LogNumber> map)

Creates a new instance of AbstractMutableDoubleMap

Parameters:

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

Method Detail

clone

public AbstractLogNumberMap<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,LogNumber>

Returns:

A clone of this object.

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.

getLog

public LogNumber getLog(KeyType key)

Gets the LogNumber at the given key

Parameters:

key - Key to get from the Map

Returns:

Gets the LogNumber from the Map, null if no entry at the given key.

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.

setLog

public void setLog(KeyType key,
                   LogNumber logValue)

Sets the LogNumber at the given key

Parameters:

key - Key to set into the Map

logValue - Sets the LogNumber into the Map

entrySet

public AbstractLogNumberMap.SimpleEntrySet<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.