XdmfSparseMatrix.hpp 11.9 KB
Newer Older
Kenneth Leiter's avatar
Kenneth Leiter committed
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
/*****************************************************************************/
/*                                    XDMF                                   */
/*                       eXtensible Data Model and Format                    */
/*                                                                           */
/*  Id : XdmfSparseMatrix.hpp                                                */
/*                                                                           */
/*  Author:                                                                  */
/*     Kenneth Leiter                                                        */
/*     kenneth.leiter@arl.army.mil                                           */
/*     US Army Research Laboratory                                           */
/*     Aberdeen Proving Ground, MD                                           */
/*                                                                           */
/*     Copyright @ 2011 US Army Research Laboratory                          */
/*     All Rights Reserved                                                   */
/*     See Copyright.txt for details                                         */
/*                                                                           */
/*     This software is distributed WITHOUT ANY WARRANTY; without            */
/*     even the implied warranty of MERCHANTABILITY or FITNESS               */
/*     FOR A PARTICULAR PURPOSE.  See the above copyright notice             */
/*     for more information.                                                 */
/*                                                                           */
/*****************************************************************************/

#ifndef XDMFSPARSEMATRIX_HPP_
#define XDMFSPARSEMATRIX_HPP_

// Includes
#include "XdmfCore.hpp"
#include "XdmfArray.hpp"

/**
 * @brief Sparse matrix implemented as compressed row storage.
 *
 * An XdmfSparseMatrix provides routines for interacting with a sparse
 * matrix.  It is stored internally in compressed row storage.
 */
class XDMFCORE_EXPORT XdmfSparseMatrix : public XdmfItem {

public:

  /**
   * Create a new XdmfSparseMatrix.
   *
44 45 46 47 48
   * Example of use:
   *
   * C++
   *
   * @dontinclude ExampleXdmfSparseMatrix.cpp
49 50
   * @skipline //#initialization
   * @until //#initialization
51 52 53 54
   *
   * Python
   *
   * @dontinclude XdmfExampleSparseMatrix.py
55 56
   * @skipline #//initialization
   * @until #//initialization
57
   *
58 59
   * @param     numberRows      Number of rows in matrix.
   * @param     numberColumns   Number of columns in matrix.
Kenneth Leiter's avatar
Kenneth Leiter committed
60
   *
61
   * @return                    Constructed XdmfSparseMatrix.
Kenneth Leiter's avatar
Kenneth Leiter committed
62 63 64 65 66 67 68 69 70 71 72 73
   */
  static shared_ptr<XdmfSparseMatrix> New(const unsigned int numberRows,
                                          const unsigned int numberColumns);

  virtual ~XdmfSparseMatrix();

  LOKI_DEFINE_VISITABLE(XdmfSparseMatrix, XdmfItem);
  static const std::string ItemTag;

  /**
   * Get the column index array.
   *
74 75 76 77 78
   * Example of use:
   *
   * C++
   *
   * @dontinclude ExampleXdmfSparseMatrix.cpp
79 80 81 82 83 84
   * @skipline //#initialization
   * @until //#initialization
   * @skipline //#setColumnIndex
   * @until //#setColumnIndex
   * @skipline //#getColumnIndex
   * @until //#getColumnIndex
85 86 87 88
   *
   * Python
   *
   * @dontinclude XdmfExampleSparseMatrix.py
89 90 91 92 93 94 95
   * @skipline #//initialization
   * @until #//initialization
   * @skipline #//setColumnIndex
   * @until #//setColumnIndex
   * @skipline #//getColumnIndex
   * @until #//getColumnIndex
   *
96 97
   * @return    Array containing column indices for nonzero entries of
   *            matrix. This is the same size as values.
Kenneth Leiter's avatar
Kenneth Leiter committed
98 99 100 101 102 103 104 105 106 107
   */
  shared_ptr<XdmfArray> getColumnIndex();

  std::map<std::string, std::string> getItemProperties() const;

  std::string getItemTag() const;

  /**
   * Get the name of the sparse matrix.
   *
108 109 110 111 112
   * Example of use:
   *
   * C++
   *
   * @dontinclude ExampleXdmfSparseMatrix.cpp
113 114 115 116 117 118
   * @skipline //#initialization
   * @until //#initialization
   * @skipline //#setName
   * @until //#setName
   * @skipline //#getName
   * @until //#getName
119 120 121 122
   *
   * Python
   *
   * @dontinclude XdmfExampleSparseMatrix.py
123 124 125 126 127 128 129
   * @skipline #//initialization
   * @until #//initialization
   * @skipline #//setName
   * @until #//setName
   * @skipline #//getName
   * @until #//getName
   *
130
   * @return    A string containing the name of the sparse matrix.
Kenneth Leiter's avatar
Kenneth Leiter committed
131 132 133 134 135 136
   */
  std::string getName() const;

