Package edu.rit.mp.buf

Class ObjectItemBuf<T>

java.lang.Object

edu.rit.mp.Buf

edu.rit.mp.ObjectBuf<T>

edu.rit.mp.buf.ObjectItemBuf<T>

Type Parameters:

T - Data type of the objects in the buffer.

public class ObjectItemBuf<T>
extends ObjectBuf<T>

Class ObjectItemBuf provides a buffer for a single object item sent or received using the Message Protocol (MP). While an instance of class ObjectItemBuf may be constructed directly, normally you will use a factory method in class ObjectBuf. See that class for further information.

Version:

23-Mar-2009

Author:

Alan Kaminsky

Field Summary

Fields

Modifier and Type	Field	Description
T	item	Object item to be sent or received.

Fields inherited from class edu.rit.mp.ObjectBuf

mySerializedItems

Fields inherited from class edu.rit.mp.Buf

myLength

Constructor Summary

Constructors

Constructor	Description
ObjectItemBuf()	Construct a new object item buffer.
ObjectItemBuf(T item)	Construct a new object item buffer with the given initial value.

Method Summary

Modifier and Type	Method	Description
T	get(int i)	Obtain the given item from this buffer.
Buf	getReductionBuf(Op op)	Create a buffer for performing parallel reduction using the given binary operation.
void	put(int i, T item)	Store the given item in this buffer.

Methods inherited from class edu.rit.mp.ObjectBuf

buffer, buffer, buffer, buffer, buffer, buffer, colSliceBuffer, colSliceBuffers, copy, defaultCopy, emptyBuffer, fill, getTemporaryBuf, objectBuffer, objectBuffer, patchBuffer, patchBuffers, receiveItems, reset, rowSliceBuffer, rowSliceBuffers, sendItems, sliceBuffer, sliceBuffer, sliceBuffers, sliceBuffers

Methods inherited from class edu.rit.mp.Buf

length

Methods inherited from class java.lang.Object

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

Field Details

item

public T item

Object item to be sent or received.

Constructor Details

ObjectItemBuf

public ObjectItemBuf()

Construct a new object item buffer.

ObjectItemBuf

public ObjectItemBuf(T item)

Construct a new object item buffer with the given initial value.

Parameters:

item - Initial value of the item field.

Method Details

get

public T get(int i)

Obtain the given item from this buffer.

The get() method must not block the calling thread; if it does, all message I/O in MP will be blocked. Obtain the given item from this buffer.

The get() method must not block the calling thread; if it does, all message I/O in MP will be blocked.

Specified by:

get in class ObjectBuf<T>

Parameters:

i - Item index in the range 0 .. length()-1.

Returns:

Item at index i.

put

public void put(int i,
 T item)

Store the given item in this buffer.

The put() method must not block the calling thread; if it does, all message I/O in MP will be blocked.

Specified by:

put in class ObjectBuf<T>

Parameters:

i - Item index in the range 0 .. length()-1.

item - Item to be stored at index i.

getReductionBuf

public Buf getReductionBuf(Op op)

Create a buffer for performing parallel reduction using the given binary operation. The results of the reduction are placed into this buffer.

Operations performed on the returned reduction buffer have the same effect as operations performed on this buffer, except whenever a source item S is put into a destination item D in this buffer, D is set to D op S, that is, the reduction of D and S using the given binary operation (rather than just setting D to S). Create a buffer for performing parallel reduction using the given binary operation. The results of the reduction are placed into this buffer.

Specified by:

getReductionBuf in class Buf

Parameters:

op - Binary operation.

Returns:

a Buf object.

Throws:

ClassCastException - (unchecked exception) Thrown if this buffer's element data type and the given binary operation's argument data type are not the same.