org.petuum.jbosen.row.long_

Class DenseLongColumnMap

java.lang.Object

org.petuum.jbosen.row.long_.LongColumnMap

org.petuum.jbosen.row.long_.DenseLongColumnMap

Direct Known Subclasses:

DenseLongRow, DenseLongRowUpdate

public class DenseLongColumnMap
extends LongColumnMap

This implementation of LongColumnMap assumes that column IDs are dense, ie. they are contiguous values from 0 to capacity - 1. In general, this class is more CPU and memory efficient than SparseLongColumnMap.

Constructor Summary

Constructors

Constructor and Description
DenseLongColumnMap(java.nio.ByteBuffer buffer) Construct an object by de-serializing from a ByteBuffer object.
DenseLongColumnMap(DenseLongColumnMap other) Copy constructor, constructs a new, deep copy of the argument.
DenseLongColumnMap(int capacity) Construct a new object based on a capacity.

Method Summary

Modifier and Type	Method and Description
long[]	array() The backing array of this object, modifying this array will also modify this object.
int	capacity() The capacity of the object.
void	clear() Resets all values.
boolean	contains(int columnId) Check if this map contains the specified column.
long	get(int columnId) Returns the value associated with a particular column ID.
void	inc(int columnId, long value) Increments the current value associated with a column ID.
LongColumnIterator	iterator() Returns an iterator over the columnId-value pairs contained in this object.
java.nio.ByteBuffer	serialize() ByteBuffer object containing the serialized data for this object.
void	set(int columnId, long value) Sets the value associated with a particular column ID.

Methods inherited from class org.petuum.jbosen.row.long_.LongColumnMap

incAll

Methods inherited from class java.lang.Object

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

Constructor Detail

DenseLongColumnMap

public DenseLongColumnMap(int capacity)

Construct a new object based on a capacity. this capacity cannot change throughout the lifetime of this object.

Parameters:

capacity - the capacity of this object, must be strictly positive.

DenseLongColumnMap

public DenseLongColumnMap(DenseLongColumnMap other)

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

Parameters:

other - object to construct a deep copy of.

DenseLongColumnMap

public DenseLongColumnMap(java.nio.ByteBuffer buffer)

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

Parameters:

buffer - the ByteBuffer containing the serialized data.

Method Detail

capacity

public int capacity()

The capacity of the object.

Returns:

the capacity.

array

public long[] array()

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

Returns:

the backing array.

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. This map will always contain column IDs that are from 0 to capacity - 1, and will always not contain any other column IDs.

Specified by:

contains in class LongColumnMap

Parameters:

columnId - the column ID to check.

Returns:

whether the map contains the given column ID.

get

public long get(int columnId)

Returns the value associated with a particular column ID. Will throw a run-time exception if columnId is out-of-bounds.

Specified by:

get in class LongColumnMap

Parameters:

columnId - the column ID.

Returns:

the value associated with columnId.

set

public void set(int columnId,
                long value)

Sets the value associated with a particular column ID. Will throw a run-time exception if columnId is out-of-bounds.

Specified by:

set in class LongColumnMap

Parameters:

columnId - the column ID.

value - the value associated with columnId.

inc

public void inc(int columnId,
                long value)

Increments the current value associated with a column ID. Will throw a run-time exception if columnId is out-of-bounds.

Specified by:

inc in class LongColumnMap

Parameters:

columnId - the column ID.

value - the value to increment by.

clear

public void clear()

Resets all values. All columns are set to zero.

Specified by:

clear in class LongColumnMap

iterator

public LongColumnIterator iterator()

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

Specified by:

iterator in class LongColumnMap

Returns:

an iterator object.