edu.rit.mp.buf
Class SharedShortArrayBuf

java.lang.Object
  edu.rit.mp.Buf
      edu.rit.mp.ShortBuf
          edu.rit.mp.buf.SharedShortArrayBuf

Direct Known Subclasses:

SharedShortArrayBuf_1

public class SharedShortArrayBuf
extends ShortBuf

Class SharedShortArrayBuf provides a buffer for a multiple thread safe array of short items sent or received using the Message Protocol (MP). The array element stride may be 1 or greater than 1. While an instance of class SharedShortArrayBuf may be constructed directly, normally you will use a factory method in class ShortBuf. See that class for further information.

Field Summary

Fields inherited from class edu.rit.mp.Buf

myLength

Constructor Summary

SharedShortArrayBuf(SharedShortArray theArray, Range theRange)
Construct a new shared short array buffer.

Method Summary

short	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, short item) Store the given item in this buffer.
protected int	receiveItems(int i, int num, ByteBuffer buffer) Receive as many items as possible from the given byte buffer to this buffer.
protected int	sendItems(int i, ByteBuffer buffer) Send as many items as possible from this buffer to the given byte buffer.

Methods inherited from class edu.rit.mp.ShortBuf

buffer, buffer, buffer, buffer, buffer, buffer, colSliceBuffer, colSliceBuffers, copy, defaultCopy, emptyBuffer, fill, getTemporaryBuf, patchBuffer, patchBuffers, rowSliceBuffer, rowSliceBuffers, 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

Constructor Detail

SharedShortArrayBuf

public SharedShortArrayBuf(SharedShortArray theArray,
                           Range theRange)

Construct a new shared short array buffer.

Parameters:

theArray - Shared array.

theRange - Range of array elements to include in the buffer.

Method Detail

get

public short 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.

Specified by:

get in class ShortBuf

Parameters:

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

Returns:

Item at index i.

put

public void put(int i,
                short 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 ShortBuf

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.

Specified by:

getReductionBuf in class Buf

Parameters:

op - Binary operation.

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.

sendItems

protected int sendItems(int i,
                        ByteBuffer buffer)

Send as many items as possible from this buffer to the given byte buffer.

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

Specified by:

sendItems in class Buf

Parameters:

i - Index of first item to send, in the range 0 .. length-1.

buffer - Byte buffer.

Returns:

Number of items sent.

receiveItems

protected int receiveItems(int i,
                           int num,
                           ByteBuffer buffer)

Receive as many items as possible from the given byte buffer to this buffer.

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

Specified by:

receiveItems in class Buf

Parameters:

i - Index of first item to receive, in the range 0 .. length-1.

num - Maximum number of items to receive.

buffer - Byte buffer.

Returns:

Number of items received.