forked from LLNL/libROM
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Matrix.h
409 lines (380 loc) · 12.7 KB
/
Matrix.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
/******************************************************************************
*
* Copyright (c) 2013-2016, Lawrence Livermore National Security, LLC.
* Produced at the Lawrence Livermore National Laboratory
* Written by William Arrighi [email protected]
* CODE-686965
* All rights reserved.
*
* This file is part of libROM.
* For details, see https://computation.llnl.gov/librom
* Please also read README_BSD_NOTICE.
*
* Redistribution and use in source and binary forms, with or without
* modifications, are permitted provided that the following conditions are met:
*
* o Redistributions of source code must retain the above copyright notice,
* this list of conditions and the disclaimer below.
* o Redistribution in binary form must reproduce the above copyright
* notice, this list of conditions and the disclaimer (as noted below) in
* the documentation and/or other materials provided with the
* distribution.
* o Neither the name of the LLNS/LLNL nor the names of its contributors may
* be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL LAWRENCE LIVERMORE NATIONAL SECURITY,
* LLC, THE U.S. DEPARTMENT OF ENERGY OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OR SUCH DAMAGE.
*
*****************************************************************************/
// Description: A simple, parallel Matrix class with the utility needed to
// support the basis generation methods of this library. A
// distributed Matrix has its rows distributed across processors.
#ifndef included_Matrix_h
#define included_Matrix_h
#include "Vector.h"
namespace CAROM {
/**
* A simple matrix class in which the rows may be distributed across multuple
* processes. This class supports only the basic operations that are needed by
* the SVD library.
*/
class Matrix
{
public:
/** Constructor creating a Matrix with uninitialized values.
*
* @pre num_rows > 0
* @pre num_cols > 0
*
* @param[in] num_rows When undistributed, the total number of rows of
* the Matrix. When distributed, the part of the
* total number of rows of the Matrix on this
* processor.
* @param[in] num_cols The total number of columns of the Matrix.
* @param[in] distributed If true the rows of the Matrix are spread over
* all processors.
*/
Matrix(
int num_rows,
int num_cols,
bool distributed);
/** Constructor creating a Matrix with uninitialized values.
*
* @pre mat != 0
* @pre num_rows > 0
* @pre num_cols > 0
*
* @param[in] mat The initial values of the Matrix.
* @param[in] num_rows When undistributed, the total number of rows of
* the Matrix. When distributed, the part of the
* total number of rows of the Matrix on this
* processor.
* @param[in] num_cols The total number of columns of the Matrix.
* @param[in] distributed If true the rows of the Matrix are spread over
* all processors.
*/
Matrix(
const double* mat,
int num_rows,
int num_cols,
bool distributed);
/**
* @brief Copy constructor.
*
* @param[in] other The Matrix to copy.
*/
Matrix(
const Matrix& other);
/**
* @brief Destructor.
*/
~Matrix();
/**
* @brief Assignment operator.
*
* @param[in] rhs The Matrix to assign to this.
*
* @return This after rhs has been assigned to it.
*/
Matrix&
operator = (
const Matrix& rhs);
/**
* @brief Returns true if the Matrix is distributed.
*
* @return True if the Matrix is distributed.
*/
bool
distributed() const
{
return d_distributed;
}
/**
* @brief Returns the number of rows of the Matrix on this processor.
*
* @return The number of rows of the Matrix on this processor.
*/
int
numRows() const
{
return d_num_rows;
}
/**
* @brief Returns the number of columns in the Matrix.
*
* This method will return the same value from each processor.
*
* @return The number of columns of the Matrix.
*/
int
numColumns() const
{
return d_num_cols;
}
/**
* @brief Multiplies this Matrix with other and returns the product,
* reference version.
*
* Supports multiplication of two undistributed matrices returning an
* undistributed Matrix, and multiplication of a distributed Matrix with
* an undistributed Matrix returning a distributed Matrix.
*
* @pre !other.distributed()
* @pre numColumns() == other.numRows()
*
* @param[in] other The Matrix to multiply with this.
*
* @return The product Matrix.
*/
Matrix*
mult(
const Matrix& other) const;
/**
* @brief Multiplies this Matrix with other and returns the product,
* pointer version.
*
* Supports multiplication of two undistributed matrices returning an
* undistributed Matrix, and multiplication of a distributed Matrix with
* an undistributed Matrix returning a distributed Matrix.
*
* @pre other != 0
* @pre !other->distributed()
* @pre numColumns() == other->numRows()
*
* @param[in] other The Matrix to multiply with this.
*
* @return The product Matrix.
*/
Matrix*
mult(
const Matrix* const other) const
{
CAROM_ASSERT(other != 0);
CAROM_ASSERT(!other->distributed());
CAROM_ASSERT(numColumns() == other->numRows());
return mult(*other);
}
/**
* @brief Multiplies this Matrix with other and returns the product,
* reference version.
*
* Supports multiplication of a distributed Matrix and an undistributed
* Vector returning a distributed Vector.
*
* @pre distributed() && !other.distributed()
* @pre numColumns() == other.dim()
*
* @param[in] other The Vector to multiply with this.
*
* @return The product Vector.
*/
Vector*
mult(
const Vector& other) const;
/**
* @brief Multiplies this Matrix with other and returns the product,
* pointer version.
*
* Supports multiplication of a distributed Matrix and an undistributed
* Vector returning a distributed Vector.
*
* @pre other != 0
* @pre distributed() && !other->distributed()
* @pre numColumns() == other->dim()
*
* @param[in] other The Vector to multiply with this.
*
* @return The product Vector.
*/
Vector*
mult(
const Vector* const other) const
{
CAROM_ASSERT(other != 0);
CAROM_ASSERT(distributed() && !other->distributed());
CAROM_ASSERT(numColumns() == other->dim());
return mult(*other);
}
/**
* @brief Multiplies the transpose of this Matrix with other and returns
* the product, reference version.
*
* Supports multiplication of two undistributed matrices returning an
* undistributed Matrix or two distributed matrices returning an
* undistributed Matrix.
*
* @pre distributed() == other.distributed()
* @pre numRows() == other.numRows()
*
* @param[in] other The Matrix to multiply with this.
*
* @return The product Matrix.
*/
Matrix*
transposeMult(
const Matrix& other) const;
/**
* @brief Multiplies the transpose of this Matrix with other and returns
* the product, pointer version.
*
* Supports multiplication of two undistributed matrices returning an
* undistributed Matrix or two distributed matrices returning an
* undistributed Matrix.
*
* @pre other != 0
* @pre distributed() == other->distributed()
* @pre numRows() == other->numRows()
*
* @param[in] other The Matrix to multiply with this.
*
* @return The product Matrix.
*/
Matrix*
transposeMult(
const Matrix* const other) const
{
CAROM_ASSERT(other != 0);
CAROM_ASSERT(distributed() == other->distributed());
CAROM_ASSERT(numRows() == other->numRows());
return transposeMult(*other);
}
/**
* @brief Multiplies the transpose of this Matrix with other and returns
* the product, reference version.
*
* Supports multiplication of a distributed Matrix and a distributed
* Vector returning an undistributed Vector.
*
* @pre distributed() && other.distributed()
* @pre numRows() == other.dim();
*
* @param[in] other The Vector to multiply with this.
*
* @return The product Vector.
*/
Vector*
transposeMult(
const Vector& other) const;
/**
* @brief Multiplies the transpose of this Matrix with other and returns
* the product, pointer version.
*
* Supports multiplication of a distributed Matrix and a distributed
* Vector returning an undistributed Vector.
*
* @pre other != 0
* @pre distributed() && other->distributed()
* @pre numRows() == other->dim();
*
* @param[in] other The Vector to multiply with this.
*
* @return The product Vector.
*/
Vector*
transposeMult(
const Vector* const other) const
{
CAROM_ASSERT(other != 0);
CAROM_ASSERT(distributed() && other->distributed());
CAROM_ASSERT(numRows() == other->dim());
return transposeMult(*other);
}
/**
* @brief Const Matrix member access.
*
* @pre (0 <= row) && (row < numRows())
* @pre (0 <= col) && (col < numColumns())
*
* @param[in] row The row of the Matrix value on this processor
* requested.
* @param[in] col The column of the Matrix value requested.
*/
const double&
item(
int row,
int col) const
{
CAROM_ASSERT((0 <= row) && (row < numRows()));
CAROM_ASSERT((0 <= col) && (col < numColumns()));
return d_mat[row*d_num_cols+col];
}
/**
* @brief Non-const Matrix member access.
*
* Allows constructs of the form mat[i, j] = val;
*
* @pre (0 <= row) && (row < numRows())
* @pre (0 <= col) && (col < numColumns())
*
* @param[in] row The row of the Matrix value on this processor
* requested.
* @param[in] col The column of the Matrix value requested.
*/
double&
item(
int row,
int col)
{
CAROM_ASSERT((0 <= row) && (row < numRows()));
CAROM_ASSERT((0 <= col) && (col < numColumns()));
return d_mat[row*d_num_cols+col];
}
private:
/**
* @brief Default constructor is not implemented.
*/
Matrix();
/**
* @brief The storage for the Matrix's values on this processor.
*/
double* d_mat;
/**
* @brief The rows in the Matrix that are on this processor.
*/
int d_num_rows;
/**
* @brief The number of columns in the Matrix.
*
* For distributed matrices the number of columns is the same on all
* processors.
*/
int d_num_cols;
/**
* @brief If true, the Matrix's rows are distributed over all processors.
*
* Each processor does not need to hold the same number of rows.
*/
bool d_distributed;
};
}
#endif