1 //******************************************************************************
2 //
3 // File: ObjectMatrixBuf_1.java
4 // Package: edu.rit.mp.buf
5 // Unit: Class edu.rit.mp.buf.ObjectMatrixBuf_1
6 //
7 // This Java source file is copyright (C) 2009 by Alan Kaminsky. All rights
8 // reserved. For further information, contact the author, Alan Kaminsky, at
9 // ark@cs.rit.edu.
10 //
11 // This Java source file is part of the Parallel Java Library ("PJ"). PJ is free
12 // software; you can redistribute it and/or modify it under the terms of the GNU
13 // General Public License as published by the Free Software Foundation; either
14 // version 3 of the License, or (at your option) any later version.
15 //
16 // PJ is distributed in the hope that it will be useful, but WITHOUT ANY
17 // WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
18 // A PARTICULAR PURPOSE. See the GNU General Public License for more details.
19 //
20 // Linking this library statically or dynamically with other modules is making a
21 // combined work based on this library. Thus, the terms and conditions of the GNU
22 // General Public License cover the whole combination.
23 //
24 // As a special exception, the copyright holders of this library give you
25 // permission to link this library with independent modules to produce an
26 // executable, regardless of the license terms of these independent modules, and
27 // to copy and distribute the resulting executable under terms of your choice,
28 // provided that you also meet, for each linked independent module, the terms
29 // and conditions of the license of that module. An independent module is a module
30 // which is not derived from or based on this library. If you modify this library,
31 // you may extend this exception to your version of the library, but you are not
32 // obligated to do so. If you do not wish to do so, delete this exception
33 // statement from your version.
34 //
35 // A copy of the GNU General Public License is provided in the file gpl.txt. You
36 // may also obtain a copy of the GNU General Public License on the World Wide
37 // Web at http://www.gnu.org/licenses/gpl.html.
38 //
39 //******************************************************************************
40 package edu.rit.mp.buf;
41
42 import edu.rit.mp.Buf;
43 import edu.rit.pj.reduction.ObjectOp;
44 import edu.rit.pj.reduction.Op;
45 import edu.rit.util.Range;
46
47 /**
48 * Class ObjectMatrixBuf_1 provides a buffer for a matrix of object items sent
49 * or received using the Message Protocol (MP). The matrix row and column
50 * strides must both be 1. While an instance of class ObjectMatrixBuf_1 may be
51 * constructed directly, normally you will use a factory method in class
52 * {@linkplain edu.rit.mp.ObjectBuf ObjectBuf}. See that class for further
53 * information.
54 *
55 * @param <T> Data type of the objects in the buffer.
56 * @author Alan Kaminsky
57 * @version 23-Mar-2009
58 */
59 @SuppressWarnings("unchecked")
60 public class ObjectMatrixBuf_1<T>
61 extends ObjectMatrixBuf<T> {
62
63 // Exported constructors.
64 /**
65 * Construct a new object matrix buffer. It is assumed that the rows and
66 * columns of <code>theMatrix</code> are allocated and that each row of
67 * <code>theMatrix</code> has the same number of columns.
68 *
69 * @param theMatrix Matrix.
70 * @param theRowRange Range of rows to include. The stride is assumed to be
71 * 1.
72 * @param theColRange Range of columns to include. The stride is assumed to
73 * be 1.
74 */
75 public ObjectMatrixBuf_1(T[][] theMatrix,
76 Range theRowRange,
77 Range theColRange) {
78 super(theMatrix, theRowRange, theColRange);
79 }
80
81 // Exported operations.
82 /**
83 * {@inheritDoc}
84 *
85 * Obtain the given item from this buffer.
86 * <P>
87 * The <code>get()</code> method must not block the calling thread; if it does,
88 * all message I/O in MP will be blocked.
89 */
90 public T get(int i) {
91 return myMatrix[i2r(i) + myLowerRow][i2c(i) + myLowerCol];
92 }
93
94 /**
95 * Store the given item in this buffer.
96 * <P>
97 * The <code>put()</code> method must not block the calling thread; if it does,
98 * all message I/O in MP will be blocked.
99 *
100 * @param i Item index in the range 0 .. <code>length()</code>-1.
101 * @param item Item to be stored at index <code>i</code>.
102 */
103 public void put(int i,
104 T item) {
105 myMatrix[i2r(i) + myLowerRow][i2c(i) + myLowerCol] = item;
106 reset();
107 }
108
109 /**
110 * {@inheritDoc}
111 *
112 * Create a buffer for performing parallel reduction using the given binary
113 * operation. The results of the reduction are placed into this buffer.
114 * @exception ClassCastException (unchecked exception) Thrown if this
115 * buffer's element data type and the given binary operation's argument data
116 * type are not the same.
117 */
118 public Buf getReductionBuf(Op op) {
119 return new ObjectMatrixReductionBuf_1<T>(myMatrix, myRowRange, myColRange, (ObjectOp<T>) op, this);
120 }
121
122 }