1 //******************************************************************************
2 //
3 // File: Unsigned8BitIntegerMatrixReductionBuf_1.java
4 // Package: edu.rit.mp.buf
5 // Unit: Class edu.rit.mp.buf.Unsigned8BitIntegerMatrixReductionBuf_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 java.nio.ByteBuffer;
43
44 import edu.rit.mp.Buf;
45 import edu.rit.mp.Unsigned8BitIntegerBuf;
46 import edu.rit.pj.reduction.IntegerOp;
47 import edu.rit.pj.reduction.Op;
48 import edu.rit.pj.reduction.ReduceArrays;
49 import edu.rit.util.Range;
50
51 /**
52 * Class Unsigned8BitIntegerMatrixReductionBuf_1 provides a reduction buffer for
53 * class {@linkplain Unsigned8BitIntegerMatrixBuf_1}.
54 *
55 * @author Alan Kaminsky
56 * @version 05-Apr-2009
57 */
58 class Unsigned8BitIntegerMatrixReductionBuf_1
59 extends Unsigned8BitIntegerMatrixBuf_1 {
60
61 // Hidden data members.
62 IntegerOp myOp;
63
64 // Exported constructors.
65 /**
66 * Construct a new unsigned 8-bit integer matrix reduction buffer. It is
67 * assumed that the rows and columns of <code>theMatrix</code> are allocated and
68 * that each row of <code>theMatrix</code> has the same number of columns.
69 *
70 * @param theMatrix Matrix.
71 * @param theRowRange Range of rows to include. The stride is assumed to be
72 * 1.
73 * @param theColRange Range of columns to include. The stride is assumed to
74 * be 1.
75 * @param op Binary operation.
76 * @exception NullPointerException (unchecked exception) Thrown if
77 * <code>op</code> is null.
78 */
79 public Unsigned8BitIntegerMatrixReductionBuf_1(int[][] theMatrix,
80 Range theRowRange,
81 Range theColRange,
82 IntegerOp op) {
83 super(theMatrix, theRowRange, theColRange);
84 if (op == null) {
85 throw new NullPointerException("Unsigned8BitIntegerMatrixReductionBuf_1(): op is null");
86 }
87 myOp = op;
88 }
89
90 // Exported operations.
91 /**
92 * {@inheritDoc}
93 *
94 * Store the given item in this buffer.
95 * <P>
96 * The <code>put()</code> method must not block the calling thread; if it does,
97 * all message I/O in MP will be blocked.
98 */
99 public void put(int i,
100 int item) {
101 int row = (i / myColCount) + myLowerRow;
102 int col = (i % myColCount) + myLowerCol;
103 myMatrix[row][col] = myOp.op(myMatrix[row][col], item);
104 }
105
106 /**
107 * {@inheritDoc}
108 *
109 * Copy items from the given buffer to this buffer. The number of items
110 * copied is this buffer's length or <code>theSrc</code>'s length, whichever is
111 * smaller. If <code>theSrc</code> is this buffer, the <code>copy()</code> method
112 * does nothing.
113 * @exception ClassCastException (unchecked exception) Thrown if
114 * <code>theSrc</code>'s item data type is not the same as this buffer's item
115 * data type.
116 */
117 public void copy(Buf theSrc) {
118 if (theSrc == this) {
119 } else if (theSrc instanceof Unsigned8BitIntegerMatrixBuf) {
120 Unsigned8BitIntegerMatrixBuf src
121 = (Unsigned8BitIntegerMatrixBuf) theSrc;
122 ReduceArrays.reduce(src.myMatrix, src.myRowRange, src.myColRange,
123 this.myMatrix, this.myRowRange, this.myColRange,
124 myOp);
125 } else {
126 Unsigned8BitIntegerBuf.defaultCopy((Unsigned8BitIntegerBuf) theSrc, this);
127 }
128 }
129
130 /**
131 * {@inheritDoc}
132 *
133 * Create a buffer for performing parallel reduction using the given binary
134 * operation. The results of the reduction are placed into this buffer.
135 * @exception ClassCastException (unchecked exception) Thrown if this
136 * buffer's element data type and the given binary operation's argument data
137 * type are not the same.
138 */
139 public Buf getReductionBuf(Op op) {
140 throw new UnsupportedOperationException();
141 }
142
143 // Hidden operations.
144 /**
145 * {@inheritDoc}
146 *
147 * Receive as many items as possible from the given byte buffer to this
148 * buffer.
149 * <P>
150 * The <code>receiveItems()</code> method must not block the calling thread; if
151 * it does, all message I/O in MP will be blocked.
152 */
153 protected int receiveItems(int i,
154 int num,
155 ByteBuffer buffer) {
156 num = Math.min(num, buffer.remaining());
157 int n = 0;
158 int r = i2r(i);
159 int row = r + myLowerRow;
160 int c = i2c(i);
161 int col = c + myLowerCol;
162 int ncols = Math.min(myColCount - c, num);
163 while (r < myRowCount && ncols > 0) {
164 int[] myMatrix_row = myMatrix[row];
165 for (c = 0; c < ncols; ++c) {
166 myMatrix_row[col]
167 = myOp.op(myMatrix_row[col], buffer.get() & 0xFF);
168 ++col;
169 }
170 num -= ncols;
171 n += ncols;
172 ++r;
173 ++row;
174 col = myLowerCol;
175 ncols = Math.min(myColCount, num);
176 }
177 return n;
178 }
179
180 }