  /**
   * Get the number of columns in the sparse matrix.
   *
137 138 139 140 141
   * Example of use:
   *
   * C++
   *
   * @dontinclude ExampleXdmfSparseMatrix.cpp
142 143 144 145 146 147
   * @skipline //#initialization
   * @until //#initialization
   * @skipline //#setColumnIndex
   * @until //#setColumnIndex
   * @skipline //#getNumberColumns
   * @until //#getNumberColumns
148 149 150 151
   *
   * Python
   *
   * @dontinclude XdmfExampleSparseMatrix.py
152 153 154 155 156 157 158
   * @skipline #//initialization
   * @until #//initialization
   * @skipline #//setColumnIndex
   * @until #//setColumnIndex
   * @skipline #//getNumberColumns
   * @until #//getNumberColumns
   *
159
   * @return    The number of columns in the sparse matrix.
Kenneth Leiter's avatar
Kenneth Leiter committed
160 161 162 163 164 165
   */
  unsigned int getNumberColumns() const;

  /**
   * Get the number of rows in the sparse matrix.
   *
166 167 168 169 170
   * Example of use:
   *
   * C++
   *
   * @dontinclude ExampleXdmfSparseMatrix.cpp
171 172 173 174 175 176
   * @skipline //#initialization
   * @until //#initialization
   * @skipline //#setRowPointer
   * @until //#setRowPointer
   * @skipline //#getNumberRows
   * @until //#getNumberRows
177 178 179 180
   *
   * Python
   *
   * @dontinclude XdmfExampleSparseMatrix.py
181 182 183 184 185 186 187
   * @skipline #//initialization
   * @until #//initialization
   * @skipline #//setRowPointer
   * @until #//setRowPointer
   * @skipline #//getNumberRows
   * @until #//getNumberRows
   *
188
   * @return    The number of rows in the sparse matrix.
Kenneth Leiter's avatar
Kenneth Leiter committed
189 190 191 192 193 194
   */
  unsigned int getNumberRows() const;

  /**
   * Get the row pointer array.
   *
195 196 197 198 199
   * Example of use:
   *
   * C++
   *
   * @dontinclude ExampleXdmfSparseMatrix.cpp
200 201 202 203 204 205
   * @skipline //#initialization
   * @until //#initialization
   * @skipline //#setRowPointer
   * @until //#setRowPointer
   * @skipline //#getRowPointer
   * @until //#getRowPointer
206 207 208 209
   *
   * Python
   *
   * @dontinclude XdmfExampleSparseMatrix.py
210 211 212 213 214 215 216
   * @skipline #//initialization
   * @until #//initialization
   * @skipline #//setRowPointer
   * @until #//setRowPointer
   * @skipline #//getRowPointer
   * @until #//getRowPointer
   *
217 218 219
   * @return    Array containing indices into column array for each
   *            row. This is the size of the number of rows in the matrix +
   *            1. The last value is the number of nonzero entries in the matrix
Kenneth Leiter's avatar
Kenneth Leiter committed
220 221 222 223 224 225
   */
  shared_ptr<XdmfArray> getRowPointer();

  /**
   * Get the values array.
   *
226 227 228 229 230
   * Example of use:
   *
   * C++
   *
   * @dontinclude ExampleXdmfSparseMatrix.cpp
231 232 233 234 235 236 237 238 239 240
   * @skipline //#initialization
   * @until //#initialization
   * @skipline //#setRowPointer
   * @until //#setRowPointer
   * @skipline //#setColumnIndex
   * @until //#setColumnIndex
   * @skipline //#setValues
   * @until //#setValues
   * @skipline //#getValues
   * @until //#getValues
241 242 243 244
   *
   * Python
   *
   * @dontinclude XdmfExampleSparseMatrix.py
245 246 247 248 249 250 251 252 253 254 255
   * @skipline #//initialization
   * @until #//initialization
   * @skipline #//setRowPointer
   * @until #//setRowPointer
   * @skipline #//setColumnIndex
   * @until #//setColumnIndex
   * @skipline #//setValues
   * @until #//setValues
   * @skipline #//getValues
   * @until #//getValues
   *
256
   * @return    Array containing values of nonzero entries of matrix.
Kenneth Leiter's avatar
Kenneth Leiter committed
257 258 259 260 261 262
   */
  shared_ptr<XdmfArray> getValues();

  /**
   * Get values as a string in two dimensional format.
   *
263 264 265 266 267
   * Example of use:
   *
   * C++
   *
   * @dontinclude ExampleXdmfSparseMatrix.cpp
268 269 270 271 272 273 274 275 276 277
   * @skipline //#initialization
   * @until //#initialization
   * @skipline //#setRowPointer
   * @until //#setRowPointer
   * @skipline //#setColumnIndex
   * @until //#setColumnIndex
   * @skipline //#setValues
   * @until //#setValues
   * @skipline //#getValuesString
   * @until //#getValuesString
278 279 280 281
   *
   * Python
   *
   * @dontinclude XdmfExampleSparseMatrix.py
282 283 284 285 286 287 288 289 290 291 292
   * @skipline #//initialization
   * @until #//initialization
   * @skipline #//setRowPointer
   * @until #//setRowPointer
   * @skipline #//setColumnIndex
   * @until #//setColumnIndex
   * @skipline #//setValues
   * @until #//setValues
   * @skipline #//getValuesString
   * @until #//getValuesString
   *
293
   * @return    Atring representation of matrix.
Kenneth Leiter's avatar
Kenneth Leiter committed
294 295 296 297 298 299
   */
  std::string getValuesString() const;

