org.petuum.jbosen.row.double_

Class DoubleColumnMap

java.lang.Object

org.petuum.jbosen.row.double_.DoubleColumnMap

Direct Known Subclasses:

DenseDoubleColumnMap, SparseDoubleColumnMap

public abstract class DoubleColumnMap
extends java.lang.Object

This abstract class defines the interface for a structure that contains columns of double primitive types. The access is similar to a map with column IDs as keys and doubles as values. The built-in row and row update types are maps of this type.

Constructor Summary

Constructors

Constructor and Description
DoubleColumnMap()

Method Summary

Modifier and Type	Method and Description
abstract void	clear() Resets all values.
abstract boolean	contains(int columnId) Check if this map contains the specified column.
abstract double	get(int columnId) Returns the value associated with a particular column ID.
abstract void	inc(int columnId, double value) Increments the current value associated with a column ID.
void	incAll(DoubleColumnMap doubleColumnMap) Increments by all values in a given DoubleColumnMap.
abstract DoubleColumnIterator	iterator() Returns an iterator over the columnId-value pairs contained in this object.
abstract void	set(int columnId, double value) Sets the value associated with a particular column ID.

Methods inherited from class java.lang.Object

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

Constructor Detail

DoubleColumnMap

public DoubleColumnMap()

Method Detail

contains

public abstract boolean contains(int columnId)

Check if this map contains the specified column.

Parameters:

columnId - the column ID to check.

Returns:

whether the map contains the given column ID.

get

public abstract double get(int columnId)

Returns the value associated with a particular column ID.

Parameters:

columnId - the column ID.

Returns:

the value associated with columnId.

set

public abstract void set(int columnId,
                         double value)

Sets the value associated with a particular column ID.

Parameters:

columnId - the column ID.

value - the value associated with columnId.

inc

public abstract void inc(int columnId,
                         double value)

Increments the current value associated with a column ID.

Parameters:

columnId - the column ID.

value - the value to increment by.

incAll

public void incAll(DoubleColumnMap doubleColumnMap)

Increments by all values in a given DoubleColumnMap.

Parameters:

doubleColumnMap - object containing all values to increment by.

clear

public abstract void clear()

Resets all values.

iterator

public abstract DoubleColumnIterator iterator()

Returns an iterator over the columnId-value pairs contained in this object.

Returns:

an iterator object.