/usr/include/trilinos/Epetra_CrsGraph.h is in libtrilinos-epetra-dev 12.12.1-5.
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 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 | /*
//@HEADER
// ************************************************************************
//
// Epetra: Linear Algebra Services Package
// Copyright 2011 Sandia Corporation
//
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "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 SANDIA CORPORATION OR THE
// 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 OF SUCH DAMAGE.
//
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ************************************************************************
//@HEADER
*/
#ifndef EPETRA_CRSGRAPH_H
#define EPETRA_CRSGRAPH_H
#include "Epetra_ConfigDefs.h"
#include "Epetra_DistObject.h"
#include "Epetra_CrsGraphData.h"
class Epetra_BlockMap;
class Epetra_Util;
class Epetra_Time;
class Epetra_Import;
class Epetra_Export;
class Epetra_Distributor;
class Epetra_RowMatrix;
//! Epetra_CrsGraph: A class for constructing and using sparse compressed row graphs.
/*! Epetra_CrsGraph enables the piecewise construction and use of sparse matrix graphs (the integer structure without
values) where entries are intended for row access.
Epetra_CrsGraph is an attribute of all Epetra row-based matrix classes, defining their nonzero structure and also
holding their Epetra_Map attributes.
<b>Constructing Epetra_CrsGraph objects</b>
Constructing Epetra_CrsGraph objects is a multi-step process. The basic steps are as follows:
<ol>
<li> Create Epetra_CrsGraph instance, including some initial storage, via constructor. In
addition to the copy constructor, Epetra_CrsGraph has four different constructors. All four of these
constructors have
an argument, StaticProfile, which by default is set to false. If it is set to true, then the
profile (the number of indices per row as defined by NumIndicesPerRow) will be rigidly enforced.
Although this takes away flexibility, it allows a single array to be allocated for all indices.
This decreases memory fragmentation and improves performance across many operations. A more detailed
discussion of the StaticProfile option is found below.
<ol>
<li> User-provided row map, variable nonzero profile: This constructor is used to define the
row distribution of the graph and specify a varying number of nonzero entries per row.
It is best to use this constructor when the user will be inserting entries using global index
values and wants every column index to be included in the graph. Note that in this case, the
column map will be built for the user when FillComplete() is called. This constructor is also
appropriate for when there is a large variation in the number of indices per row. If this is not
the case, the next constructor may be more convenient to use.
<li> User-provided row map, fixed nonzero profile: This constructor is used to define the
row distribution of the graph and specify a fixed number of nonzero entries per row.
It is best to use this constructor when the user will be inserting entries using global index
values and wants every column index to be included in the graph. Note that in this case, the
column map will be built for the user when FillComplete() is called. This constructor is also
appropriate for when there is little or no variation in the number of indices per row.
<li> User-provided row map, user-provided column map and variable nonzero profile:
This constructor is used to define the
row \e and \e column distribution of the graph, and specify a varying number of nonzero entries per row.
It is best to use this constructor when the user will be inserting entries and already knows which columns
of the matrix should be included on each processor. Note that in this case, the
column map will \e not be built for the user when FillComplete() is called. Also, if the user attempts to
insert a column index whose GID is not part of the column map on that process, the index will be
discarded. This property can be used to "filter out" column entries that should be ignored.
This constructor is also
appropriate for when there is a large variation in the number of indices per row. If this is not
the case, the next constructor may be more convenient to use.
<li> User-provided row map, user-provided column map and fixed nonzero profile:
This constructor is used to define the
row \e and \e column distribution of the graph, and specify a fixed number of nonzero entries per row.
It is best to use this constructor when the user will be inserting entries and already knows which columns
of the matrix should be included on each processor. Note that in this case, the
column map will \e not be built for the user when FillComplete() is called. Also, if the user attempts to
insert a column index whose GID is not part of the column map on that process, the index will be
discarded. This constructor is also
appropriate for when there is little or no variation in the number of indices per row.
</ol>
<li> Enter row and column entry information via calls to the InsertGlobalIndices method.
<li> Complete construction via FillComplete call, which performs the following tasks:
<ol>
<li>Transforms indices to local index space (after this, IndicesAreLocal()==true)
<li>Sorts column-indices within each row
<li>Compresses out any redundant indices within rows
<li>Computes global data such as num-nonzeros, maximum row-lengths, etc.
</ol>
<li> (Optional) Optimize the graph storage via a call to OptimizeStorage.
</ol>
<b> Performance Enhancement Issues </b>
The Epetra_CrsGraph class attempts to address four basic types of situations, depending on the user's primary concern:
<ol>
<li> Simple, flexible construction over minimal memory use or control of column indices: In this case the user wants to provide only a row distribution
of the graph and insert indices without worrying about memory allocation performance. This type of user is best
served by the constructor that requires only a row map, and a fixed number of indices per row. In fact, setting NumIndicesPerRow=0
is probably the best option.
<li> Stronger control over memory allocation performance and use over flexibility and simplicity: In this case the user explicitly set
StaticProfile to true and will provide values, either a single global int or an array of int's, for NumIndicesPerRow, such that
the actual number of indices submitted to the graph will not exceed the estimates. Because we know that NumIndicesPerRow will not
be exceeded, we can pre-allocate all of the storage for the graph as a single array. This is typically much more efficient.
<li> Explicit control over column indices: In this case the user prescribes the column map. Given the column map, any index that is
submitted for entry into the graph will be included \e only if they are present in the list of GIDs for the column map on the
processor that submits the index. This feature allows the user to define a filter such that only certain columns will be kept. The
user also prescribes the local ordering via this technique, since the ordering of GIDs in the column map imposes the local
ordering.
<li> Construction using local indices only: In some situations, users may want to build a graph using local index values only. In this
case, the user must explicitly assign GIDs. This is done by prescribing the column map, in the same way as the previous situation.
</ol>
Notes:
<ul>
<li>In all but the most advanced uses, users will typically \e not specify the column map. In other words, graph entries will be submitted using
GIDs not LIDs and all entries that are submitted are intended to be inserted into the graph.
<li>If a user is not particularly worried about performance, or really needs the flexibility associated with the first situation, then there
is no need to explicitly manage the NumIndicesPerRow values or set StaticProfile to true. In this case, it is best to set NumIndicesPerRow to
zero.
<li> Users who are concerned about performance should carefully manage NumIndicesPerRow and set StaticProfile to true. This will give the best
performance and use the least amount of memory.
<li> A compromise approach would be to not set StaticProfile to true, giving the user flexibility, but then calling OptimizeStorage() once FillComplete()
has been called. This approach requires additional temporary memory because the graph will be copied into an efficient data structure and the old
memory deleted. However, once the copy has been made, the resulting data structure is as efficient as when StaticProfile is used.
</ul>
<b>Epetra_Map attributes</b>
Epetra_CrsGraph objects have four Epetra_Map attributes.
The Epetra_Map attributes can be obtained via these accessor methods:
<ul>
<li>RowMap() Describes the numbering and distribution of the rows of the graph. The row-map exists and is valid
for the entire life of the graph, having been passed in as a constructor argument. The set of graph rows is defined
by the row-map and may not be changed. Rows may not be inserted or deleted by the user. The only change that may be
made is that the user can replace the row-map with a compatible row-map (which is the same except for re-numbering)
by calling the ReplaceRowMap() method.
<li>ColMap() Describes the set of column-indices that appear in the rows in each processor's portion of the graph.
Unless provided by the user at construction time, a valid column-map doesn't exist until FillComplete() is called.
<li>RangeMap() Describes the range of the matrix operator. e.g., for a matrix-vector product operation, the result
vector's map must be compatible with the range-map of the matrix operator. The range-map is usually the same as
the row-map. The range-map is set equal to the row-map at graph creation time, but may be specified by the user
when FillComplete() is called.
<li>DomainMap() Describes the domain of the matrix operator. The domain-map can be specified by the user when
FillComplete() is called. Until then, it is set equal to the row-map.
</ul>
It is important to note that while the row-map and the range-map are often the same, the column-map and the domain-map
are almost never the same. The set of entries in a distributed column-map almost always form overlapping sets, with
entries being associated with more than one processor. A domain-map, on the other hand, must be a 1-to-1 map, with
entries being associated with only a single processor.
<b>Global versus Local indices</b>
After creation and before FillComplete() has been called, the column-indices of the graph are in
the global space as received from the user. One of the tasks performed by FillComplete() is to
transform the indices to a local index space. The query methods IndicesAreGlobal() and IndicesAreLocal()
return true or false depending on whether this transformation has been performed or not.
Note the behavior of several graph methods:
<ul>
<li>InsertGlobalIndices() returns an error if IndicesAreLocal()==true or StorageOptimized()==true
<li>InsertMyIndices() returns an error if IndicesAreGlobal()==true or StorageOptimized()==true
<li>RemoveGlobalIndices() returns an error if IndicesAreLocal()==true or if graph was constructed in View mode
<li>RemoveMyIndices() returns an error if IndicesAreGlobal()==true or if graph was constructed in View mode
<li>ExtractGlobalRowCopy() works regardless of state of indices
<li>ExtractMyRowCopy() returns an error if IndicesAreGlobal()==true
<li>ExtractGlobalRowView() returns an error if IndicesAreLocal()==true
<li>ExtractMyRowView() returns an error if IndicesAreGlobal()==true
</ul>
Note that even after a graph is constructed, it is possible to add or remove entries. However,
FillComplete must then be called again to restore the graph to a consistent state.
*/
class EPETRA_LIB_DLL_EXPORT Epetra_CrsGraph: public Epetra_DistObject {
public:
//! @name Constructors/Destructor
//@{
//! Epetra_CrsGraph constuctor with variable number of indices per row.
/*! Creates a Epetra_CrsGraph object and allocates storage.
\param CV - (In) A Epetra_DataAccess enumerated type set to Copy or View.
\param RowMap - (In) An Epetra_BlockMap (or Epetra_Map or Epetra_LocalMap) listing the rows that this
processor will contribute to.In
\param NumIndicesPerRow - (In) An integer array of length NumMyRows
such that NumIndicesPerRow[i] indicates the (approximate if StaticProfile=false) number of entries in the ith row.
\param StaticProfile - (In) Optional argument that indicates whether or not NumIndicesPerRow should be interpreted as an exact
count of nonzeros, or should be used as an approximation. By default this value is false, allowing the profile to be determined
dynamically. If the user sets it to true, then the memory allocation for the Epetra_CrsGraph object will be done in one large
block, saving on memory fragmentation and generally improving the performance of matrix multiplication and solve kernels.
*/
Epetra_CrsGraph(Epetra_DataAccess CV, const Epetra_BlockMap& RowMap, const int* NumIndicesPerRow, bool StaticProfile = false);
//! Epetra_CrsGraph constuctor with fixed number of indices per row.
/*! Creates a Epetra_CrsGraph object and allocates storage.
\param CV - (In) A Epetra_DataAccess enumerated type set to Copy or View.
\param RowMap - (In) An Epetra_BlockMap (or Epetra_Map or Epetra_LocalMap) listing the rows that this
processor will contribute to.
\param NumIndicesPerRow - (In) An integer that indicates the (approximate if StaticProfile=false) number of entries in the each row.
Note that it is possible to use 0 for this value and let fill occur during the insertion phase.
\param StaticProfile - (In) Optional argument that indicates whether or not NumIndicesPerRow should be interpreted as an exact
count of nonzeros, or should be used as an approximation. By default this value is false, allowing the profile to be determined
dynamically. If the user sets it to true, then the memory allocation for the Epetra_CrsGraph object will be done in one large
block, saving on memory fragmentation and generally improving the performance of matrix multiplication and solve kernels.
*/
Epetra_CrsGraph(Epetra_DataAccess CV, const Epetra_BlockMap& RowMap, int NumIndicesPerRow, bool StaticProfile = false);
//! Epetra_CrsGraph constuctor with variable number of indices per row.
/*! Creates a Epetra_CrsGraph object and allocates storage.
\param CV - (In) A Epetra_DataAccess enumerated type set to Copy or View.
\param RowMap - (In) An Epetra_BlockMap (or Epetra_Map or Epetra_LocalMap) listing the rows that this
processor will contribute to.
\param ColMap - (In) An Epetra_BlockMap (or Epetra_Map or Epetra_LocalMap) listing the columns that this
processor will contribute to.
\param NumIndicesPerRow - (In) An integer array of length NumMyRows
such that NumIndicesPerRow[i] indicates the (approximate if StaticProfile=false) number of entries in the ith row.
\param StaticProfile - (In) Optional argument that indicates whether or not NumIndicesPerRow should be interpreted as an exact
count of nonzeros, or should be used as an approximation. By default this value is false, allowing the profile to be determined
dynamically. If the user sets it to true, then the memory allocation for the Epetra_CrsGraph object will be done in one large
block, saving on memory fragmentation and generally improving the performance of matrix multiplication and solve kernels.
*/
Epetra_CrsGraph(Epetra_DataAccess CV, const Epetra_BlockMap& RowMap,
const Epetra_BlockMap& ColMap, const int* NumIndicesPerRow, bool StaticProfile = false);
//! Epetra_CrsGraph constuctor with fixed number of indices per row.
/*! Creates a Epetra_CrsGraph object and allocates storage.
\param CV - (In) A Epetra_DataAccess enumerated type set to Copy or View.
\param RowMap - (In) An Epetra_BlockMap (or Epetra_Map or Epetra_LocalMap) listing the rows that this
processor will contribute to.
\param ColMap - (In) An Epetra_BlockMap (or Epetra_Map or Epetra_LocalMap) listing the columns that this
processor will contribute to.
\param In
NumIndicesPerRow - An integer that indicates the (approximate if StaticProfile=false) number of entries in the each row.
Note that it is possible to use 0 for this value and let fill occur during the insertion phase.
\param StaticProfile - (In) Optional argument that indicates whether or not NumIndicesPerRow should be interpreted as an exact
count of nonzeros, or should be used as an approximation. By default this value is false, allowing the profile to be determined
dynamically. If the user sets it to true, then the memory allocation for the Epetra_CrsGraph object will be done in one large
block, saving on memory fragmentation and generally improving the performance of matrix multiplication and solve kernels.
*/
Epetra_CrsGraph(Epetra_DataAccess CV, const Epetra_BlockMap& RowMap,
const Epetra_BlockMap& ColMap, int NumIndicesPerRow, bool StaticProfile = false);
//! Copy constructor.
/*! This will create a Level 1 deep copy. This Graph will share ownership
of the CrsGraphData object with the right hand side Graph.
*/
Epetra_CrsGraph(const Epetra_CrsGraph& Graph);
//! Epetra_CrsGraph Destructor
virtual ~Epetra_CrsGraph();
//@}
//! @name Insertion/Removal methods
//@{
//! Enter a list of elements in a specified global row of the graph.
/*!
\param Row - (In) Global row number of indices.
\param NumIndices - (In) Number of Indices.
\param Indices - (In) Global column indices to insert.
\return Integer error code, set to 0 if successful. If the insertion requires
that additional memory be allocated for the row, a positive error code of 1
is returned. If the graph is a 'View'
mode graph, then a positive warning code of 2 will be returned if the
specified row already exists. Returns 1 if underlying graph data is shared
by multiple graph instances.
\pre IndicesAreGlobal()==true, StorageOptimized()==false
*/
#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
int InsertGlobalIndices(int GlobalRow, int NumIndices, int* Indices);
#endif
#ifndef EPETRA_NO_64BIT_GLOBAL_INDICES
int InsertGlobalIndices(long long GlobalRow, int NumIndices, long long* Indices);
#endif
//! Remove a list of elements from a specified global row of the graph.
/*!
\param Row - (In) Global row number of indices.
\param NumIndices - (In) Number of Indices.
\param Indices - (In) Global column indices to remove.
\return Integer error code, set to 0 if successful. Returns 1 if data is shared.
\pre IndicesAreGlobal()==true, StorageOptimized()==false
*/
#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
int RemoveGlobalIndices(int GlobalRow, int NumIndices, int* Indices);
#endif
#ifndef EPETRA_NO_64BIT_GLOBAL_INDICES
int RemoveGlobalIndices(long long GlobalRow, int NumIndices, long long* Indices);
#endif
//! Remove all indices from a specified global row of the graph.
/*!
\param Row - (In) Global row number of indices.
\return Integer error code, set to 0 if successful. Returns 1 if data is shared.
\pre IndicesAreGlobal()==true, StorageOptimized()==false
*/
int RemoveGlobalIndices(long long Row);
//! Enter a list of elements in a specified local row of the graph.
/*!
\param Row - (In) Local row number of indices.
\param NumIndices - (In) Number of Indices.
\param Indices - (In) Local column indices to insert.
\return Integer error code, set to 0 if successful. If the insertion requires
that additional memory be allocated for the row, a positive error code of 1
is returned. If one or more of the indices is ignored (due to not being
contained in the column-map), then a positive warning code of 2 is returned.
If the graph is a 'View' mode graph, then a positive warning code of 3 will
be returned if the specified row already exists. Returns 1 if underlying
graph data is shared by multiple graph instances.
\pre IndicesAreLocal()==true, StorageOptimized()==false
*/
int InsertMyIndices(int LocalRow, int NumIndices, int* Indices);
//! Remove a list of elements from a specified local row of the graph.
/*!
\param Row - (In) Local row number of indices.
\param NumIndices - (In) Number of Indices.
\param Indices - (In) Local column indices to remove.
\return Integer error code, set to 0 if successful. Returns 1 if data is shared.
\pre IndicesAreLocal()==true, StorageOptimized()==false
*/
int RemoveMyIndices(int LocalRow, int NumIndices, int* Indices);
//! Remove all indices from a specified local row of the graph.
/*!
\param Row - (In) Local row number of indices.
\return Integer error code, set to 0 if successful. Returns 1 if data is shared.
\pre IndicesAreLocal()==true, StorageOptimized()==false
*/
int RemoveMyIndices(int Row);
//@}
//! @name Transformation methods
//@{
//! Tranform to local index space. Perform other operations to allow optimal matrix operations.
/*! This overloading of the FillComplete method assumes that the domain-map and range-map both equal
the row-map, and simply calls FillComplete(RowMap(), RowMap()).
\return Integer error code, set to 0 if successful. Returns 1 if data is shared (i.e., if the underlying graph-data
object has a reference-count greater than 1).
\post IndicesAreLocal()==true, Filled()==true
*/
int FillComplete();
//! Transform to local index space using specified Domain/Range maps. Perform other operations to allow optimal matrix operations.
/*! Performs this sequence of operations:
<ol>
<li>Transform indices to local index space
<li>Sort column-indices within each row
<li>Compress out any redundant indices within rows
<li>Compute global data such as num-nonzeros, maximum row-lengths, etc.
</ol>
\return Integer error code, set to 0 if successful. Returns 1 if data is shared (i.e., if the underlying graph-data
object has a reference-count greater than 1).
\post IndicesAreLocal()==true, Filled()==true
*/
int FillComplete(const Epetra_BlockMap& DomainMap, const Epetra_BlockMap& RangeMap);
//! Make consecutive row index sections contiguous, minimize internal storage used for constructing graph.
/*! After construction and during initialization (when indices are being added via InsertGlobalIndices() etc.), the column-
indices for each row are held in a separate piece of allocated memory. This method moves the column-indices for all rows
into one large contiguous array and eliminates internal storage that is not needed after graph construction. Calling this
method can have a significant impact on memory costs and machine performance.
If this object was constructed in View mode then this method can't make non-contiguous indices contiguous and will
return a warning code of 1 if the viewed data isn't already contiguous.
\return Integer error code, set to 0 if successful.
\pre Filled()==true.
\pre If CV=View when the graph was constructed, then this method will be effective \only if the indices of the graph were already contiguous. In this case, the indices are left untouched and internal storage for the graph is minimized.
\post StorageOptimized()==true, if successful
*/
int OptimizeStorage();
//@}
//! @name Extraction methods
//@{
//! Extract a list of elements in a specified global row of the graph. Put into storage allocated by calling routine.
/*!
\param Row - (In) Global row number to get indices.
\param LenOfIndices - (In) Length of Indices array.
\param NumIndices - (Out) Number of Indices.
\param Indices - (Out) Global column indices corresponding to values.
\return Integer error code, set to 0 if successful.
*/
#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
int ExtractGlobalRowCopy(int GlobalRow, int LenOfIndices, int& NumIndices, int* Indices) const;
#endif
#ifndef EPETRA_NO_64BIT_GLOBAL_INDICES
int ExtractGlobalRowCopy(long long GlobalRow, int LenOfIndices, int& NumIndices, long long* Indices) const;
#endif
//! Extract a list of elements in a specified local row of the graph. Put into storage allocated by calling routine.
/*!
\param Row - (In) Local row number to get indices.
\param LenOfIndices - (In) Length of Indices array.
\param NumIndices - (Out) Number of Indices.
\param Indices - (Out) Local column indices corresponding to values.
\return Integer error code, set to 0 if successful.
\pre IndicesAreLocal()==true
*/
int ExtractMyRowCopy(int LocalRow, int LenOfIndices, int& NumIndices, int* Indices) const;
//! Get a view of the elements in a specified global row of the graph.
/*!
This function requires that the graph not be completed (FillComplete() was \e not called).
\param Row - (In) Global row number to get indices.
\param NumIndices - (Out) Number of Indices.
\param Indices - (Out) Global column indices corresponding to values.
\return Integer error code, set to 0 if successful. Returns -1 if invalid row. Returns -2 if graph is completed.
\pre IndicesAreLocal()==false
*/
#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
int ExtractGlobalRowView(int GlobalRow, int& NumIndices, int*& Indices) const;
#endif
#ifndef EPETRA_NO_64BIT_GLOBAL_INDICES
int ExtractGlobalRowView(long long GlobalRow, int& NumIndices, long long*& Indices) const;
#endif
//! Get a view of the elements in a specified local row of the graph.
/*!
This function requires that the graph be completed FillComplete() was called).
\param Row - (In) Local row number to get indices.
\param NumIndices - (Out) Number of Indices.
\param Indices - (Out) Column indices corresponding to values.
\return Integer error code, set to 0 if successful. Returns -1 if invalid row. Returns -2 if graph is not completed.
\pre IndicesAreLocal()==true
*/
int ExtractMyRowView(int LocalRow, int& NumIndices, int*& Indices) const;
//@}
//! @name Graph Properties Query Methods
//@{
//! If FillComplete() has been called, this query returns true, otherwise it returns false.
bool Filled() const {return(CrsGraphData_->Filled_);}
//! If OptimizeStorage() has been called, this query returns true, otherwise it returns false.
bool StorageOptimized() const {return(CrsGraphData_->StorageOptimized_);}
//! If column indices are in global range, this query returns true, otherwise it returns false.
bool IndicesAreGlobal() const {return(CrsGraphData_->IndicesAreGlobal_);}
//! If column indices are in local range, this query returns true, otherwise it returns false.
bool IndicesAreLocal() const {return(CrsGraphData_->IndicesAreLocal_);}
//! If graph is lower triangular in local index space, this query returns true, otherwise it returns false.
/*!
\pre Filled()==true
*/
bool LowerTriangular() const {return(CrsGraphData_->LowerTriangular_);}
//! If graph is upper triangular in local index space, this query returns true, otherwise it returns false.
/*!
\pre Filled()==true
*/
bool UpperTriangular() const {return(CrsGraphData_->UpperTriangular_);}
//! If graph has no diagonal entries in global index space, this query returns true, otherwise it returns false.
/*!
\pre Filled()==true
*/
bool NoDiagonal() const {return(CrsGraphData_->NoDiagonal_);}
//! Returns true of GID is owned by the calling processor, otherwise it returns false.
#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
bool MyGlobalRow(int GID) const {return(RowMap().MyGID(GID));}
#endif
#ifndef EPETRA_NO_64BIT_GLOBAL_INDICES
bool MyGlobalRow(long long GID) const {return(RowMap().MyGID(GID));}
#endif
//! Returns true if we have a well-defined ColMap, and returns false otherwise.
/*! \pre We have a well-defined ColMap if a) a ColMap was passed in at construction,
or b) the MakeColMap function has been called. (Calling either of the FillComplete functions
will result in MakeColMap being called.)
*/
bool HaveColMap() const {return(CrsGraphData_->HaveColMap_);}
//@}
//! @name Attribute access functions
//@{
//! Returns the number of matrix rows on this processor.
int NumMyRows() const {return(CrsGraphData_->NumMyRows_);}
//! Returns the number of matrix rows in global matrix.
#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
int NumGlobalRows() const {
if(RowMap().GlobalIndicesInt())
return (int) NumGlobalRows64();
throw "Epetra_CrsGraph::NumGlobalRows: GlobalIndices not int.";
}
#endif
long long NumGlobalRows64() const {return(CrsGraphData_->NumGlobalRows_);}
//! Returns the number of entries in the set of column-indices that appear on this processor.
/*! The set of column-indices that appear on this processor is the union of column-indices that
appear in all local rows. The size of this set isn't available until FillComplete() has been called.
\pre Filled()==true
*/
int NumMyCols() const {return(CrsGraphData_->NumMyCols_);}
//! Returns the number of matrix columns in global matrix.
/*!
\pre Filled()==true
*/
#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
int NumGlobalCols() const {
if(RowMap().GlobalIndicesInt())
return (int) NumGlobalCols64();
throw "Epetra_CrsGraph::NumGlobalCols: GlobalIndices not int.";
}
#endif
long long NumGlobalCols64() const {return(CrsGraphData_->NumGlobalCols_);}
//! Returns the number of indices in the global graph.
/*! Note that if the graph's maps are defined such that some nonzeros
appear on more than one processor, then those nonzeros will be
counted more than once. If the user wishes to assemble a graph from
overlapping data, they can use Epetra_FECrsGraph.
\pre Filled()==true
*/
#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
int NumGlobalNonzeros() const {
if(RowMap().GlobalIndicesInt())
return (int) NumGlobalNonzeros64();
throw "Epetra_CrsGraph::NumGlobalNonzeros: GlobalIndices not int.";
}
#endif
long long NumGlobalNonzeros64() const {return(CrsGraphData_->NumGlobalNonzeros_);}
//! Returns the number of diagonal entries in the global graph, based on global row/column index comparisons.
/*!
\pre Filled()==true
*/
#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
int NumGlobalDiagonals() const {
if(RowMap().GlobalIndicesInt())
return (int) NumGlobalDiagonals64();
throw "Epetra_CrsGraph::NumGlobalDiagonals: GlobalIndices not int.";
}
#endif
long long NumGlobalDiagonals64() const {return(CrsGraphData_->NumGlobalDiagonals_);}
//! Returns the number of diagonal entries in the local graph, based on global row/column index comparisons.
/*!
\pre Filled()==true
*/
int NumMyDiagonals() const {return(CrsGraphData_->NumMyDiagonals_);}
//! Returns the number of block matrix rows on this processor.
int NumMyBlockRows() const {return(CrsGraphData_->NumMyBlockRows_);}
//! Returns the number of Block matrix rows in global matrix.
#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
int NumGlobalBlockRows() const {
if(RowMap().GlobalIndicesInt())
return (int) NumGlobalBlockRows64();
throw "Epetra_CrsGraph::NumGlobalBlockRows: GlobalIndices not int.";
}
#endif
long long NumGlobalBlockRows64() const {return(CrsGraphData_->NumGlobalBlockRows_);}
//! Returns the number of Block matrix columns on this processor.
/*!
\pre Filled()==true
*/
int NumMyBlockCols() const {return(CrsGraphData_->NumMyBlockCols_);}
//! Returns the number of Block matrix columns in global matrix.
/*!
\pre Filled()==true
*/
#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
int NumGlobalBlockCols() const {
if(RowMap().GlobalIndicesInt())
return (int) NumGlobalBlockCols64();
throw "Epetra_CrsGraph::NumGlobalBlockCols: GlobalIndices not int.";
}
#endif
long long NumGlobalBlockCols64() const {return(CrsGraphData_->NumGlobalBlockCols_);}
//! Returns the number of Block diagonal entries in the local graph, based on global row/column index comparisons.
/*!
\pre Filled()==true
*/
int NumMyBlockDiagonals() const {return(CrsGraphData_->NumMyBlockDiagonals_);}
//! Returns the number of Block diagonal entries in the global graph, based on global row/column index comparisons.
/*!
\pre Filled()==true
*/
#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
int NumGlobalBlockDiagonals() const {
if(RowMap().GlobalIndicesInt())
return (int) NumGlobalBlockDiagonals64();
throw "Epetra_CrsGraph::NumGlobalBlockDiagonals: GlobalIndices not int.";
}
#endif
long long NumGlobalBlockDiagonals64() const {return(CrsGraphData_->NumGlobalBlockDiagonals_);}
//! Returns the number of entries in the global graph.
/*!
\pre Filled()==true
*/
#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
int NumGlobalEntries() const {
if(RowMap().GlobalIndicesInt())
return (int) NumGlobalEntries64();
throw "Epetra_CrsGraph::NumGlobalEntries: GlobalIndices not int.";
}
#endif
long long NumGlobalEntries64() const {return(CrsGraphData_->NumGlobalEntries_);}
//! Returns the number of entries on this processor.
/*!
\pre Filled()==true
*/
int NumMyEntries() const {return(CrsGraphData_->NumMyEntries_);}
//! Returns the max row dimension of block entries on the processor.
/*!
\pre Filled()==true
*/
int MaxRowDim() const {return(CrsGraphData_->MaxRowDim_);}
//! Returns the max row dimension of block entries across all processors.
/*!
\pre Filled()==true
*/
int GlobalMaxRowDim() const {return(CrsGraphData_->GlobalMaxRowDim_);}
//! Returns the max column dimension of block entries on the processor.
/*!
\pre Filled()==true
*/
int MaxColDim() const {return(CrsGraphData_->MaxColDim_);}
//! Returns the max column dimension of block entries across all processors.
/*!
\pre Filled()==true
*/
int GlobalMaxColDim() const {return(CrsGraphData_->GlobalMaxColDim_);}
//! Returns the number of indices in the local graph.
/*!
\pre Filled()==true
*/
int NumMyNonzeros() const {return(CrsGraphData_->NumMyNonzeros_);}
//! Returns the current number of nonzero entries in specified global row on this processor.
int NumGlobalIndices(long long Row) const;
//! Returns the allocated number of nonzero entries in specified global row on this processor.
int NumAllocatedGlobalIndices(long long Row) const;
//! Returns the maximum number of nonzero entries across all rows on this processor.
/*!
\pre Filled()==true
*/
int MaxNumIndices() const {return(CrsGraphData_->MaxNumIndices_);}
//! Returns the maximun number of nonzero entries across all rows across all processors.
/*!
\pre Filled()==true
*/
int GlobalMaxNumIndices() const {return(CrsGraphData_->GlobalMaxNumIndices_);}
//! Returns the maximum number of nonzero points across all rows on this processor.
/*! For each entry in the graph, let i = the GRID of the entry and j = the CGID of the entry. Then
the entry size is the product of the rowmap elementsize of i and the colmap elementsize of i.
Let ki = sum of all entry sizes for the entries in the ith row.
For example,
if the ith block row had 5 block entries and the element size of each entry was 4-by-4, ki would be 80.
Then this function returns the max over all ki for all row on this processor.
\pre Filled()==true
*/
int MaxNumNonzeros() const {return(CrsGraphData_->MaxNumNonzeros_);}
//! Returns the maximun number of nonzero points across all rows across all processors.
/*! This function returns the max over all processor of MaxNumNonzeros().
\pre Filled()==true
*/
int GlobalMaxNumNonzeros() const {return(CrsGraphData_->GlobalMaxNumNonzeros_);}
//! Returns the current number of nonzero entries in specified local row on this processor.
int NumMyIndices(int Row) const {if (Row<0 || Row >= NumMyRows()) return(0);
if (StorageOptimized()) return(CrsGraphData_->IndexOffset_[Row+1] - CrsGraphData_->IndexOffset_[Row]);
else return(CrsGraphData_->NumIndicesPerRow_[Row]);}
//! Returns the allocated number of nonzero entries in specified local row on this processor.
int NumAllocatedMyIndices(int Row) const {if (Row<0 || Row >= NumMyRows()) return(0);
if (StorageOptimized()) return(CrsGraphData_->IndexOffset_[Row+1] - CrsGraphData_->IndexOffset_[Row]);
else return(CrsGraphData_->NumAllocatedIndicesPerRow_[Row]);}
//! Returns the index base for row and column indices for this graph.
#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
//! Index base for this map.
int IndexBase() const {
if(RowMap().GlobalIndicesInt())
return (int) IndexBase64();
throw "Epetra_CrsGraph::IndexBase: GlobalIndices not int.";
}
#endif
long long IndexBase64() const {return(CrsGraphData_->IndexBase_);};
//! Returns the RowMap associated with this graph.
const Epetra_BlockMap& RowMap() const {return(Epetra_DistObject::Map());}
/** Replaces the current RowMap with the user-specified map object, but only
if currentmap->PointSameAs(newmap) is true. This is a collective function.
Returns 0 if map is replaced, -1 if not.
\pre RowMap().PointSameAs(newmap)==true
*/
int ReplaceRowMap(const Epetra_BlockMap& newmap);
/** Replaces the current ColMap with the user-specified map object, but only
if no entries have been inserted into the graph yet (both IndicesAreLocal()
and IndicesAreGlobal() are false) or currentmap->PointSameAs(newmap) is true.
This is a collective function.
Returns 0 if map is replaced, -1 if not.
\pre (IndicesAreLocal()==false && IndicesAreGlobal()==false) || ColMap().PointSameAs(newmap)==true
*/
int ReplaceColMap(const Epetra_BlockMap& newmap);
//! Replaces the current DomainMap & Importer with the user-specified map object.
/** Replaces the current DomainMap and Importer with the user-specified map object, but only
if the matrix has been FillCompleted, Importer's TargetMap matches the ColMap
and Importer's SourceMap matches the DomainMap (assuming the importer isn't null). If an Importer
is passed in, Epetra_CrsMatrix will copy it.
Returns 0 if map/importer is replaced, -1 if not.
\pre (!NewImporter && ColMap().PointSameAs(NewDomainMap)) || (NewImporter && ColMap().PointSameAs(NewImporter->TargetMap()) && NewDomainMap.PointSameAs(NewImporter->SourceMap()))
*/
int ReplaceDomainMapAndImporter(const Epetra_BlockMap& NewDomainMap, const Epetra_Import * NewImporter);
//! Remove processes owning zero rows from the Maps and their communicator.
/** Remove processes owning zero rows from the Maps and their communicator.
\warning This method is ONLY for use by experts.
\warning We make NO promises of backwards compatibility.
This method may change or disappear at any time.
\param newMap [in] This <i>must</i> be the result of calling
the removeEmptyProcesses() method on the row BlockMap. If it
is not, this method's behavior is undefined. This pointer
will be null on excluded processes.
*/
int RemoveEmptyProcessesInPlace(const Epetra_BlockMap * NewMap);
//! Returns the Column Map associated with this graph.
/*!
\pre HaveColMap()==true
*/
const Epetra_BlockMap& ColMap() const {return(CrsGraphData_->ColMap_);}
//! Returns the DomainMap associated with this graph.
/*!
\pre Filled()==true
*/
const Epetra_BlockMap& DomainMap() const {return(CrsGraphData_->DomainMap_);}
//! Returns the RangeMap associated with this graph.
/*!
\pre Filled()==true
*/
const Epetra_BlockMap& RangeMap() const {return(CrsGraphData_->RangeMap_);}
//! Returns the Importer associated with this graph.
const Epetra_Import* Importer() const {return(CrsGraphData_->Importer_);}
//! Returns the Exporter associated with this graph.
const Epetra_Export* Exporter() const {return(CrsGraphData_->Exporter_);}
//! Returns a pointer to the Epetra_Comm communicator associated with this graph.
const Epetra_Comm& Comm() const {return(Epetra_DistObject::Comm());}
//@}
//! @name Local/Global ID methods
//@{
//! Returns the local row index for given global row index, returns -1 if no local row for this global row.
#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
int LRID(int GRID_in) const {return(RowMap().LID(GRID_in));}
#endif
#ifndef EPETRA_NO_64BIT_GLOBAL_INDICES
int LRID(long long GRID_in) const {return(RowMap().LID(GRID_in));}
#endif
#if defined(EPETRA_NO_32BIT_GLOBAL_INDICES) && defined(EPETRA_NO_64BIT_GLOBAL_INDICES)
// default implementation so that no compiler/linker error in case neither 32 nor 64
// bit indices present.
int LRID(long long GRID_in) const {return(RowMap().LID(GRID_in));}
#endif
//! Returns the global row index for give local row index, returns IndexBase-1 if we don't have this local row.
#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
int GRID(int LRID_in) const {
if(RowMap().GlobalIndicesInt())
return (int) GRID64(LRID_in);
throw "Epetra_CrsGraph::GRID: GlobalIndices not int.";
}
#endif
long long GRID64(int LRID_in) const {return(RowMap().GID64(LRID_in));}
//! Returns the local column index for given global column index, returns -1 if no local column for this global column.
/*!
\pre HaveColMap()==true (If HaveColMap()==false, returns -1)
*/
#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
int LCID(int GCID_in) const
{
return( CrsGraphData_->HaveColMap_ ? ColMap().LID(GCID_in) : -1 );
}
#endif
#ifndef EPETRA_NO_64BIT_GLOBAL_INDICES
int LCID(long long GCID_in) const
{
return( CrsGraphData_->HaveColMap_ ? ColMap().LID(GCID_in) : -1 );
}
#endif
//! Returns the global column index for give local column index, returns IndexBase-1 if we don't have this local column.
/*!
\pre HaveColMap()==true (If HaveColMap()==false, returns -1)
*/
#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
int GCID(int LCID_in) const {
if(RowMap().GlobalIndicesInt())
return (int) GCID64(LCID_in);
throw "Epetra_CrsGraph::GCID: GlobalIndices not int.";
}
#endif
long long GCID64(int LCID_in) const
{
return( CrsGraphData_->HaveColMap_ ? ColMap().GID64(LCID_in) : -1 );
}
//! Returns true if the GRID passed in belongs to the calling processor in this map, otherwise returns false.
#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
bool MyGRID(int GRID_in) const {return(LRID(GRID_in) != -1);}
#endif
#ifndef EPETRA_NO_64BIT_GLOBAL_INDICES
bool MyGRID(long long GRID_in) const {return(LRID(GRID_in) != -1);}
#endif
//! Returns true if the LRID passed in belongs to the calling processor in this map, otherwise returns false.
bool MyLRID(int LRID_in) const {return(GRID64(LRID_in) != IndexBase64() - 1);}
//! Returns true if the GCID passed in belongs to the calling processor in this map, otherwise returns false.
/*!
\pre HaveColMap()==true (If HaveColMap()==false, returns -1)
*/
#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
bool MyGCID(int GCID_in) const {return(LCID(GCID_in) != -1);}
#endif
#ifndef EPETRA_NO_64BIT_GLOBAL_INDICES
bool MyGCID(long long GCID_in) const {return(LCID(GCID_in) != -1);}
#endif
//! Returns true if the LRID passed in belongs to the calling processor in this map, otherwise returns false.
/*!
\pre HaveColMap()==true (If HaveColMap()==false, returns -1)
*/
bool MyLCID(int LCID_in) const {return(GCID64(LCID_in) != IndexBase64() - 1);}
//@}
//! @name Inlined Operator Methods
//@{
//! Inlined bracket operator for fast access to data. (Const and Non-const versions)
/*! No error checking and dangerous for optimization purposes.
\param Loc (In) - Local row.
\return reference to pointer to locally indexed Loc row in matrix.
*/
inline int* operator[]( int Loc ) {
if (StorageOptimized()){ return(CrsGraphData_->data->All_Indices_.Values() + CrsGraphData_->IndexOffset_[Loc]);}
else return(CrsGraphData_->data->Indices_[Loc]); }
inline int* operator[]( int Loc ) const {
if (StorageOptimized()) { return(CrsGraphData_->data->All_Indices_.Values() +CrsGraphData_->IndexOffset_[Loc]);}
else return(CrsGraphData_->data->Indices_[Loc]); }
//@}
//! Assignment operator
/*! This will do a Level 1 deep copy. It will share ownership of the CrsGraphData
with the right hand side Graph.
*/
Epetra_CrsGraph& operator = (const Epetra_CrsGraph& Source);
//! @name I/O Methods
//@{
//! Print method
virtual void Print(std::ostream& os) const;
void PrintGraphData(std::ostream& os) const {CrsGraphData_->Print(os);}
void PrintGraphData(std::ostream& os, int level) const {CrsGraphData_->Print(os, level);}
//@}
//! @name Deprecated methods: These methods still work, but will be removed in a future version
//@{
//! Use ColMap() instead.
const Epetra_BlockMap& ImportMap() const {return(CrsGraphData_->ColMap_);}
//! Use FillComplete() instead.
int TransformToLocal();
//! Use FillComplete(const Epetra_BlockMap& DomainMap, const Epetra_BlockMap& RangeMap) instead.
int TransformToLocal(const Epetra_BlockMap* DomainMap, const Epetra_BlockMap* RangeMap);
//@}
//! @name Expert Users and Developers Only
//@{
//! Returns the reference count of CrsGraphData.
/*! (Intended for testing purposes.) */
int ReferenceCount() const {return(CrsGraphData_->ReferenceCount());}
//! Returns a pointer to the CrsGraphData instance this CrsGraph uses.
/*! (Intended for developer use only for testing purposes.) */
const Epetra_CrsGraphData* DataPtr() const {return(CrsGraphData_);}
//! Forces FillComplete() to locally order ghostnodes associated with each remote processor in ascending order.
/*! To be compliant with AztecOO, FillComplete() already locally orders ghostnodes such that
information received from processor k has a lower local numbering than information received
from processor j if k is less than j. SortGhostsAssociatedWithEachProcessor(True) further
forces FillComplete() to locally number all ghostnodes received from processor k in ascending
order. That is, the local numbering of b is less than c if the global numbering of b is less
than c and if both b and c are owned by the same processor. This is done to be compliant with
some limited block features within ML. In particular, some ML features require that a block
structure of the matrix be maintained even within the ghost variables.
*/
void SortGhostsAssociatedWithEachProcessor(bool Flag) {CrsGraphData_->SortGhostsAssociatedWithEachProcessor_ = Flag;}
//@}
// functions listed in protected are the ones used by CrsMatrix and VbrMatrix.
// functions listed in private are the ones that are really private.
// (just pretend CrsMatrix and VbrMatrix derive from CrsGraph to understand the distinction.)
friend class Epetra_CrsMatrix;
friend class Epetra_VbrMatrix;
friend class Epetra_FECrsGraph;
friend class Epetra_FECrsMatrix;
friend class Epetra_FEVbrMatrix;
friend class Epetra_OffsetIndex;
protected:
int *All_Indices() const {
if (!StorageOptimized()) throw ReportError("This method: int *All_Indices() cannot be called when StorageOptimized()==false", -1);
else return(CrsGraphData_->data->All_Indices_.Values());}
#if defined(Epetra_ENABLE_MKL_SPARSE) && !defined(Epetra_DISABLE_MKL_SPARSE_MM)
int *All_IndicesPlus1() const;
#endif
int *IndexOffset() const {
if (!StorageOptimized()) throw ReportError("This method: int *IndexOffset() cannot be called when StorageOptimized()==false", -1);
else return(CrsGraphData_->IndexOffset_.Values());}
int* NumIndicesPerRow() const {
if (StorageOptimized()) throw ReportError("This method: int* NumIndicesPerRow() cannot be called when StorageOptimized()==true", -1);
else return(CrsGraphData_->NumIndicesPerRow_.Values());}
int* NumAllocatedIndicesPerRow() const {
if (StorageOptimized()) throw ReportError("This method: int* NumAllocatedIndicesPerRow() cannot be called when StorageOptimized()==true", -1);
else return(CrsGraphData_->NumAllocatedIndicesPerRow_.Values());}
int** Indices() const {
if (StorageOptimized()) throw ReportError("This method: int** Indices() cannot be called when StorageOptimized()==true", -1);
else return(CrsGraphData_->data->Indices_);}
int* Indices(int LocalRow) const {
if (StorageOptimized()) return(CrsGraphData_->data->All_Indices_.Values()+CrsGraphData_->IndexOffset_[LocalRow]);
else return(CrsGraphData_->data->Indices_[LocalRow]);}
template<typename int_type>
int_type** TIndices() const {
if (StorageOptimized()) throw ReportError("This method: int_type** TIndices() cannot be called when StorageOptimized()==true", -1);
else return(CrsGraphData_->Data<int_type>().Indices_);}
template<typename int_type>
int_type* TIndices(int LocalRow) const {
if (StorageOptimized()) return(CrsGraphData_->Data<int_type>().All_Indices_.Values()+CrsGraphData_->IndexOffset_[LocalRow]);
else return(CrsGraphData_->Data<int_type>().Indices_[LocalRow]);}
// If column indices are stored in one long array (via a call to OptimizeStorage),
// IndicesAreContiguous returns true, otherwise it returns false.
bool IndicesAreContiguous() const {return(CrsGraphData_->IndicesAreContiguous_);}
bool StaticProfile() const {return(CrsGraphData_->StaticProfile_);}
bool GlobalConstantsComputed() const;
#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
bool FindGlobalIndexLoc(int LocalRow, int Index, int Start, int& Loc) const;
bool FindGlobalIndexLoc(int NumIndices, const int* Indices, int Index, int Start, int& Loc) const;
#endif
#ifndef EPETRA_NO_64BIT_GLOBAL_INDICES
bool FindGlobalIndexLoc(int LocalRow, long long Index, int Start, int& Loc) const;
bool FindGlobalIndexLoc(int NumIndices, const long long* Indices, long long Index, int Start, int& Loc) const;
#endif
bool FindMyIndexLoc(int LocalRow, int Index, int Start, int& Loc) const;
bool FindMyIndexLoc(int NumIndices, const int* Indices, int Index, int Start, int& Loc) const;
#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
int InsertIndices(int Row, int NumIndices, int* Indices);
int InsertIndicesIntoSorted(int Row, int NumIndices, int* Indices);
#endif
#ifndef EPETRA_NO_64BIT_GLOBAL_INDICES
int InsertIndices(int Row, int NumIndices, long long* Indices);
int InsertIndicesIntoSorted(int Row, int NumIndices, long long* Indices);
#endif
int MakeIndicesLocal(const Epetra_BlockMap& DomainMap, const Epetra_BlockMap& RangeMap);
void SetIndicesAreLocal(bool Flag) {CrsGraphData_->IndicesAreLocal_ = Flag;}
void SetIndicesAreGlobal(bool Flag) {CrsGraphData_->IndicesAreGlobal_ = Flag;}
void SetSorted(bool Flag) {CrsGraphData_->Sorted_ = Flag;}
//! Sort column indices, row-by-row, in ascending order.
/*!
\return Integer error code, set to 0 if successful. Returns 1 if data is shared.
*/
int SortIndices();
//! If SortIndices() has been called, this query returns true, otherwise it returns false.
bool Sorted() const {return(CrsGraphData_->Sorted_);}
//! Removes any redundant column indices in the rows of the graph.
/*!
\return Integer error code, set to 0 if successful. Returns 1 if data is shared.
*/
int RemoveRedundantIndices();
int DetermineTriangular();
//! If RemoveRedundantIndices() has been called, this query returns true, otherwise it returns false.
bool NoRedundancies() const {return(CrsGraphData_->NoRedundancies_);}
private:
void SetGlobalConstantsComputed(bool Flag) {CrsGraphData_->GlobalConstantsComputed_ = Flag;}
void SetIndicesAreContiguous(bool Flag) {CrsGraphData_->IndicesAreContiguous_ = Flag;}
void SetNoRedundancies(bool Flag) {CrsGraphData_->NoRedundancies_ = Flag;}
void ComputeIndexState();
int MakeColMap(const Epetra_BlockMap& DomainMap, const Epetra_BlockMap& RangeMap);
#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
int MakeColMap_int(const Epetra_BlockMap& DomainMap, const Epetra_BlockMap& RangeMap);
#endif
#ifndef EPETRA_NO_64BIT_GLOBAL_INDICES
int MakeColMap_LL (const Epetra_BlockMap& DomainMap, const Epetra_BlockMap& RangeMap);
#endif
int Allocate(const int* NumIndicesPerRow, int Inc, bool StaticProfile);
//int ReAllocate();
int ComputeGlobalConstants();
void SetFilled(bool Flag) {CrsGraphData_->Filled_ = Flag;}
bool Allocated() const {return(CrsGraphData_->Allocated_);}
void SetAllocated(bool Flag) {CrsGraphData_->Allocated_ = Flag;}
int CheckSizes(const Epetra_SrcDistObject& A);
int CopyAndPermute(const Epetra_SrcDistObject& Source,
int NumSameIDs,
int NumPermuteIDs,
int* PermuteToLIDs,
int* PermuteFromLIDs,
const Epetra_OffsetIndex * Indexor,
Epetra_CombineMode CombineMode = Zero);
int CopyAndPermuteRowMatrix(const Epetra_RowMatrix& A,
int NumSameIDs,
int NumPermuteIDs,
int* PermuteToLIDs,
int* PermuteFromLIDs,
const Epetra_OffsetIndex * Indexor,
Epetra_CombineMode CombineMode);
template<typename int_type>
int CopyAndPermuteRowMatrix(const Epetra_RowMatrix& A,
int NumSameIDs,
int NumPermuteIDs,
int* PermuteToLIDs,
int* PermuteFromLIDs,
const Epetra_OffsetIndex * Indexor,
Epetra_CombineMode CombineMode);
int CopyAndPermuteCrsGraph(const Epetra_CrsGraph& A,
int NumSameIDs,
int NumPermuteIDs,
int* PermuteToLIDs,
int* PermuteFromLIDs,
const Epetra_OffsetIndex * Indexor,
Epetra_CombineMode CombineMode);
template<typename int_type>
int CopyAndPermuteCrsGraph(const Epetra_CrsGraph& A,
int NumSameIDs,
int NumPermuteIDs,
int* PermuteToLIDs,
int* PermuteFromLIDs,
const Epetra_OffsetIndex * Indexor,
Epetra_CombineMode CombineMode);
int PackAndPrepare(const Epetra_SrcDistObject& Source,
int NumExportIDs,
int* ExportLIDs,
int& LenExports,
char*& Exports,
int& SizeOfPacket,
int * Sizes,
bool & VarSizes,
Epetra_Distributor& Distor);
int PackAndPrepareCrsGraph(const Epetra_CrsGraph& A,
int NumExportIDs,
int* ExportLIDs,
int& LenExports,
char*& Exports,
int& SizeOfPacket,
int* Sizes,
bool& VarSizes,
Epetra_Distributor& Distor);
int PackAndPrepareRowMatrix(const Epetra_RowMatrix& A,
int NumExportIDs,
int* ExportLIDs,
int& LenExports,
char*& Exports,
int& SizeOfPacket,
int* Sizes,
bool& VarSizes,
Epetra_Distributor& Distor);
int UnpackAndCombine(const Epetra_SrcDistObject& Source,
int NumImportIDs,
int* ImportLIDs,
int LenImports,
char* Imports,
int& SizeOfPacket,
Epetra_Distributor& Distor,
Epetra_CombineMode CombineMode,
const Epetra_OffsetIndex * Indexor);
void CleanupData();
Epetra_CrsGraphData* CrsGraphData_;
private:
template<typename int_type>
int TAllocate(const int* numIndicesPerRow, int Inc, bool staticProfile);
template<typename int_type>
int InsertGlobalIndices(int_type GlobalRow, int NumIndices, int_type* Indices);
template<typename int_type>
int InsertIndices(int Row, int NumIndices, int_type* Indices);
template<typename int_type>
int InsertIndicesIntoSorted(int Row, int NumIndices, int_type* Indices);
template<typename int_type>
int RemoveGlobalIndices(int_type GlobalRow, int NumIndices, int_type* Indices);
template<typename int_type>
int TRemoveGlobalIndices(long long Row);
template<typename int_type>
bool FindGlobalIndexLoc(int LocalRow, int_type Index, int Start, int& Loc) const;
template<typename int_type>
bool FindGlobalIndexLoc(int NumIndices, const int_type* Indices, int_type Index, int Start, int& Loc) const;
template<typename int_type>
int ExtractGlobalRowCopy(int_type Row, int LenOfIndices, int& NumIndices, int_type* Indices) const;
template<typename int_type>
int ExtractMyRowCopy(int Row, int LenOfIndices, int& NumIndices, int_type* targIndices) const;
};
#endif /* EPETRA_CRSGRAPH_H */
|