PsTableGroup (jbosen 1.0 API)

java.lang.Object
- org.petuum.jbosen.PsTableGroup

```
public final class PsTableGroup
extends java.lang.Object
```
This class is the main interface to the Bosen PS. All of it's methods are static, so a single process only has access to a global instance. An application using this interface is expected to perform the following:
1. Construct a PsConfig object with the appropriate configuration parameters.
2. Call init(PsConfig).
3. Create the necessary tables, and perform other initialization tasks such as data loading.
4. Spawn PsConfig.numLocalWorkerThreads threads, each must first call registerWorkerThread(), do some application defined work, and end with calling deregisterWorkerThread().
5. Call shutdown().

Constructor Summary

Constructors
Constructor and Description

PsTableGroup()

Constructors
Constructor and Description
`PsTableGroup()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`clock()` Advance the clock for the calling application thread.
`static void`	`createDenseDoubleTable(int tableId, int staleness, int rowCapacity)` Creates a dense double table, which can later be retrieved using `getDoubleTable`.
`static void`	`createDenseFloatTable(int tableId, int staleness, int rowCapacity)` Creates a dense float table, which can later be retrieved using `getFloatTable`.
`static void`	`createDenseIntTable(int tableId, int staleness, int rowCapacity)` Creates a dense int table, which can later be retrieved using `getIntTable`.
`static void`	`createDenseLongTable(int tableId, int staleness, int rowCapacity)` Creates a dense long table, which can later be retrieved using `getLongTable`.
`static void`	`createSparseDoubleTable(int tableId, int staleness)` Creates a sparse double table, which can later be retrieved using `getDoubleTable`.
`static void`	`createSparseFloatTable(int tableId, int staleness)` Creates a sparse float table, which can later be retrieved using `getFloatTable`.
`static void`	`createSparseIntTable(int tableId, int staleness)` Creates a sparse int table, which can later be retrieved using `getIntTable`.
`static void`	`createSparseLongTable(int tableId, int staleness)` Creates a sparse long table, which can later be retrieved using `getLongTable`.
`static void`	`createTable(int tableId, int staleness, RowFactory rowFactory, RowUpdateFactory rowUpdateFactory)` Creates a Bosen PS table.
`static void`	`deregisterWorkerThread()` De-registers an application worker thread.
`static int`	`getClientId()` Returns the ID of this client.
`static DoubleTable`	`getDoubleTable(int tableId)` Retrieves a table that was created using `createDenseDoubleTable` or `createSparseDoubleTable`.
`static FloatTable`	`getFloatTable(int tableId)` Retrieves a table that was created using `createDenseFloatTable` or `createSparseFloatTable`.
`static IntTable`	`getIntTable(int tableId)` Retrieves a table that was created using `createDenseIntTable` or `createSparseIntTable`.
`static LongTable`	`getLongTable(int tableId)` Retrieves a table that was created using `createDenseLongTable` or `createSparseLongTable`.
`static int`	`getNumClients()` Returns the total number of Bosen PS clients.
`static int`	`getNumLocalWorkerThreads()` Returns the number of worker threads that run on each client.
`static int`	`getNumTotalWorkerThreads()` Returns the total number of worker threads across all clients.
`static Table`	`getTable(int tableId)` Retrieves a table that was created before worker threads are registered.
`static void`	`globalBarrier()` Threads that calls this method must be at the same clock.
`static void`	`init(PsConfig config)` Initialize the global Bosen PS environment.
`static int`	`registerWorkerThread()` Register an application worker thread.
`static void`	`shutdown()` Shuts down the global Bosen PS environment.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PsTableGroup
```
public PsTableGroup()
```
- Method Detail
  - init
```
public static void init(PsConfig config)
```
    Initialize the global Bosen PS environment. This method must be called before any other PsTableGroup interface methods can be accessed. This method must be called exactly once per client.
    
    Parameters:
    
    config - configuration options for the Bosen PS.
  - shutdown
```
public static void shutdown()
```
    Shuts down the global Bosen PS environment. This method must be called after all computations are complete in order to properly shut down all background tasks. This method must be called exactly once per client, after all worker threads have been de-registered.
  - getClientId
```
public static int getClientId()
```
    Returns the ID of this client. Can only be used after init(PsConfig) has been called.
    
    Returns:
    
    the client ID, from 0 to numClients - 1, inclusive.
  - getNumClients
```
public static int getNumClients()
```
    Returns the total number of Bosen PS clients. Can only be used after init(PsConfig) has been called.
    
    Returns:
    
    total number of clients.
  - getNumLocalWorkerThreads
```
public static int getNumLocalWorkerThreads()
```
    Returns the number of worker threads that run on each client. Can only be used after init(PsConfig) has been called.
    
    Returns:
    
    number of local worker threads.
  - getNumTotalWorkerThreads
```
public static int getNumTotalWorkerThreads()
```
    Returns the total number of worker threads across all clients. This value should be equal to numClients * numLocalWorkerThreads. Can only be used after init(PsConfig) has been called.
    
    Returns:
    
    total number of worker threads.
  - createTable
```
public static void createTable(int tableId,
                               int staleness,
                               RowFactory rowFactory,
                               RowUpdateFactory rowUpdateFactory)