  /**
   * Set the column index array.
   *
300 301 302 303 304
   * Example of use:
   *
   * C++
   *
   * @dontinclude ExampleXdmfSparseMatrix.cpp
305 306 307 308
   * @skipline //#initialization
   * @until //#initialization
   * @skipline //#setColumnIndex
   * @until //#setColumnIndex
309 310 311 312
   *
   * Python
   *
   * @dontinclude XdmfExampleSparseMatrix.py
313 314 315 316
   * @skipline #//initialization
   * @until #//initialization
   * @skipline #//setColumnIndex
   * @until #//setColumnIndex
317
   *
318 319
   * @param     columnIndex     Array containing column indices for nonzero
   *                            entries of matrix. This is the same size as values.
Kenneth Leiter's avatar
Kenneth Leiter committed
320 321 322 323 324 325
   */
  void setColumnIndex(const shared_ptr<XdmfArray> columnIndex);

  /**
   * Set the name of the sparse matrix.
   *
326 327 328 329 330
   * Example of use:
   *
   * C++
   *
   * @dontinclude ExampleXdmfSparseMatrix.cpp
331 332 333 334
   * @skipline //#initialization
   * @until //#initialization
   * @skipline //#setName
   * @until //#setName
335 336 337 338
   *
   * Python
   *
   * @dontinclude XdmfExampleSparseMatrix.py
339 340 341 342
   * @skipline #//initialization
   * @until #//initialization
   * @skipline #//setName
   * @until #//setName
343
   *
344
   * @param     name    A string containing the name to set.
Kenneth Leiter's avatar
Kenneth Leiter committed
345 346 347 348 349 350
   */
  void setName(const std::string & name);

  /**
   * Set the row pointer array.
   *
351 352 353 354 355
   * Example of use:
   *
   * C++
   *
   * @dontinclude ExampleXdmfSparseMatrix.cpp
356 357 358 359
   * @skipline //#initialization
   * @until //#initialization
   * @skipline //#setRowPointer
   * @until //#setRowPointer
360 361 362 363
   *
   * Python
   *
   * @dontinclude XdmfExampleSparseMatrix.py
364 365 366 367 368
   * @skipline #//initialization
   * @until #//initialization
   * @skipline #//setRowPointer
   * @until #//setRowPointer
   *
369 370 371
   * @param     rowPointer      Array containing indices into column array for
   *                            each row. This is the size of the number of rows in the matrix +
   *                            1. The last value is the number of nonzero entries in the matrix
Kenneth Leiter's avatar
Kenneth Leiter committed
372 373 374 375 376 377
   */
  void setRowPointer(const shared_ptr<XdmfArray> rowPointer);

  /**
   * Set the values array.
   *
378 379 380 381 382
   * Example of use:
   *
   * C++
   *
   * @dontinclude ExampleXdmfSparseMatrix.cpp
383 384 385 386 387 388 389 390
   * @skipline //#initialization
   * @until //#initialization
   * @skipline //#setRowPointer
   * @until //#setRowPointer
   * @skipline //#setColumnIndex
   * @until //#setColumnIndex
   * @skipline //#setValues
   * @until //#setValues
391 392 393 394
   *
   * Python
   *
   * @dontinclude XdmfExampleSparseMatrix.py
395 396 397 398 399 400 401 402 403
   * @skipline #//initialization
   * @until #//initialization
   * @skipline #//setRowPointer
   * @until #//setRowPointer
   * @skipline #//setColumnIndex
   * @until #//setColumnIndex
   * @skipline #//setValues
   * @until #//setValues
   *
404 405
   * @param     values  Array containing values of nonzero entries of
   *                    matrix.
Kenneth Leiter's avatar
Kenneth Leiter committed
406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437
   */
  void setValues(const shared_ptr<XdmfArray> values);

  virtual void traverse(const shared_ptr<XdmfBaseVisitor> visitor);

protected:

  XdmfSparseMatrix(const unsigned int numberRows,
                   const unsigned int numberColumns);

  virtual void
  populateItem(const std::map<std::string, std::string> & itemProperties,
               const std::vector<shared_ptr<XdmfItem> > & childItems,
               const XdmfCoreReader * const reader);

private:

  XdmfSparseMatrix(const XdmfSparseMatrix &);  // Not implemented.
  void operator=(const XdmfSparseMatrix &);  // Not implemented.

  shared_ptr<XdmfArray> mColumnIndex;
  std::string mName;
  unsigned int mNumberColumns;
  unsigned int mNumberRows;
  shared_ptr<XdmfArray> mRowPointer;
  shared_ptr<XdmfArray> mValues;
};

#ifdef _WIN32
#endif

#endif /* XDMFSPARSEMATRIX_HPP_ */