/usr/include/deal.II/lac/dynamic_sparsity_pattern.h is in libdeal.ii-dev 8.4.2-2+b1.
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 | // ---------------------------------------------------------------------
//
// Copyright (C) 2011 - 2015 by the deal.II authors
//
// This file is part of the deal.II library.
//
// The deal.II library is free software; you can use it, redistribute
// it, and/or modify it under the terms of the GNU Lesser General
// Public License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
// The full text of the license can be found in the file LICENSE at
// the top level of the deal.II distribution.
//
// ---------------------------------------------------------------------
#ifndef dealii__dynamic_sparsity_pattern_h
#define dealii__dynamic_sparsity_pattern_h
#include <deal.II/base/config.h>
#include <deal.II/base/subscriptor.h>
#include <deal.II/base/utilities.h>
#include <deal.II/lac/exceptions.h>
#include <deal.II/base/index_set.h>
#include <vector>
#include <algorithm>
#include <iostream>
DEAL_II_NAMESPACE_OPEN
template <typename number> class SparseMatrix;
class DynamicSparsityPattern;
/*! @addtogroup Sparsity
*@{
*/
/**
* Iterators on objects of type DynamicSparsityPattern.
*/
namespace DynamicSparsityPatternIterators
{
// forward declaration
class Iterator;
/**
* Declare type for container size.
*/
typedef types::global_dof_index size_type;
/**
* Accessor class for iterators into objects of type DynamicSparsityPattern.
*
* Note that this class only allows read access to elements, providing their
* row and column number (or alternatively the index within the complete
* sparsity pattern). It does not allow modifying the sparsity pattern
* itself.
*
* @author Wolfgang Bangerth
* @date 2015
*/
class Accessor
{
public:
/**
* Constructor.
*/
Accessor (const DynamicSparsityPattern *sparsity_pattern,
const size_type row,
const unsigned int index_within_row);
/**
* Constructor. Construct the end accessor for the given sparsity pattern.
*/
Accessor (const DynamicSparsityPattern *sparsity_pattern);
/**
* Row number of the element represented by this object.
*/
size_type row () const;
/**
* Index within the current row of the element represented by this object.
*/
size_type index () const;
/**
* Column number of the element represented by this object.
*/
size_type column () const;
/**
* Comparison. True, if both iterators point to the same matrix position.
*/
bool operator == (const Accessor &) const;
/**
* Comparison operator. Result is true if either the first row number is
* smaller or if the row numbers are equal and the first index is smaller.
*
* This function is only valid if both iterators point into the same
* sparsity pattern.
*/
bool operator < (const Accessor &) const;
protected:
/**
* The sparsity pattern we operate on accessed.
*/
const DynamicSparsityPattern *sparsity_pattern;
/**
* The row we currently point into.
*/
size_type current_row;
/**
* A pointer to the element within the current row that we currently point
* to.
*/
std::vector<size_type>::const_iterator current_entry;
/**
* A pointer to the end of the current row. We store this to make
* comparison against the end of line iterator cheaper as it otherwise
* needs to do the IndexSet translation from row index to the index within
* the 'lines' array of DynamicSparsityPattern.
*/
std::vector<size_type>::const_iterator end_of_row;
/**
* Move the accessor to the next nonzero entry in the matrix.
*/
void advance ();
/**
* Grant access to iterator class.
*/
friend class Iterator;
};
/**
* An iterator class for walking over the elements of a sparsity pattern.
*
* The typical use for these iterators is to iterate over the elements of a
* sparsity pattern (or, since they also serve as the basis for iterating
* over the elements of an associated matrix, over the elements of a sparse
* matrix), or over the elements of individual rows. There is no guarantee
* that the elements of a row are actually traversed in an order in which
* column numbers monotonically increase. See the documentation of the
* SparsityPattern class for more information.
*
* @note This class operates directly on the internal data structures of the
* DynamicSparsityPattern class. As a consequence, some operations are cheap
* and some are not. In particular, it is cheap to access the column index
* of the sparsity pattern entry pointed to. On the other hand, it is
* expensive to compute the distance between two iterators. As a
* consequence, when you design algorithms that use these iterators, it is
* common practice to not loop over <i>all</i> elements of a sparsity
* pattern at once, but to have an outer loop over all rows and within this
* loop iterate over the elements of this row. This way, you only ever need
* to dereference the iterator to obtain the column indices whereas the
* (expensive) lookup of the row index can be avoided by using the loop
* index instead.
*/
class Iterator
{
public:
/**
* Constructor. Create an iterator into the sparsity pattern @p sp for the
* given global index (i.e., the index of the given element counting from
* the zeroth row).
*/
Iterator (const DynamicSparsityPattern *sp,
const size_type row,
const unsigned int index_within_row);
/**
* Constructor. Create an invalid (end) iterator into the sparsity pattern
* @p sp.
*/
Iterator (const DynamicSparsityPattern *sp);
/**
* Prefix increment.
*/
Iterator &operator++ ();
/**
* Postfix increment.
*/
Iterator operator++ (int);
/**
* Dereferencing operator.
*/
const Accessor &operator* () const;
/**
* Dereferencing operator.
*/
const Accessor *operator-> () const;
/**
* Comparison. True, if both iterators point to the same matrix position.
*/
bool operator == (const Iterator &) const;
/**
* Inverse of <tt>==</tt>.
*/
bool operator != (const Iterator &) const;
/**
* Comparison operator. Result is true if either the first row number is
* smaller or if the row numbers are equal and the first index is smaller.
*
* This function is only valid if both iterators point into the same
* matrix.
*/
bool operator < (const Iterator &) const;
/**
* Return the distance between the current iterator and the argument. The
* distance is given by how many times one has to apply operator++ to the
* current iterator to get the argument (for a positive return value), or
* operator-- (for a negative return value).
*/
int operator - (const Iterator &p) const;
private:
/**
* Store an object of the accessor class.
*/
Accessor accessor;
};
}
/**
* This class acts as an intermediate form of the SparsityPattern class. From
* the interface it mostly represents a SparsityPattern object that is kept
* compressed at all times. However, since the final sparsity pattern is not
* known while constructing it, keeping the pattern compressed at all times
* can only be achieved at the expense of either increased memory or run time
* consumption upon use. The main purpose of this class is to avoid some
* memory bottlenecks, so we chose to implement it memory conservative. The
* chosen data format is too unsuited to be used for actual matrices, though.
* It is therefore necessary to first copy the data of this object over to an
* object of type SparsityPattern before using it in actual matrices.
*
* Another viewpoint is that this class does not need up front allocation of a
* certain amount of memory, but grows as necessary. An extensive description
* of sparsity patterns can be found in the documentation of the
* @ref Sparsity
* module.
*
* This class is an example of the "dynamic" type of
* @ref Sparsity.
* It is used in most tutorial programs in one way or another.
*
* <h3>Interface</h3>
*
* Since this class is intended as an intermediate replacement of the
* SparsityPattern class, it has mostly the same interface, with small changes
* where necessary. In particular, the add() function, and the functions
* inquiring properties of the sparsity pattern are the same.
*
*
* <h3>Usage</h3>
*
* Use this class as follows:
* @code
* DynamicSparsityPattern dynamic_pattern (dof_handler.n_dofs());
* DoFTools::make_sparsity_pattern (dof_handler,
* dynamic_pattern);
* constraints.condense (dynamic_pattern);
*
* SparsityPattern sp;
* sp.copy_from (dynamic_pattern);
* @endcode
*
* @author Timo Heister, 2008
*/
class DynamicSparsityPattern : public Subscriptor
{
public:
/**
* Declare the type for container size.
*/
typedef types::global_dof_index size_type;
/**
* Typedef an for iterator class that allows to walk over all nonzero
* elements of a sparsity pattern.
*
* Since the iterator does not allow to modify the sparsity pattern, this
* type is the same as that for @p const_iterator.
*/
typedef
DynamicSparsityPatternIterators::Iterator
iterator;
/**
* Typedef for an iterator class that allows to walk over all nonzero
* elements of a sparsity pattern.
*/
typedef
DynamicSparsityPatternIterators::Iterator
const_iterator;
/**
* Initialize as an empty object. This is useful if you want such objects as
* member variables in other classes. You can make the structure usable by
* calling the reinit() function.
*/
DynamicSparsityPattern ();
/**
* Copy constructor. This constructor is only allowed to be called if the
* sparsity structure to be copied is empty. This is so in order to prevent
* involuntary copies of objects for temporaries, which can use large
* amounts of computing time. However, copy constructors are needed if you
* want to place a DynamicSparsityPattern in a container, e.g. to write such
* statements like <tt>v.push_back (DynamicSparsityPattern());</tt>, with @p
* v a vector of @p DynamicSparsityPattern objects.
*/
DynamicSparsityPattern (const DynamicSparsityPattern &);
/**
* Initialize a rectangular sparsity pattern with @p m rows and @p n
* columns. The @p rowset restricts the storage to elements in rows of this
* set. Adding elements outside of this set has no effect. The default
* argument keeps all entries.
*/
DynamicSparsityPattern (const size_type m,
const size_type n,
const IndexSet &rowset = IndexSet());
/**
* Create a square SparsityPattern using the index set.
*/
DynamicSparsityPattern (const IndexSet &indexset);
/**
* Initialize a square pattern of dimension @p n.
*/
DynamicSparsityPattern (const size_type n);
/**
* Copy operator. For this the same holds as for the copy constructor: it is
* declared, defined and fine to be called, but the latter only for empty
* objects.
*/
DynamicSparsityPattern &operator = (const DynamicSparsityPattern &);
/**
* Reallocate memory and set up data structures for a new sparsity pattern
* with @p m rows and @p n columns. The @p rowset restricts the storage to
* elements in rows of this set. Adding elements outside of this set has no
* effect. The default argument keeps all entries.
*/
void reinit (const size_type m,
const size_type n,
const IndexSet &rowset = IndexSet());
/**
* Since this object is kept compressed at all times anyway, this function
* does nothing, but is declared to make the interface of this class as much
* alike as that of the SparsityPattern class.
*/
void compress ();
/**
* Return whether the object is empty. It is empty if no memory is
* allocated, which is the same as that both dimensions are zero.
*/
bool empty () const;
/**
* Return the maximum number of entries per row. Note that this number may
* change as entries are added.
*/
size_type max_entries_per_row () const;
/**
* Add a nonzero entry. If the entry already exists, this call does nothing.
*/
void add (const size_type i,
const size_type j);
/**
* Add several nonzero entries to the specified row. Already existing
* entries are ignored.
*/
template <typename ForwardIterator>
void add_entries (const size_type row,
ForwardIterator begin,
ForwardIterator end,
const bool indices_are_unique_and_sorted = false);
/**
* Check if a value at a certain position may be non-zero.
*/
bool exists (const size_type i,
const size_type j) const;
/**
* Make the sparsity pattern symmetric by adding the sparsity pattern of the
* transpose object.
*
* This function throws an exception if the sparsity pattern does not
* represent a square matrix.
*/
void symmetrize ();
/**
* Print the sparsity pattern. The output consists of one line per row of
* the format <tt>[i,j1,j2,j3,...]</tt>. <i>i</i> is the row number and
* <i>jn</i> are the allocated columns in this row.
*/
void print (std::ostream &out) const;
/**
* Print the sparsity pattern in a format that @p gnuplot understands and
* which can be used to plot the sparsity pattern in a graphical way. The
* format consists of pairs <tt>i j</tt> of nonzero elements, each
* representing one entry, one per line of the output file. Indices are
* counted from zero on, as usual. Since sparsity patterns are printed in
* the same way as matrices are displayed, we print the negative of the
* column index, which means that the <tt>(0,0)</tt> element is in the top
* left rather than in the bottom left corner.
*
* Print the sparsity pattern in gnuplot by setting the data style to dots
* or points and use the @p plot command.
*/
void print_gnuplot (std::ostream &out) const;
/**
* Return the number of rows, which equals the dimension of the image space.
*/
size_type n_rows () const;
/**
* Return the number of columns, which equals the dimension of the range
* space.
*/
size_type n_cols () const;
/**
* Number of entries in a specific row. This function can only be called if
* the given row is a member of the index set of rows that we want to store.
*/
size_type row_length (const size_type row) const;
/**
* Access to column number field. Return the column number of the @p
* indexth entry in @p row.
*/
size_type column_number (const size_type row,
const size_type index) const;
/**
* @name Iterators
*/
// @{
/**
* Iterator starting at the first entry of the matrix. The resulting
* iterator can be used to walk over all nonzero entries of the sparsity
* pattern.
*
* Note the discussion in the general documentation of this class about the
* order in which elements are accessed.
*
* @note If the sparsity pattern has been initialized with an IndexSet that
* denotes which rows to store, then iterators will simply skip over rows
* that are not stored. In other words, they will look like empty rows, but
* no exception will be generated when iterating over such rows.
*/
iterator begin () const;
/**
* Final iterator.
*/
iterator end () const;
/**
* Iterator starting at the first entry of row <tt>r</tt>.
*
* Note that if the given row is empty, i.e. does not contain any nonzero
* entries, then the iterator returned by this function equals
* <tt>end(r)</tt>. Note also that the iterator may not be dereferencable in
* that case.
*
* Note also the discussion in the general documentation of this class about
* the order in which elements are accessed.
*
* @note If the sparsity pattern has been initialized with an IndexSet that
* denotes which rows to store, then iterators will simply skip over rows
* that are not stored. In other words, they will look like empty rows, but
* no exception will be generated when iterating over such rows.
*/
iterator begin (const size_type r) const;
/**
* Final iterator of row <tt>r</tt>. It points to the first element past the
* end of line @p r, or past the end of the entire sparsity pattern.
*
* Note that the end iterator is not necessarily dereferencable. This is in
* particular the case if it is the end iterator for the last row of a
* matrix.
*/
iterator end (const size_type r) const;
// @}
/**
* Compute the bandwidth of the matrix represented by this structure. The
* bandwidth is the maximum of $|i-j|$ for which the index pair $(i,j)$
* represents a nonzero entry of the matrix.
*/
size_type bandwidth () const;
/**
* Return the number of nonzero elements allocated through this sparsity
* pattern.
*/
size_type n_nonzero_elements () const;
/**
* Return the IndexSet that sets which rows are active on the current
* processor. It corresponds to the IndexSet given to this class in the
* constructor or in the reinit function.
*/
const IndexSet &row_index_set () const;
/**
* return whether this object stores only those entries that have been added
* explicitly, or if the sparsity pattern contains elements that have been
* added through other means (implicitly) while building it. For the current
* class, the result is always true.
*
* This function mainly serves the purpose of describing the current class
* in cases where several kinds of sparsity patterns can be passed as
* template arguments.
*/
static
bool stores_only_added_elements ();
/**
* Determine an estimate for the memory consumption (in bytes) of this
* object.
*/
size_type memory_consumption () const;
private:
/**
* Number of rows that this sparsity structure shall represent.
*/
size_type rows;
/**
* Number of columns that this sparsity structure shall represent.
*/
size_type cols;
/**
* A set that contains the valid rows.
*/
IndexSet rowset;
/**
* Store some data for each row describing which entries of this row are
* nonzero. Data is stored sorted in the @p entries std::vector. The vector
* per row is dynamically growing upon insertion doubling its memory each
* time.
*/
struct Line
{
public:
/**
* Storage for the column indices of this row. This array is always kept
* sorted.
*/
std::vector<size_type> entries;
/**
* Constructor.
*/
Line ();
/**
* Add the given column number to this line.
*/
void add (const size_type col_num);
/**
* Add the columns specified by the iterator range to this line.
*/
template <typename ForwardIterator>
void add_entries (ForwardIterator begin,
ForwardIterator end,
const bool indices_are_sorted);
/**
* estimates memory consumption.
*/
size_type memory_consumption () const;
};
/**
* Actual data: store for each row the set of nonzero entries.
*/
std::vector<Line> lines;
// make the accessor class a friend
friend class DynamicSparsityPatternIterators::Accessor;
};
/*@}*/
/*---------------------- Inline functions -----------------------------------*/
namespace DynamicSparsityPatternIterators
{
inline
Accessor::
Accessor (const DynamicSparsityPattern *sparsity_pattern,
const size_type row,
const unsigned int index_within_row)
:
sparsity_pattern(sparsity_pattern),
current_row (row),
current_entry(((sparsity_pattern->rowset.size()==0)
?
sparsity_pattern->lines[current_row].entries.begin()
:
sparsity_pattern->lines[sparsity_pattern->rowset.index_within_set(current_row)].entries.begin())
+
index_within_row),
end_of_row((sparsity_pattern->rowset.size()==0)
?
sparsity_pattern->lines[current_row].entries.end()
:
sparsity_pattern->lines[sparsity_pattern->rowset.index_within_set(current_row)].entries.end())
{
AssertIndexRange(current_row, sparsity_pattern->n_rows());
Assert ((sparsity_pattern->rowset.size()==0)
||
sparsity_pattern->rowset.is_element(current_row),
ExcMessage ("You can't create an iterator into a "
"DynamicSparsityPattern's row that is not "
"actually stored by that sparsity pattern "
"based on the IndexSet argument to it."));
AssertIndexRange(index_within_row,
((sparsity_pattern->rowset.size()==0)
?
sparsity_pattern->lines[current_row].entries.size()
:
sparsity_pattern->lines[sparsity_pattern->rowset.index_within_set(current_row)].entries.size()));
}
inline
Accessor::
Accessor (const DynamicSparsityPattern *sparsity_pattern)
:
sparsity_pattern(sparsity_pattern),
current_row(numbers::invalid_size_type),
current_entry(),
end_of_row()
{}
inline
size_type
Accessor::row() const
{
Assert (current_row < sparsity_pattern->n_rows(),
ExcInternalError());
return current_row;
}
inline
size_type
Accessor::column() const
{
Assert (current_row < sparsity_pattern->n_rows(),
ExcInternalError());
return *current_entry;
}
inline
size_type
Accessor::index() const
{
Assert (current_row < sparsity_pattern->n_rows(),
ExcInternalError());
return (current_entry -
((sparsity_pattern->rowset.size()==0)
?
sparsity_pattern->lines[current_row].entries.begin()
:
sparsity_pattern->lines[sparsity_pattern->rowset.index_within_set(current_row)].entries.begin()));
}
inline
bool
Accessor::operator == (const Accessor &other) const
{
// compare the sparsity pattern the iterator points into, the
// current row, and the location within this row. ignore the
// latter if the row is past-the-end because in that case the
// current_entry field may not point to a deterministic location
return (sparsity_pattern == other.sparsity_pattern &&
current_row == other.current_row &&
((current_row == numbers::invalid_size_type)
|| (current_entry == other.current_entry)));
}
inline
bool
Accessor::operator < (const Accessor &other) const
{
Assert (sparsity_pattern == other.sparsity_pattern,
ExcInternalError());
// if *this is past-the-end, then it is less than no one
if (current_row == numbers::invalid_size_type)
return (false);
// now *this should be an valid value
Assert (current_row < sparsity_pattern->n_rows(),
ExcInternalError());
// if other is past-the-end
if (other.current_row == numbers::invalid_size_type)
return (true);
// now other should be an valid value
Assert (other.current_row < sparsity_pattern->n_rows(),
ExcInternalError());
// both iterators are not one-past-the-end
return ((current_row < other.current_row) ||
((current_row == other.current_row) &&
(current_entry < other.current_entry)));
}
inline
void
Accessor::advance ()
{
Assert (current_row < sparsity_pattern->n_rows(),
ExcInternalError());
// move to the next element in this row
++current_entry;
// if this moves us beyond the end of the row, go to the next row
// if possible, or set the iterator to an invalid state if not.
//
// going to the next row is a bit complicated because we may have
// to skip over empty rows, and because we also have to avoid rows
// that aren't listed in a possibly passed IndexSet argument of
// the sparsity pattern. consequently, rather than trying to
// duplicate code here, just call the begin() function of the
// sparsity pattern itself
if (current_entry == end_of_row)
{
if (current_row+1 < sparsity_pattern->n_rows())
*this = *sparsity_pattern->begin(current_row+1);
else
*this = Accessor(sparsity_pattern); // invalid object
}
}
inline
Iterator::Iterator (const DynamicSparsityPattern *sparsity_pattern,
const size_type row,
const unsigned int index_within_row)
:
accessor(sparsity_pattern, row, index_within_row)
{}
inline
Iterator::Iterator (const DynamicSparsityPattern *sparsity_pattern)
:
accessor(sparsity_pattern)
{}
inline
Iterator &
Iterator::operator++ ()
{
accessor.advance ();
return *this;
}
inline
Iterator
Iterator::operator++ (int)
{
const Iterator iter = *this;
accessor.advance ();
return iter;
}
inline
const Accessor &
Iterator::operator* () const
{
return accessor;
}
inline
const Accessor *
Iterator::operator-> () const
{
return &accessor;
}
inline
bool
Iterator::operator == (const Iterator &other) const
{
return (accessor == other.accessor);
}
inline
bool
Iterator::operator != (const Iterator &other) const
{
return ! (*this == other);
}
inline
bool
Iterator::operator < (const Iterator &other) const
{
return accessor < other.accessor;
}
inline
int
Iterator::operator - (const Iterator &other) const
{
(void)other;
Assert (accessor.sparsity_pattern == other.accessor.sparsity_pattern,
ExcInternalError());
Assert (false, ExcNotImplemented());
return 0;
}
}
inline
void
DynamicSparsityPattern::Line::add (const size_type j)
{
// first check the last element (or if line is still empty)
if ( (entries.size()==0) || ( entries.back() < j) )
{
entries.push_back(j);
return;
}
// do a binary search to find the place where to insert:
std::vector<size_type>::iterator
it = Utilities::lower_bound(entries.begin(),
entries.end(),
j);
// If this entry is a duplicate, exit immediately
if (*it == j)
return;
// Insert at the right place in the vector. Vector grows automatically to
// fit elements. Always doubles its size.
entries.insert(it, j);
}
inline
DynamicSparsityPattern::size_type
DynamicSparsityPattern::n_rows () const
{
return rows;
}
inline
types::global_dof_index
DynamicSparsityPattern::n_cols () const
{
return cols;
}
inline
void
DynamicSparsityPattern::add (const size_type i,
const size_type j)
{
Assert (i<rows, ExcIndexRangeType<size_type>(i, 0, rows));
Assert (j<cols, ExcIndexRangeType<size_type>(j, 0, cols));
if (rowset.size() > 0 && !rowset.is_element(i))
return;
const size_type rowindex =
rowset.size()==0 ? i : rowset.index_within_set(i);
lines[rowindex].add (j);
}
template <typename ForwardIterator>
inline
void
DynamicSparsityPattern::add_entries (const size_type row,
ForwardIterator begin,
ForwardIterator end,
const bool indices_are_sorted)
{
Assert (row < rows, ExcIndexRangeType<size_type> (row, 0, rows));
if (rowset.size() > 0 && !rowset.is_element(row))
return;
const size_type rowindex =
rowset.size()==0 ? row : rowset.index_within_set(row);
lines[rowindex].add_entries (begin, end, indices_are_sorted);
}
inline
DynamicSparsityPattern::Line::Line ()
{}
inline
types::global_dof_index
DynamicSparsityPattern::row_length (const size_type row) const
{
Assert (row < n_rows(), ExcIndexRangeType<size_type> (row, 0, n_rows()));
if (rowset.size() > 0 && !rowset.is_element(row))
return 0;
const size_type rowindex =
rowset.size()==0 ? row : rowset.index_within_set(row);
return lines[rowindex].entries.size();
}
inline
types::global_dof_index
DynamicSparsityPattern::column_number (const size_type row,
const size_type index) const
{
Assert (row < n_rows(), ExcIndexRangeType<size_type> (row, 0, n_rows()));
Assert( rowset.size() == 0 || rowset.is_element(row), ExcInternalError());
const size_type local_row = rowset.size() ? rowset.index_within_set(row) : row;
Assert (index < lines[local_row].entries.size(),
ExcIndexRangeType<size_type> (index, 0, lines[local_row].entries.size()));
return lines[local_row].entries[index];
}
inline
DynamicSparsityPattern::iterator
DynamicSparsityPattern::begin () const
{
return begin(0);
}
inline
DynamicSparsityPattern::iterator
DynamicSparsityPattern::end () const
{
return iterator(this);
}
inline
DynamicSparsityPattern::iterator
DynamicSparsityPattern::begin (const size_type r) const
{
Assert (r<n_rows(), ExcIndexRangeType<size_type>(r,0,n_rows()));
// find the first row starting at r that has entries and return the
// begin iterator to it. also skip rows for which we do not have
// store anything based on the IndexSet given to the sparsity
// pattern
//
// note: row_length(row) returns zero if the row is not locally stored
//
// TODO: this is way too slow when used in parallel, so do not use it on
// non-owned rows
size_type row = r;
while ((row<n_rows())
&&
(row_length(row)==0))
++row;
if (row == n_rows())
return iterator(this);
else
return iterator(this, row, 0);
}
inline
DynamicSparsityPattern::iterator
DynamicSparsityPattern::end (const size_type r) const
{
Assert (r<n_rows(), ExcIndexRangeType<size_type>(r,0,n_rows()));
// find the first row after r that has entries and return the begin
// iterator to it. also skip rows for which we do not have
// store anything based on the IndexSet given to the sparsity
// pattern
//
// note: row_length(row) returns zero if the row is not locally stored
unsigned int row = r+1;
while ((row<n_rows())
&&
(row_length(row)==0))
++row;
if (row == n_rows())
return iterator(this);
else
return iterator(this, row, 0);
}
inline
const IndexSet &
DynamicSparsityPattern::row_index_set () const
{
return rowset;
}
inline
bool
DynamicSparsityPattern::stores_only_added_elements ()
{
return true;
}
DEAL_II_NAMESPACE_CLOSE
#endif
|