org.petuum.jbosen.row.float_

Class SparseFloatColumnMap

java.lang.Object

org.petuum.jbosen.row.float_.FloatColumnMap

org.petuum.jbosen.row.float_.SparseFloatColumnMap

Direct Known Subclasses:

SparseFloatRow, SparseFloatRowUpdate

public class SparseFloatColumnMap
extends FloatColumnMap

This implementation of FloatColumnMap assumes that column IDs are sparse, ie. they can be any int value. In general, this class is less CPU and memory efficient than DenseFloatColumnMap.

Constructor Summary

Constructors

Constructor and Description
SparseFloatColumnMap() Construct a new object, this object initially contains no columns.
SparseFloatColumnMap(java.nio.ByteBuffer buffer) Construct an object by de-serializing from a ByteBuffer object.
SparseFloatColumnMap(SparseFloatColumnMap other) Copy constructor, constructs a new, deep copy of the argument.

Method Summary

Modifier and Type	Method and Description
void	clear() Resets all values.
boolean	contains(int columnId) Check if this map contains the specified column.
float	get(int columnId) Returns the value associated with a particular column ID.
void	inc(int columnId, float value) Increments the current value associated with a column ID.
FloatColumnIterator	iterator() Returns an iterator over the columnId-value pairs contained in this object.
java.util.Map<java.lang.Integer,java.lang.Float>	map() The backing map of this object, modifying this map will also modify this object.
java.nio.ByteBuffer	serialize() ByteBuffer object containing the serialized data for this object.
void	set(int columnId, float value) Sets the value associated with a particular column ID.
int	size() The number of columns this map contains.

Methods inherited from class org.petuum.jbosen.row.float_.FloatColumnMap

incAll

Methods inherited from class java.lang.Object

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

Constructor Detail

SparseFloatColumnMap

public SparseFloatColumnMap()

Construct a new object, this object initially contains no columns.

SparseFloatColumnMap

public SparseFloatColumnMap(SparseFloatColumnMap other)

Copy constructor, constructs a new, deep copy of the argument.

Parameters:

other - object to construct a deep copy of.

SparseFloatColumnMap

public SparseFloatColumnMap(java.nio.ByteBuffer buffer)

Construct an object by de-serializing from a ByteBuffer object.

Parameters:

buffer - the ByteBuffer containing the serialized data.

Method Detail

size

public int size()

The number of columns this map contains.

Returns:

number of columns this map contains.

map

public java.util.Map<java.lang.Integer,java.lang.Float> map()

The backing map of this object, modifying this map will also modify this object.

Returns:

the backing map.

serialize

public java.nio.ByteBuffer serialize()

ByteBuffer object containing the serialized data for this object.

Returns:

serialized data.

contains

public boolean contains(int columnId)

Check if this map contains the specified column.

Specified by:

contains in class FloatColumnMap

Parameters:

columnId - the column ID to check.

Returns:

whether the map contains the given column ID.

get

public float get(int columnId)

Returns the value associated with a particular column ID.

Specified by:

get in class FloatColumnMap

Parameters:

columnId - the column ID.

Returns:

the value associated with columnId.

set

public void set(int columnId,
                float value)

Sets the value associated with a particular column ID.

Specified by:

set in class FloatColumnMap

Parameters:

columnId - the column ID.

value - the value associated with columnId.

inc

public void inc(int columnId,
                float value)

Increments the current value associated with a column ID. If the column does not exist, then this value will be set.

Specified by:

inc in class FloatColumnMap

Parameters:

columnId - the column ID.

value - the value to increment by.

clear

public void clear()

Resets all values. All columns are removed from this map.

Specified by:

clear in class FloatColumnMap

iterator

public FloatColumnIterator iterator()

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

Specified by:

iterator in class FloatColumnMap

Returns:

an iterator object.