/usr/include/XdmfSparseMatrix.hpp is in libxdmf-dev 3.0+git20160803-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 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 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 | /*****************************************************************************/
/* 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_
// C Compatible Includes
#include "XdmfCore.hpp"
#include "XdmfArray.hpp"
#ifdef __cplusplus
/**
* @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.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfSparseMatrix.cpp
* @skipline //#initialization
* @until //#initialization
*
* Python
*
* @dontinclude XdmfExampleSparseMatrix.py
* @skipline #//initialization
* @until #//initialization
*
* @param numberRows Number of rows in matrix.
* @param numberColumns Number of columns in matrix.
*
* @return Constructed XdmfSparseMatrix.
*/
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.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfSparseMatrix.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#setColumnIndex
* @until //#setColumnIndex
* @skipline //#getColumnIndex
* @until //#getColumnIndex
*
* Python
*
* @dontinclude XdmfExampleSparseMatrix.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//setColumnIndex
* @until #//setColumnIndex
* @skipline #//getColumnIndex
* @until #//getColumnIndex
*
* @return Array containing column indices for nonzero entries of
* matrix. This is the same size as values.
*/
shared_ptr<XdmfArray> getColumnIndex();
std::map<std::string, std::string> getItemProperties() const;
std::string getItemTag() const;
/**
* Get the name of the sparse matrix.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfSparseMatrix.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#setName
* @until //#setName
* @skipline //#getName
* @until //#getName
*
* Python
*
* @dontinclude XdmfExampleSparseMatrix.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//setName
* @until #//setName
* @skipline #//getName
* @until #//getName
*
* @return A string containing the name of the sparse matrix.
*/
std::string getName() const;
/**
* Get the number of columns in the sparse matrix.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfSparseMatrix.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#setColumnIndex
* @until //#setColumnIndex
* @skipline //#getNumberColumns
* @until //#getNumberColumns
*
* Python
*
* @dontinclude XdmfExampleSparseMatrix.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//setColumnIndex
* @until #//setColumnIndex
* @skipline #//getNumberColumns
* @until #//getNumberColumns
*
* @return The number of columns in the sparse matrix.
*/
unsigned int getNumberColumns() const;
/**
* Get the number of rows in the sparse matrix.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfSparseMatrix.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#setRowPointer
* @until //#setRowPointer
* @skipline //#getNumberRows
* @until //#getNumberRows
*
* Python
*
* @dontinclude XdmfExampleSparseMatrix.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//setRowPointer
* @until #//setRowPointer
* @skipline #//getNumberRows
* @until #//getNumberRows
*
* @return The number of rows in the sparse matrix.
*/
unsigned int getNumberRows() const;
/**
* Get the row pointer array.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfSparseMatrix.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#setRowPointer
* @until //#setRowPointer
* @skipline //#getRowPointer
* @until //#getRowPointer
*
* Python
*
* @dontinclude XdmfExampleSparseMatrix.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//setRowPointer
* @until #//setRowPointer
* @skipline #//getRowPointer
* @until #//getRowPointer
*
* @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
*/
shared_ptr<XdmfArray> getRowPointer();
/**
* Get the values array.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfSparseMatrix.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#setRowPointer
* @until //#setRowPointer
* @skipline //#setColumnIndex
* @until //#setColumnIndex
* @skipline //#setValues
* @until //#setValues
* @skipline //#getValues
* @until //#getValues
*
* Python
*
* @dontinclude XdmfExampleSparseMatrix.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//setRowPointer
* @until #//setRowPointer
* @skipline #//setColumnIndex
* @until #//setColumnIndex
* @skipline #//setValues
* @until #//setValues
* @skipline #//getValues
* @until #//getValues
*
* @return Array containing values of nonzero entries of matrix.
*/
shared_ptr<XdmfArray> getValues();
/**
* Get values as a string in two dimensional format.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfSparseMatrix.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#setRowPointer
* @until //#setRowPointer
* @skipline //#setColumnIndex
* @until //#setColumnIndex
* @skipline //#setValues
* @until //#setValues
* @skipline //#getValuesString
* @until //#getValuesString
*
* Python
*
* @dontinclude XdmfExampleSparseMatrix.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//setRowPointer
* @until #//setRowPointer
* @skipline #//setColumnIndex
* @until #//setColumnIndex
* @skipline #//setValues
* @until #//setValues
* @skipline #//getValuesString
* @until #//getValuesString
*
* @return Atring representation of matrix.
*/
std::string getValuesString() const;
/**
* Set the column index array.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfSparseMatrix.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#setColumnIndex
* @until //#setColumnIndex
*
* Python
*
* @dontinclude XdmfExampleSparseMatrix.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//setColumnIndex
* @until #//setColumnIndex
*
* @param columnIndex Array containing column indices for nonzero
* entries of matrix. This is the same size as values.
*/
void setColumnIndex(const shared_ptr<XdmfArray> columnIndex);
/**
* Set the name of the sparse matrix.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfSparseMatrix.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#setName
* @until //#setName
*
* Python
*
* @dontinclude XdmfExampleSparseMatrix.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//setName
* @until #//setName
*
* @param name A string containing the name to set.
*/
void setName(const std::string & name);
/**
* Set the row pointer array.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfSparseMatrix.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#setRowPointer
* @until //#setRowPointer
*
* Python
*
* @dontinclude XdmfExampleSparseMatrix.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//setRowPointer
* @until #//setRowPointer
*
* @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
*/
void setRowPointer(const shared_ptr<XdmfArray> rowPointer);
/**
* Set the values array.
*
* Example of use:
*
* C++
*
* @dontinclude ExampleXdmfSparseMatrix.cpp
* @skipline //#initialization
* @until //#initialization
* @skipline //#setRowPointer
* @until //#setRowPointer
* @skipline //#setColumnIndex
* @until //#setColumnIndex
* @skipline //#setValues
* @until //#setValues
*
* Python
*
* @dontinclude XdmfExampleSparseMatrix.py
* @skipline #//initialization
* @until #//initialization
* @skipline #//setRowPointer
* @until #//setRowPointer
* @skipline #//setColumnIndex
* @until #//setColumnIndex
* @skipline #//setValues
* @until #//setValues
*
* @param values Array containing values of nonzero entries of
* matrix.
*/
void setValues(const shared_ptr<XdmfArray> values);
virtual void traverse(const shared_ptr<XdmfBaseVisitor> visitor);
XdmfSparseMatrix(XdmfSparseMatrix &);
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
#ifdef __cplusplus
extern "C" {
#endif
// C wrappers go here
struct XDMFSPARSEMATRIX; // Simply as a typedef to ensure correct typing
typedef struct XDMFSPARSEMATRIX XDMFSPARSEMATRIX;
XDMFCORE_EXPORT XDMFSPARSEMATRIX * XdmfSparseMatrixNew(unsigned int numberRows, unsigned int numberColumns);
XDMFCORE_EXPORT XDMFARRAY * XdmfSparseMatrixGetColumnIndex(XDMFSPARSEMATRIX * matrix, int * status);
XDMFCORE_EXPORT char * XdmfSparseMatrixGetName(XDMFSPARSEMATRIX * matrix);
XDMFCORE_EXPORT unsigned int XdmfSparseMatrixGetNumberColumns(XDMFSPARSEMATRIX * matrix);
XDMFCORE_EXPORT unsigned int XdmfSparseMatrixGetNumberRows(XDMFSPARSEMATRIX * matrix);
XDMFCORE_EXPORT XDMFARRAY * XdmfSparseMatrixGetRowPointer(XDMFSPARSEMATRIX * matrix, int * status);
XDMFCORE_EXPORT XDMFARRAY * XdmfSparseMatrixGetValues(XDMFSPARSEMATRIX * matrix, int * status);
XDMFCORE_EXPORT char * XdmfSparseMatrixGetValuesString(XDMFSPARSEMATRIX * matrix, int * status);
XDMFCORE_EXPORT void XdmfSparseMatrixSetColumnIndex(XDMFSPARSEMATRIX * matrix, XDMFARRAY * columnIndex, int passControl, int * status);
XDMFCORE_EXPORT void XdmfSparseMatrixSetName(XDMFSPARSEMATRIX * matrix, char * name, int * status);
XDMFCORE_EXPORT void XdmfSparseMatrixSetRowPointer(XDMFSPARSEMATRIX * matrix, XDMFARRAY * rowPointer, int passControl, int * status);
XDMFCORE_EXPORT void XdmfSparseMatrixSetValues(XDMFSPARSEMATRIX * matrix, XDMFARRAY * values, int passControl, int * status);
// C Wrappers for parent classes are generated by macros
XDMF_ITEM_C_CHILD_DECLARE(XdmfSparseMatrix, XDMFSPARSEMATRIX, XDMFCORE)
#define XDMF_SPARSEMATRIX_C_CHILD_DECLARE(ClassName, CClassName, Level) \
\
Level##_EXPORT XDMFARRAY * ClassName##GetColumnIndex( CClassName * matrix, int * status); \
Level##_EXPORT char * ClassName##GetName( CClassName * matrix); \
Level##_EXPORT unsigned int ClassName##GetNumberColumns( CClassName * matrix); \
Level##_EXPORT unsigned int ClassName##GetNumberRows( CClassName * matrix); \
Level##_EXPORT XDMFARRAY * ClassName##GetRowPointer( CClassName * matrix, int * status); \
Level##_EXPORT XDMFARRAY * ClassName##GetValues( CClassName * matrix, int * status); \
Level##_EXPORT char * ClassName##GetValuesString( CClassName * matrix, int * status); \
Level##_EXPORT void ClassName##SetColumnIndex( CClassName * matrix, XDMFARRAY * columnIndex, int passControl, int * status); \
Level##_EXPORT void ClassName##SetName( CClassName * matrix, char * name, int * status); \
Level##_EXPORT void ClassName##SetRowPointer( CClassName * matrix, XDMFARRAY * rowPointer, int passControl, int * status); \
Level##_EXPORT void ClassName##SetValues( CClassName * matrix, XDMFARRAY * values, int passControl, int * status);
#define XDMF_SPARSEMATRIX_C_CHILD_WRAPPER(ClassName, CClassName) \
\
XDMFARRAY * ClassName##GetColumnIndex( CClassName * matrix, int * status) \
{ \
return XdmfSparseMatrixGetColumnIndex((XDMFSPARSEMATRIX *)((void *)matrix), status); \
} \
\
char * ClassName##GetName( CClassName * matrix) \
{ \
return XdmfSparseMatrixGetName((XDMFSPARSEMATRIX *)((void *)matrix)); \
} \
\
unsigned int ClassName##GetNumberColumns( CClassName * matrix) \
{ \
return XdmfSparseMatrixGetNumberColumns((XDMFSPARSEMATRIX *)((void *)matrix)); \
} \
\
unsigned int ClassName##GetNumberRows( CClassName * matrix) \
{ \
return XdmfSparseMatrixGetNumberRows((XDMFSPARSEMATRIX *)((void *)matrix)); \
} \
\
XDMFARRAY * ClassName##GetRowPointer( CClassName * matrix, int * status) \
{ \
return XdmfSparseMatrixGetRowPointer((XDMFSPARSEMATRIX *)((void *)matrix), status); \
} \
\
XDMFARRAY * ClassName##GetValues( CClassName * matrix, int * status) \
{ \
return XdmfSparseMatrixGetValues((XDMFSPARSEMATRIX *)((void *)matrix), status); \
} \
\
char * ClassName##GetValuesString( CClassName * matrix, int * status) \
{ \
return XdmfSparseMatrixGetValuesString((XDMFSPARSEMATRIX *)((void *)matrix), status); \
} \
\
void ClassName##SetColumnIndex( CClassName * matrix, XDMFARRAY * columnIndex, int passControl, int * status) \
{ \
XdmfSparseMatrixSetColumnIndex((XDMFSPARSEMATRIX *)((void *)matrix), columnIndex, passControl, status); \
} \
\
void ClassName##SetName( CClassName * matrix, char * name, int * status) \
{ \
XdmfSparseMatrixSetName((XDMFSPARSEMATRIX *)((void *)matrix), name, status); \
} \
\
void ClassName##SetRowPointer( CClassName * matrix, XDMFARRAY * rowPointer, int passControl, int * status) \
{ \
XdmfSparseMatrixSetRowPointer((XDMFSPARSEMATRIX *)((void *)matrix), rowPointer, passControl, status); \
} \
\
void ClassName##SetValues( CClassName * matrix, XDMFARRAY * values, int passControl, int * status) \
{ \
XdmfSparseMatrixSetValues((XDMFSPARSEMATRIX *)((void *)matrix), values, passControl, status); \
}
#ifdef __cplusplus
}
#endif
#endif /* XDMFSPARSEMATRIX_HPP_ */
|