```
    Creates a Bosen PS table. This method is meant for those who wish to define their own custom rows and row updates. Otherwise, using the create[Dense/Sparse][Double/Float/Int/Long]Table methods are recommended. This method must be called by each client in order to create the table. This method can only be called after PsTableGroup is initialized and before any worker thread is registered.
    
    Parameters:
    
    tableId - int ID of this table.
    
    staleness - SSP staleness parameter.
    
    rowFactory - object used to produce rows.
    
    rowUpdateFactory - object used to produce row updates.
  - getTable
```
public static Table getTable(int tableId)
```
    Retrieves a table that was created before worker threads are registered. This method can only be called from inside of registered worker threads.
    
    Parameters:
    
    tableId - ID of the table to retrieve.
    
    Returns:
    
    object used to access the table.
  - createDenseDoubleTable
```
public static void createDenseDoubleTable(int tableId,
                                          int staleness,
                                          int rowCapacity)
```
    Creates a dense double table, which can later be retrieved using getDoubleTable. This method must be called by each client in order to create the table. This method can only be called after PsTableGroup is initialized and before any worker thread is registered.
    
    Parameters:
    
    tableId - int ID of this table.
    
    staleness - SSP staleness parameter.
    
    rowCapacity - capacity of the stored rows.
  - createSparseDoubleTable
```
public static void createSparseDoubleTable(int tableId,
                                           int staleness)
```
    Creates a sparse double table, which can later be retrieved using getDoubleTable. This method must be called by each client in order to create the table. This method can only be called after PsTableGroup is initialized and before any worker thread is registered.
    
    Parameters:
    
    tableId - int ID of this table.
    
    staleness - SSP staleness parameter.
  - getDoubleTable
```
public static DoubleTable getDoubleTable(int tableId)
```
    Retrieves a table that was created using createDenseDoubleTable or createSparseDoubleTable. This method can only be called from inside of registered worker threads.
    
    Parameters:
    
    tableId - ID of the table to retrieve.
    
    Returns:
    
    object used to access the table.
  - createDenseFloatTable
```
public static void createDenseFloatTable(int tableId,
                                         int staleness,
                                         int rowCapacity)
```
    Creates a dense float table, which can later be retrieved using getFloatTable. This method must be called by each client in order to create the table. This method can only be called after PsTableGroup is initialized and before any worker thread is registered.
    
    Parameters:
    
    tableId - int ID of this table.
    
    staleness - SSP staleness parameter.
    
    rowCapacity - capacity of the stored rows.
  - createSparseFloatTable
```
public static void createSparseFloatTable(int tableId,
                                          int staleness)
