org.petuum.jbosen.table

Class FloatTable

java.lang.Object

org.petuum.jbosen.table.FloatTable

public final class FloatTable
extends java.lang.Object

An object of this class offers a view of a table that contains rows of float values. Methods of this class should only be accessed from registered worker threads. This class is thread-safe and can be shared between different worker threads. Tables of this type should be created with PsTableGroup.createDenseFloatTable(int, int, int) or PsTableGroup.createSparseFloatTable(int, int), and be retrieved with PsTableGroup.getFloatTable(int).

Constructor Summary

Constructors

Constructor and Description
FloatTable(ClientTable clientTable) Internal use only.

Method Summary

Modifier and Type	Method and Description
<RowType extends FloatRow> RowType	get(int rowId) Retrieve a row from this table.
float	get(int rowId, int columnId) Retrieve a single column from a row in this table.
void	inc(int rowId, FloatRowUpdate rowUpdate) Apply a batch update to an entire row.
void	inc(int rowId, int columnId, float update) Add a single value to a given row and column.

Methods inherited from class java.lang.Object

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

Constructor Detail

FloatTable

public FloatTable(ClientTable clientTable)

Internal use only.

Parameters:

clientTable - internal use only.

Method Detail

get

public <RowType extends FloatRow> RowType get(int rowId)

Retrieve a row from this table.

Type Parameters:

RowType - type of the row to cast to before returning.

Parameters:

rowId - ID of the row to retrieve.

Returns:

locally cached copy of the row.

See Also:

Table.get(int)

get

public float get(int rowId,
                 int columnId)

Retrieve a single column from a row in this table.

Parameters:

rowId - row ID of the value to retrieve.

columnId - column ID of the value to retrieve.

Returns:

the value at the given row and column.

inc

public void inc(int rowId,
                FloatRowUpdate rowUpdate)

Apply a batch update to an entire row.

Parameters:

rowId - ID of the row to update.

rowUpdate - update object to apply.

See Also:

Table.inc(int, RowUpdate)

inc

public void inc(int rowId,
                int columnId,
                float update)

Add a single value to a given row and column.

Parameters:

rowId - row ID of the value to increment.

columnId - column ID of the value to increment.

update - value to increment by.