Class ShortMatrixBuf

java.lang.Object
edu.rit.mp.Buf
edu.rit.mp.ShortBuf
edu.rit.mp.buf.ShortMatrixBuf
Direct Known Subclasses:
ShortMatrixBuf_1

public class ShortMatrixBuf extends ShortBuf
Class ShortMatrixBuf provides a buffer for a matrix of short items sent or received using the Message Protocol (MP). The matrix row and column strides may be 1 or greater than 1. While an instance of class ShortMatrixBuf may be constructed directly, normally you will use a factory method in class ShortBuf. See that class for further information.
Version:
05-Apr-2009
Author:
Alan Kaminsky
  • Constructor Details

    • ShortMatrixBuf

      public ShortMatrixBuf(short[][] theMatrix, Range theRowRange, Range theColRange)
      Construct a new short matrix buffer. It is assumed that the rows and columns of theMatrix are allocated and that each row of theMatrix has the same number of columns.
      Parameters:
      theMatrix - Matrix.
      theRowRange - Range of rows to include.
      theColRange - Range of columns to include.
  • Method Details

    • 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. 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. 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.
    • copy

      public void copy(Buf theSrc)
      Copy items from the given buffer to this buffer. The number of items copied is this buffer's length or theSrc's length, whichever is smaller. If theSrc is this buffer, the copy() method does nothing. Copy items from the given buffer to this buffer. The number of items copied is this buffer's length or theSrc's length, whichever is smaller. If theSrc is this buffer, the copy() method does nothing.

      The default implementation of the copy() method calls the defaultCopy() method. A subclass can override the copy() method to use a more efficient algorithm. Copy items from the given buffer to this buffer. The number of items copied is this buffer's length or theSrc's length, whichever is smaller. If theSrc is this buffer, the copy() method does nothing.

      Overrides:
      copy in class ShortBuf
      Parameters:
      theSrc - Source of items to copy into this buffer.
      Throws:
      ClassCastException - (unchecked exception) Thrown if theSrc's item data type is not the same as this buffer's item data type.
    • 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.
    • 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. 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. 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.