```
    Creates a sparse float table, which can later be retrieved using getFloatTable. This method must be called by each client in order to create the table. This method can only be called after PsTableGroup is initialized and before any worker thread is registered.
    
    Parameters:
    
    tableId - int ID of this table.
    
    staleness - SSP staleness parameter.
  - getFloatTable
```
public static FloatTable getFloatTable(int tableId)
```
    Retrieves a table that was created using createDenseFloatTable or createSparseFloatTable. This method can only be called from inside of registered worker threads.
    
    Parameters:
    
    tableId - ID of the table to retrieve.
    
    Returns:
    
    object used to access the table.
  - createDenseIntTable
```
public static void createDenseIntTable(int tableId,
                                       int staleness,
                                       int rowCapacity)
```
    Creates a dense int table, which can later be retrieved using getIntTable. This method must be called by each client in order to create the table. This method can only be called after PsTableGroup is initialized and before any worker thread is registered.
    
    Parameters:
    
    tableId - int ID of this table.
    
    staleness - SSP staleness parameter.
    
    rowCapacity - capacity of the stored rows.
  - createSparseIntTable
```
public static void createSparseIntTable(int tableId,
                                        int staleness)
```
    Creates a sparse int table, which can later be retrieved using getIntTable. This method must be called by each client in order to create the table. This method can only be called after PsTableGroup is initialized and before any worker thread is registered.
    
    Parameters:
    
    tableId - int ID of this table.
    
    staleness - SSP staleness parameter.
  - getIntTable
```
public static IntTable getIntTable(int tableId)
```
    Retrieves a table that was created using createDenseIntTable or createSparseIntTable. This method can only be called from inside of registered worker threads.
    
    Parameters:
    
    tableId - ID of the table to retrieve.
    
    Returns:
    
    object used to access the table.
  - createDenseLongTable
```
public static void createDenseLongTable(int tableId,
                                        int staleness,
                                        int rowCapacity)
```
    Creates a dense long table, which can later be retrieved using getLongTable. This method must be called by each client in order to create the table. This method can only be called after PsTableGroup is initialized and before any worker thread is registered.
    
    Parameters:
    
    tableId - int ID of this table.
    
    staleness - SSP staleness parameter.
    
    rowCapacity - capacity of the stored rows.
  - createSparseLongTable
```
public static void createSparseLongTable(int tableId,
                                         int staleness)
```
    Creates a sparse long table, which can later be retrieved using getLongTable. This method must be called by each client in order to create the table. This method can only be called after PsTableGroup is initialized and before any worker thread is registered.
    
    Parameters:
    
    tableId - int ID of this table.
    
    staleness - SSP staleness parameter.
  - getLongTable
```
public static LongTable getLongTable(int tableId)
```
    Retrieves a table that was created using createDenseLongTable or createSparseLongTable. This method can only be called from inside of registered worker threads.
    
    Parameters:
    
    tableId - ID of the table to retrieve.
    
    Returns:
    
    object used to access the table.
  - registerWorkerThread
```
public static int registerWorkerThread()
```
    Register an application worker thread. This must be called by each worker thread after table creation and before accessing any tables.
    
    Returns:
    
    the local thread ID of the registered thread, from 0 to numLocalWorkerThreads - 1, inclusive.
  - deregisterWorkerThread
```
public static void deregisterWorkerThread()
```
    De-registers an application worker thread. Each worker thread is expected to call this before exiting. The system can only be shut down when all worker threads have de-registered themselves.
  - clock
```
public static void clock()
```
    Advance the clock for the calling application thread. This method can only be called while a worker thread is registered.
  - globalBarrier
```
public static void globalBarrier()
```
    Threads that calls this method must be at the same clock. This method blocks until all worker threads on all clients have called it as well. After this method returns, the worker thread is guaranteed to see the most recent updates to each table. This method can only be called while a worker thread is registered.

Class PsTableGroup

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PsTableGroup

Method Detail

init

shutdown

getClientId

getNumClients

getNumLocalWorkerThreads

getNumTotalWorkerThreads

createTable

getTable

createDenseDoubleTable

createSparseDoubleTable

getDoubleTable

createDenseFloatTable

createSparseFloatTable

getFloatTable

createDenseIntTable

createSparseIntTable

getIntTable

createDenseLongTable

createSparseLongTable

getLongTable

registerWorkerThread

deregisterWorkerThread

clock

globalBarrier