4 #ifndef DUNE_ISTL_BCRSMATRIX_HH 5 #define DUNE_ISTL_BCRSMATRIX_HH 19 #include <dune/common/stdstreams.hh> 20 #include <dune/common/iteratorfacades.hh> 21 #include <dune/common/typetraits.hh> 22 #include <dune/common/ftraits.hh> 79 template<
typename size_type>
137 return _m.entry(_i,j);
166 if (m.buildMode() != Matrix::implicit)
167 DUNE_THROW(
BCRSMatrixError,
"You can only create an ImplicitBuilder for a matrix in implicit build mode");
168 if (m.buildStage() != Matrix::building)
169 DUNE_THROW(
BCRSMatrixError,
"You can only create an ImplicitBuilder for a matrix with set size that has not been compressed() yet");
187 ImplicitMatrixBuilder(Matrix& m, size_type rows, size_type cols, size_type avg_cols_per_row,
double overflow_fraction)
190 if (m.buildStage() != Matrix::notAllocated)
191 DUNE_THROW(
BCRSMatrixError,
"You can only set up a matrix for this ImplicitBuilder if it has no memory allocated yet");
192 m.setBuildMode(Matrix::implicit);
193 m.setImplicitBuildModeParameters(avg_cols_per_row,overflow_fraction);
194 m.setSize(rows,cols);
421 template<
class B,
class A=std::allocator<B> >
454 typedef Imp::CompressedBlockVectorWindow<B,A>
row_type;
465 blocklevel = B::blocklevel+1
508 row_type& operator[] (size_type i)
510 #ifdef DUNE_ISTL_WITH_CHECKING 511 if (build_mode == implicit && ready != built)
512 DUNE_THROW(
BCRSMatrixError,
"You cannot use operator[] in implicit build mode before calling compress()");
520 const row_type& operator[] (size_type i)
const 522 #ifdef DUNE_ISTL_WITH_CHECKING 523 if (build_mode == implicit && ready != built)
524 DUNE_THROW(
BCRSMatrixError,
"You cannot use operator[] in implicit build mode before calling compress()");
525 if (built!=ready) DUNE_THROW(
BCRSMatrixError,
"row not initialized yet");
537 :
public RandomAccessIteratorFacade<RealRowIterator<T>, T>
544 friend class RandomAccessIteratorFacade<
RealRowIterator<const ValueType>, const ValueType>;
609 void advance(std::ptrdiff_t diff)
614 T& elementAt(std::ptrdiff_t diff)
const 620 row_type& dereference ()
const 636 return Iterator(r,0);
642 return Iterator(r,n);
649 return Iterator(r,n-1);
656 return Iterator(r,-1);
673 return ConstIterator(r,0);
677 ConstIterator
end ()
const 679 return ConstIterator(r,n);
686 return ConstIterator(r,n-1);
693 return ConstIterator(r,-1);
709 : build_mode(unknown), ready(notAllocated), n(0), m(0), nnz_(0),
710 allocationSize_(0), r(0), a(0),
711 avg(0), overflowsize(-1.0)
716 : build_mode(bm), ready(notAllocated), n(0), m(0), nnz_(0),
717 allocationSize_(0), r(0), a(0),
718 avg(0), overflowsize(-1.0)
720 allocate(_n, _m, _nnz,
true,
false);
725 : build_mode(bm), ready(notAllocated), n(0), m(0), nnz_(0),
726 allocationSize_(0), r(0), a(0),
727 avg(0), overflowsize(-1.0)
729 allocate(_n, _m,0,
true,
false);
744 : build_mode(bm), ready(notAllocated), n(0), m(0), nnz_(0),
745 allocationSize_(0), r(0), a(0),
746 avg(_avg), overflowsize(_overflowsize)
749 DUNE_THROW(
BCRSMatrixError,
"Only call this constructor when using the implicit build mode");
754 if (_overflowsize < 0.0)
755 DUNE_THROW(
BCRSMatrixError,
"You cannot set a negative overflow fraction");
756 implicit_allocate(_n,_m);
765 : build_mode(Mat.build_mode), ready(notAllocated), n(0), m(0), nnz_(0),
766 allocationSize_(0), r(0), a(0),
767 avg(Mat.
avg), overflowsize(Mat.overflowsize)
769 if (!(Mat.
ready == notAllocated || Mat.
ready == built))
770 DUNE_THROW(InvalidStateException,
"BCRSMatrix can only be copy-constructed when source matrix is completely empty (size not set) or fully built)");
776 allocate(Mat.
n, Mat.
m, _nnz,
true,
true);
779 copyWindowStructure(Mat);
794 if (ready == notAllocated)
799 if (ready == building && (build_mode == unknown || build_mode == random || build_mode == row_wise) && (bm == row_wise || bm == random))
802 DUNE_THROW(InvalidStateException,
"Matrix structure cannot be changed at this stage anymore (ready == "<<ready<<
").");
820 void setSize(size_type rows, size_type columns, size_type nnz=0)
825 if (build_mode == implicit)
828 DUNE_THROW(
Dune::BCRSMatrixError,
"number of non-zeroes may not be set in implicit mode, use setImplicitBuildModeParameters() instead");
831 implicit_allocate(rows,columns);
836 allocate(rows, columns, nnz,
true,
false);
855 DUNE_THROW(
BCRSMatrixError,
"You cannot set a negative overflow fraction");
858 if (ready != notAllocated)
859 DUNE_THROW(InvalidStateException,
"You cannot modify build mode parameters at this stage anymore");
861 overflowsize = _overflow;
873 if (&Mat==
this)
return *
this;
875 if (!((ready == notAllocated || ready == built) && (Mat.
ready == notAllocated || Mat.
ready == built)))
876 DUNE_THROW(InvalidStateException,
"BCRSMatrix can only be copied when both target and source are empty or fully built)");
880 deallocate(n!=Mat.
n);
883 if (n>0 && n!=Mat.
n) {
885 for(row_type *riter=r+(n-1), *rend=r-1; riter!=rend; --riter)
886 rowAllocator_.destroy(riter);
887 rowAllocator_.deallocate(r,n);
894 allocate(Mat.
n, Mat.
m, nnz_, n!=Mat.
n,
true);
897 copyWindowStructure(Mat);
905 if (!(ready == notAllocated || ready == built))
906 DUNE_THROW(InvalidStateException,
"Scalar assignment only works on fully built BCRSMatrix)");
908 for (size_type i=0; i<n; i++) r[i] = k;
920 : Mat(_Mat), i(_i), nnz(0), current_row(nullptr, Mat.j_.
get(), 0)
922 if (Mat.build_mode == unknown && Mat.ready == building)
924 Mat.build_mode = row_wise;
926 if (i==0 && Mat.ready != building)
927 DUNE_THROW(
BCRSMatrixError,
"creation only allowed for uninitialized matrix");
928 if(Mat.build_mode!=row_wise)
929 DUNE_THROW(
BCRSMatrixError,
"creation only allowed if row wise allocation was requested in the constructor");
930 if(i==0 && _Mat.
N()==0)
939 if (Mat.ready != building)
963 Mat.r[i].set(s,
nullptr,current_row.getindexptr());
964 current_row.setindexptr(current_row.getindexptr()+s);
968 B* b = Mat.allocator_.allocate(s);
972 size_type* j = Mat.sizeAllocator_.allocate(s);
977 Mat.r[i].set(0,
nullptr,
nullptr);
980 std::copy(
pattern.cbegin(),
pattern.cend(), Mat.r[i].getindexptr());
997 Mat.setDataPointers();
1007 return (i!=it.i) || (&Mat!=&it.Mat);
1013 return (i==it.i) && (&Mat==&it.Mat);
1047 typedef std::set<size_type,std::less<size_type> > PatternType;
1049 row_type current_row;
1078 if (build_mode!=random)
1080 if (ready != building)
1089 #ifdef DUNE_ISTL_WITH_CHECKING 1093 return r[i].getsize();
1099 if (build_mode!=random)
1101 if (ready != building)
1104 r[i].setsize(r[i].getsize()+s);
1110 if (build_mode!=random)
1112 if (ready != building)
1117 for (size_type i=0; i<n; i++)
1119 total += r[i].getsize();
1124 allocate(n,m,total,
false,
false);
1125 else if(nnz_ < total)
1126 DUNE_THROW(
BCRSMatrixError,
"Specified number of nonzeros ("<<nnz_<<
") not " 1127 <<
"sufficient for calculated nonzeros ("<<total<<
"! ");
1130 setColumnPointers(begin());
1134 for (size_type k=0; k<nnz_; k++)
1136 ready = rowSizesBuilt;
1152 if (build_mode!=random)
1156 if (ready==building)
1158 if (ready==notAllocated)
1159 DUNE_THROW(
BCRSMatrixError,
"matrix size not set and no memory allocated yet");
1165 size_type*
const first = r[row].getindexptr();
1166 size_type*
const last = first + r[row].getsize();
1169 size_type* pos = std::lower_bound(first,last,col);
1172 if (pos!=last && *pos == col)
return;
1175 size_type* end = std::lower_bound(pos,last,m);
1180 std::copy_backward(pos,end,end+1);
1192 template<
typename It>
1195 size_type row_size = r[row].size();
1196 size_type* col_begin = r[row].getindexptr();
1199 if ((col_end = std::copy(begin,end,r[row].getindexptr())) != col_begin + row_size)
1202 <<
") does not match number of passed entries (" << (col_end - col_begin) <<
")");
1203 std::sort(col_begin,col_end);
1209 if (build_mode!=random)
1213 if (ready==building)
1215 if (ready==notAllocated)
1216 DUNE_THROW(
BCRSMatrixError,
"matrix size not set and no memory allocated yet");
1219 RowIterator endi=end();
1220 for (RowIterator i=begin(); i!=endi; ++i)
1222 ColIterator endj = (*i).end();
1223 for (ColIterator j=(*i).begin(); j!=endj; ++j) {
1224 if (j.index() >= m) {
1225 dwarn <<
"WARNING: size of row "<< i.index()<<
" is "<<j.offset()<<
". But was specified as being "<< (*i).end().offset()
1226 <<
". This means you are wasting valuable space and creating additional cache misses!"<<std::endl;
1227 nnz_ -= ((*i).end().offset() - j.offset());
1228 r[i.index()].setsize(j.offset());
1257 #ifdef DUNE_ISTL_WITH_CHECKING 1258 if (build_mode!=implicit)
1261 DUNE_THROW(
BCRSMatrixError,
"matrix already built up, use operator[] for entry access now");
1262 if (ready==notAllocated)
1263 DUNE_THROW(
BCRSMatrixError,
"matrix size not set and no memory allocated yet");
1264 if (ready!=building)
1265 DUNE_THROW(InvalidStateException,
"You may only use entry() during the 'building' stage");
1273 size_type* begin = r[row].getindexptr();
1274 size_type* end = begin + r[row].getsize();
1276 size_type* pos = std::find(begin, end, col);
1282 std::ptrdiff_t offset = pos - r[row].getindexptr();
1283 B* aptr = r[row].getptr() + offset;
1289 if (r[row].getsize() ==
avg)
1290 return overflow[std::make_pair(row,col)];
1297 std::ptrdiff_t offset = end - r[row].getindexptr();
1298 B* apos = r[row].getptr() + offset;
1301 r[row].setsize(r[row].getsize()+1);
1321 if (build_mode!=implicit)
1324 DUNE_THROW(
BCRSMatrixError,
"matrix already built up, no more need for compression");
1325 if (ready==notAllocated)
1326 DUNE_THROW(
BCRSMatrixError,
"matrix size not set and no memory allocated yet");
1327 if (ready!=building)
1328 DUNE_THROW(InvalidStateException,
"You may only call compress() at the end of the 'building' stage");
1331 CompressionStatistics stats;
1336 size_type* jiit = j_.get();
1340 typename OverflowType::iterator oit = overflow.begin();
1343 std::vector<size_type*> perm;
1346 for (size_type i=0; i<n; i++)
1349 size_type* begin = r[i].getindexptr();
1351 size_type size = r[i].getsize();
1355 typename std::vector<size_type*>::iterator it = perm.begin();
1356 for (size_type* iit = begin; iit < begin + size; ++iit, ++it)
1363 r[i].setindexptr(jiit);
1366 for (it = perm.begin(); it != perm.end(); ++it)
1369 while ((oit!=overflow.end()) && (oit->first < std::make_pair(i,**it)))
1374 "Allocated memory for BCRSMatrix exhausted during compress()!" 1375 "Please increase either the average number of entries per row or the overflow fraction." 1378 *jiit = oit->first.second;
1380 *aiit = oit->second;
1383 r[i].setsize(r[i].getsize()+1);
1389 "Allocated memory for BCRSMatrix exhausted during compress()!" 1390 "Please increase either the average number of entries per row or the overflow fraction." 1396 B* apos = *it - j_.get() + a;
1402 while ((oit!=overflow.end()) && (oit->first.first == i))
1407 "Allocated memory for BCRSMatrix exhausted during compress()!" 1408 "Please increase either the average number of entries per row or the overflow fraction." 1412 *jiit = oit->first.second;
1414 *aiit = oit->second;
1417 r[i].setsize(r[i].getsize()+1);
1421 if (r[i].getsize()>stats.
maximum)
1422 stats.
maximum = r[i].getsize();
1429 std::ptrdiff_t diff = (r[n-1].getindexptr() + r[n-1].getsize() - j_.get());
1431 stats.
avg = (double) (nnz_) / (double) n;
1432 stats.
mem_ratio = (double) (nnz_) / (double) allocationSize_;
1445 #ifdef DUNE_ISTL_WITH_CHECKING 1447 DUNE_THROW(
BCRSMatrixError,
"You can only call arithmetic operations on fully built BCRSMatrix instances");
1453 for (size_type i=0; i<nnz_; i++)
1458 RowIterator endi=end();
1459 for (RowIterator i=begin(); i!=endi; ++i)
1461 ColIterator endj = (*i).end();
1462 for (ColIterator j=(*i).begin(); j!=endj; ++j)
1473 #ifdef DUNE_ISTL_WITH_CHECKING 1475 DUNE_THROW(
BCRSMatrixError,
"You can only call arithmetic operations on fully built BCRSMatrix instances");
1481 for (size_type i=0; i<nnz_; i++)
1486 RowIterator endi=end();
1487 for (RowIterator i=begin(); i!=endi; ++i)
1489 ColIterator endj = (*i).end();
1490 for (ColIterator j=(*i).begin(); j!=endj; ++j)
1506 #ifdef DUNE_ISTL_WITH_CHECKING 1507 if (ready != built || b.
ready != built)
1508 DUNE_THROW(
BCRSMatrixError,
"You can only call arithmetic operations on fully built BCRSMatrix instances");
1509 if(N()!=b.
N() || M() != b.
M())
1510 DUNE_THROW(RangeError,
"Matrix sizes do not match!");
1512 RowIterator endi=end();
1513 ConstRowIterator j=b.
begin();
1514 for (RowIterator i=begin(); i!=endi; ++i, ++j) {
1528 #ifdef DUNE_ISTL_WITH_CHECKING 1529 if (ready != built || b.
ready != built)
1530 DUNE_THROW(
BCRSMatrixError,
"You can only call arithmetic operations on fully built BCRSMatrix instances");
1531 if(N()!=b.
N() || M() != b.
M())
1532 DUNE_THROW(RangeError,
"Matrix sizes do not match!");
1534 RowIterator endi=end();
1535 ConstRowIterator j=b.
begin();
1536 for (RowIterator i=begin(); i!=endi; ++i, ++j) {
1553 #ifdef DUNE_ISTL_WITH_CHECKING 1554 if (ready != built || b.
ready != built)
1555 DUNE_THROW(
BCRSMatrixError,
"You can only call arithmetic operations on fully built BCRSMatrix instances");
1556 if(N()!=b.
N() || M() != b.
M())
1557 DUNE_THROW(RangeError,
"Matrix sizes do not match!");
1559 RowIterator endi=end();
1560 ConstRowIterator j=b.
begin();
1561 for(RowIterator i=begin(); i!=endi; ++i, ++j)
1570 template<
class X,
class Y>
1571 void mv (
const X& x, Y& y)
const 1573 #ifdef DUNE_ISTL_WITH_CHECKING 1575 DUNE_THROW(
BCRSMatrixError,
"You can only call arithmetic operations on fully built BCRSMatrix instances");
1577 "Size mismatch: M: " << N() <<
"x" << M() <<
" x: " << x.N());
1579 "Size mismatch: M: " << N() <<
"x" << M() <<
" y: " << y.N());
1581 ConstRowIterator endi=end();
1582 for (ConstRowIterator i=begin(); i!=endi; ++i)
1585 ConstColIterator endj = (*i).end();
1586 for (ConstColIterator j=(*i).begin(); j!=endj; ++j)
1587 (*j).umv(x[j.index()],y[i.index()]);
1592 template<
class X,
class Y>
1593 void umv (
const X& x, Y& y)
const 1595 #ifdef DUNE_ISTL_WITH_CHECKING 1597 DUNE_THROW(
BCRSMatrixError,
"You can only call arithmetic operations on fully built BCRSMatrix instances");
1601 ConstRowIterator endi=end();
1602 for (ConstRowIterator i=begin(); i!=endi; ++i)
1604 ConstColIterator endj = (*i).end();
1605 for (ConstColIterator j=(*i).begin(); j!=endj; ++j)
1606 (*j).umv(x[j.index()],y[i.index()]);
1611 template<
class X,
class Y>
1612 void mmv (
const X& x, Y& y)
const 1614 #ifdef DUNE_ISTL_WITH_CHECKING 1616 DUNE_THROW(
BCRSMatrixError,
"You can only call arithmetic operations on fully built BCRSMatrix instances");
1620 ConstRowIterator endi=end();
1621 for (ConstRowIterator i=begin(); i!=endi; ++i)
1623 ConstColIterator endj = (*i).end();
1624 for (ConstColIterator j=(*i).begin(); j!=endj; ++j)
1625 (*j).mmv(x[j.index()],y[i.index()]);
1630 template<
class X,
class Y,
class F>
1631 void usmv (F&& alpha,
const X& x, Y& y)
const 1633 #ifdef DUNE_ISTL_WITH_CHECKING 1635 DUNE_THROW(
BCRSMatrixError,
"You can only call arithmetic operations on fully built BCRSMatrix instances");
1639 ConstRowIterator endi=end();
1640 for (ConstRowIterator i=begin(); i!=endi; ++i)
1642 ConstColIterator endj = (*i).end();
1643 for (ConstColIterator j=(*i).begin(); j!=endj; ++j)
1644 (*j).usmv(alpha,x[j.index()],y[i.index()]);
1649 template<
class X,
class Y>
1650 void mtv (
const X& x, Y& y)
const 1652 #ifdef DUNE_ISTL_WITH_CHECKING 1654 DUNE_THROW(
BCRSMatrixError,
"You can only call arithmetic operations on fully built BCRSMatrix instances");
1658 for(size_type i=0; i<y.N(); ++i)
1664 template<
class X,
class Y>
1667 #ifdef DUNE_ISTL_WITH_CHECKING 1669 DUNE_THROW(
BCRSMatrixError,
"You can only call arithmetic operations on fully built BCRSMatrix instances");
1673 ConstRowIterator endi=end();
1674 for (ConstRowIterator i=begin(); i!=endi; ++i)
1676 ConstColIterator endj = (*i).end();
1677 for (ConstColIterator j=(*i).begin(); j!=endj; ++j)
1678 (*j).umtv(x[i.index()],y[j.index()]);
1683 template<
class X,
class Y>
1686 #ifdef DUNE_ISTL_WITH_CHECKING 1690 ConstRowIterator endi=end();
1691 for (ConstRowIterator i=begin(); i!=endi; ++i)
1693 ConstColIterator endj = (*i).end();
1694 for (ConstColIterator j=(*i).begin(); j!=endj; ++j)
1695 (*j).mmtv(x[i.index()],y[j.index()]);
1700 template<
class X,
class Y>
1701 void usmtv (
const field_type& alpha,
const X& x, Y& y)
const 1703 #ifdef DUNE_ISTL_WITH_CHECKING 1705 DUNE_THROW(
BCRSMatrixError,
"You can only call arithmetic operations on fully built BCRSMatrix instances");
1709 ConstRowIterator endi=end();
1710 for (ConstRowIterator i=begin(); i!=endi; ++i)
1712 ConstColIterator endj = (*i).end();
1713 for (ConstColIterator j=(*i).begin(); j!=endj; ++j)
1714 (*j).usmtv(alpha,x[i.index()],y[j.index()]);
1719 template<
class X,
class Y>
1722 #ifdef DUNE_ISTL_WITH_CHECKING 1724 DUNE_THROW(
BCRSMatrixError,
"You can only call arithmetic operations on fully built BCRSMatrix instances");
1728 ConstRowIterator endi=end();
1729 for (ConstRowIterator i=begin(); i!=endi; ++i)
1731 ConstColIterator endj = (*i).end();
1732 for (ConstColIterator j=(*i).begin(); j!=endj; ++j)
1733 (*j).umhv(x[i.index()],y[j.index()]);
1738 template<
class X,
class Y>
1741 #ifdef DUNE_ISTL_WITH_CHECKING 1743 DUNE_THROW(
BCRSMatrixError,
"You can only call arithmetic operations on fully built BCRSMatrix instances");
1747 ConstRowIterator endi=end();
1748 for (ConstRowIterator i=begin(); i!=endi; ++i)
1750 ConstColIterator endj = (*i).end();
1751 for (ConstColIterator j=(*i).begin(); j!=endj; ++j)
1752 (*j).mmhv(x[i.index()],y[j.index()]);
1757 template<
class X,
class Y>
1758 void usmhv (
const field_type& alpha,
const X& x, Y& y)
const 1760 #ifdef DUNE_ISTL_WITH_CHECKING 1762 DUNE_THROW(
BCRSMatrixError,
"You can only call arithmetic operations on fully built BCRSMatrix instances");
1766 ConstRowIterator endi=end();
1767 for (ConstRowIterator i=begin(); i!=endi; ++i)
1769 ConstColIterator endj = (*i).end();
1770 for (ConstColIterator j=(*i).begin(); j!=endj; ++j)
1771 (*j).usmhv(alpha,x[i.index()],y[j.index()]);
1781 #ifdef DUNE_ISTL_WITH_CHECKING 1783 DUNE_THROW(
BCRSMatrixError,
"You can only call arithmetic operations on fully built BCRSMatrix instances");
1788 ConstRowIterator endi=end();
1789 for (ConstRowIterator i=begin(); i!=endi; ++i)
1791 ConstColIterator endj = (*i).end();
1792 for (ConstColIterator j=(*i).begin(); j!=endj; ++j)
1793 sum += (*j).frobenius_norm2();
1802 return sqrt(frobenius_norm2());
1806 template <
typename ft = field_type,
1807 typename std::enable_if<!has_nan<ft>::value,
int>::type = 0>
1810 DUNE_THROW(
BCRSMatrixError,
"You can only call arithmetic operations on fully built BCRSMatrix instances");
1812 using real_type =
typename FieldTraits<ft>::real_type;
1816 for (
auto const &x : *
this) {
1818 for (
auto const &y : x)
1819 sum += y.infinity_norm();
1820 norm = max(sum, norm);
1826 template <
typename ft = field_type,
1827 typename std::enable_if<!has_nan<ft>::value,
int>::type = 0>
1830 DUNE_THROW(
BCRSMatrixError,
"You can only call arithmetic operations on fully built BCRSMatrix instances");
1832 using real_type =
typename FieldTraits<ft>::real_type;
1836 for (
auto const &x : *
this) {
1838 for (
auto const &y : x)
1839 sum += y.infinity_norm_real();
1840 norm = max(sum, norm);
1846 template <
typename ft = field_type,
1847 typename std::enable_if<has_nan<ft>::value,
int>::type = 0>
1850 DUNE_THROW(
BCRSMatrixError,
"You can only call arithmetic operations on fully built BCRSMatrix instances");
1852 using real_type =
typename FieldTraits<ft>::real_type;
1856 real_type isNaN = 1;
1857 for (
auto const &x : *
this) {
1859 for (
auto const &y : x)
1860 sum += y.infinity_norm();
1861 norm = max(sum, norm);
1865 return norm * isNaN;
1869 template <
typename ft = field_type,
1870 typename std::enable_if<has_nan<ft>::value,
int>::type = 0>
1873 DUNE_THROW(
BCRSMatrixError,
"You can only call arithmetic operations on fully built BCRSMatrix instances");
1875 using real_type =
typename FieldTraits<ft>::real_type;
1879 real_type isNaN = 1;
1880 for (
auto const &x : *
this) {
1882 for (
auto const &y : x)
1883 sum += y.infinity_norm_real();
1884 norm = max(sum, norm);
1888 return norm * isNaN;
1894 size_type
N ()
const 1900 size_type
M ()
const 1910 nnz_ = std::accumulate( begin(), end(), size_type( 0 ), [] ( size_type s,
const row_type &row ) {
return s+row.getsize(); } );
1931 #ifdef DUNE_ISTL_WITH_CHECKING 1932 if (i<0 || i>=n) DUNE_THROW(
BCRSMatrixError,
"row index out of range");
1933 if (j<0 || j>=m) DUNE_THROW(
BCRSMatrixError,
"column index out of range");
1935 return (r[i].size() && r[i].find(j) != r[i].end());
1965 std::shared_ptr<size_type>
j_;
1976 row_type current_row(a,j_.get(),0);
1977 for (size_type i=0; i<n; i++, ++row) {
1979 size_type s = row->getsize();
1983 r[i].set(s,current_row.getptr(), current_row.getindexptr());
1985 current_row.setptr(current_row.getptr()+s);
1986 current_row.setindexptr(current_row.getindexptr()+s);
1989 r[i].set(0,
nullptr,
nullptr);
2001 size_type* jptr = j_.get();
2002 for (size_type i=0; i<n; ++i, ++row) {
2004 size_type s = row->getsize();
2009 r[i].setindexptr(jptr);
2012 r[i].set(0,
nullptr,
nullptr);
2028 for (size_type i=0; i<n; ++i) {
2030 if (r[i].getsize() > 0) {
2035 r[i].set(0,
nullptr,
nullptr);
2039 aptr += r[i].getsize();
2046 setWindowPointers(Mat.
begin());
2049 for (size_type i=0; i<n; i++) r[i] = Mat.
r[i];
2052 build_mode = row_wise;
2067 if (allocationSize_>0)
2073 for(B *aiter=a+(allocationSize_-1), *aend=a-1; aiter!=aend; --aiter)
2074 allocator_.destroy(aiter);
2075 allocator_.deallocate(a,allocationSize_);
2082 for (size_type i=0; i<n; i++)
2083 if (r[i].getsize()>0)
2085 for (B *
col=r[i].getptr()+(r[i].getsize()-1),
2086 *colend = r[i].getptr()-1;
col!=colend; --
col) {
2087 allocator_.destroy(
col);
2089 sizeAllocator_.deallocate(r[i].getindexptr(),1);
2090 allocator_.deallocate(r[i].getptr(),1);
2093 r[i].set(0,
nullptr,
nullptr);
2098 if (n>0 && deallocateRows && r) {
2099 for(row_type *riter=r+(n-1), *rend=r-1; riter!=rend; --riter)
2100 rowAllocator_.destroy(riter);
2101 rowAllocator_.deallocate(r,n);
2113 typename A::template rebind<size_type>::other& sizeAllocator_;
2116 Deallocator(
typename A::template rebind<size_type>::other& sizeAllocator)
2117 : sizeAllocator_(sizeAllocator)
2120 void operator()(size_type* p) { sizeAllocator_.deallocate(p,1); }
2141 void allocate(size_type rows, size_type columns, size_type allocationSize,
bool allocateRows,
bool allocate_data)
2146 nnz_ = allocationSize;
2147 allocationSize_ = allocationSize;
2153 DUNE_THROW(InvalidStateException,
"Rows have already been allocated, cannot allocate a second time");
2154 r = rowAllocator_.allocate(rows);
2156 for(row_type* ri=r; ri!=r+rows; ++ri)
2157 rowAllocator_.construct(ri, row_type());
2166 if (allocationSize_>0) {
2169 j_.reset(sizeAllocator_.allocate(allocationSize_),
Deallocator(sizeAllocator_));
2181 DUNE_THROW(InvalidStateException,
"Cannot allocate data array (already allocated)");
2182 if (allocationSize_>0) {
2183 a = allocator_.allocate(allocationSize_);
2186 new (a) B[allocationSize_];
2199 if (build_mode != implicit)
2200 DUNE_THROW(InvalidStateException,
"implicit_allocate() may only be called in implicit build mode");
2201 if (ready != notAllocated)
2202 DUNE_THROW(InvalidStateException,
"memory has already been allocated");
2205 if (overflowsize < 0)
2206 DUNE_THROW(InvalidStateException,
"You have to set the implicit build mode parameters before starting to build the matrix");
2208 size_type osize = (size_type) (_n*avg)*overflowsize + 4*
avg;
2209 allocationSize_ = _n*avg + osize;
2211 allocate(_n, _m, allocationSize_,
true,
true);
2214 size_type* jptr = j_.get() + osize;
2215 B* aptr = a + osize;
2216 for (size_type i=0; i<n; i++)
2218 r[i].set(0,aptr,jptr);
Matrix::block_type block_type
The block_type of the underlying matrix.
Definition: bcrsmatrix.hh:118
A allocator_type
export the allocator type
Definition: bcrsmatrix.hh:451
T block_type
Export the type representing the components.
Definition: matrix.hh:562
BuildMode build_mode
Definition: bcrsmatrix.hh:1941
std::map< std::pair< size_type, size_type >, B > OverflowType
Definition: bcrsmatrix.hh:1971
BCRSMatrix & axpy(field_type alpha, const BCRSMatrix &b)
Add the scaled entries of another matrix to this one.
Definition: bcrsmatrix.hh:1551
void setSize(size_type rows, size_type columns, size_type nnz=0)
Set the size of the matrix.
Definition: bcrsmatrix.hh:820
void setIndices(size_type row, It begin, It end)
Set all column indices for row from the given iterator range.
Definition: bcrsmatrix.hh:1193
M_ Matrix
The underlying matrix.
Definition: bcrsmatrix.hh:115
Definition: allocator.hh:7
ImplicitMatrixBuilder(Matrix &m)
Creates an ImplicitMatrixBuilder for matrix m.
Definition: bcrsmatrix.hh:163
RealRowIterator()
empty constructor, use with care!
Definition: bcrsmatrix.hh:555
BCRSMatrix(const BCRSMatrix &Mat)
copy constructor
Definition: bcrsmatrix.hh:764
A sparse block matrix with compressed row storage.
Definition: bcrsmatrix.hh:422
Iterator beforeEnd()
Definition: bcrsmatrix.hh:647
void umv(const X &x, Y &y) const
y += A x
Definition: bcrsmatrix.hh:1593
BCRSMatrix(size_type _n, size_type _m, size_type _avg, double _overflowsize, BuildMode bm)
construct matrix with a known average number of entries per row
Definition: bcrsmatrix.hh:743
Statistics about compression achieved in implicit mode.
Definition: bcrsmatrix.hh:80
std::shared_ptr< size_type > j_
Definition: bcrsmatrix.hh:1965
void setDataPointers()
Set data pointers for all rows.
Definition: bcrsmatrix.hh:2025
RealRowIterator(const RealRowIterator< ValueType > &it)
Definition: bcrsmatrix.hh:559
size_type N() const
The number of rows in the matrix.
Definition: bcrsmatrix.hh:204
This file implements a vector space as a tensor product of a given vector space. The number of compon...
row_object operator[](size_type i) const
Returns a proxy for entries in row i.
Definition: bcrsmatrix.hh:198
bool exists(size_type i, size_type j) const
return true if (i,j) is in pattern
Definition: bcrsmatrix.hh:1929
A::template rebind< size_type >::other sizeAllocator_
Definition: bcrsmatrix.hh:1949
void mmtv(const X &x, Y &y) const
y -= A^T x
Definition: bcrsmatrix.hh:1684
RealRowIterator< row_type > Iterator
Definition: bcrsmatrix.hh:631
void implicit_allocate(size_type _n, size_type _m)
organizes allocation implicit mode calculates correct array size to be allocated and sets the the win...
Definition: bcrsmatrix.hh:2197
Iterator class for sequential creation of blocks
Definition: bcrsmatrix.hh:915
size_type index() const
return index
Definition: bcrsmatrix.hh:565
CreateIterator createbegin()
get initial create iterator
Definition: bcrsmatrix.hh:1056
A::template rebind< row_type >::other rowAllocator_
Definition: bcrsmatrix.hh:1947
RealRowIterator(row_type *_p, size_type _i)
constructor
Definition: bcrsmatrix.hh:550
size_type N() const
number of rows (counted in blocks)
Definition: bcrsmatrix.hh:1894
Error specific to BCRSMatrix.
Definition: istlexception.hh:19
row_type * r
Definition: bcrsmatrix.hh:1959
CreateIterator & operator++()
prefix increment
Definition: bcrsmatrix.hh:936
std::ptrdiff_t distanceTo(const RealRowIterator< const ValueType > &other) const
Definition: bcrsmatrix.hh:576
size_type M() const
number of columns (counted in blocks)
Definition: bcrsmatrix.hh:1900
double overflowsize
Definition: bcrsmatrix.hh:1969
RealRowIterator< const row_type > const_iterator
The const iterator over the matrix rows.
Definition: bcrsmatrix.hh:666
void umtv(const X &x, Y &y) const
y += A^T x
Definition: bcrsmatrix.hh:1665
ConstIterator ConstRowIterator
rename the const row iterator for easier access
Definition: bcrsmatrix.hh:697
ConstIterator beforeEnd() const
Definition: bcrsmatrix.hh:684
A::template rebind< B >::other allocator_
Definition: bcrsmatrix.hh:1945
size_type size() const
Get the current row size.
Definition: bcrsmatrix.hh:1038
void setColumnPointers(ConstRowIterator row)
Copy row sizes from iterator range starting at row and set column index pointers for all rows...
Definition: bcrsmatrix.hh:1999
void deallocate(bool deallocateRows=true)
deallocate memory of the matrix.
Definition: bcrsmatrix.hh:2061
row_type::Iterator ColIterator
Iterator for the entries of each row.
Definition: bcrsmatrix.hh:663
block_type & operator[](size_type j) const
Returns entry in column j.
Definition: bcrsmatrix.hh:135
FieldTraits< field_type >::real_type frobenius_norm2() const
square of frobenius norm, need for block recursion
Definition: bcrsmatrix.hh:1779
void incrementrowsize(size_type i, size_type s=1)
increment size of row i by s (1 by default)
Definition: bcrsmatrix.hh:1097
CreateIterator(BCRSMatrix &_Mat, size_type _i)
constructor
Definition: bcrsmatrix.hh:919
Deallocator(typename A::template rebind< size_type >::other &sizeAllocator)
Definition: bcrsmatrix.hh:2116
RealRowIterator< const row_type > ConstIterator
Definition: bcrsmatrix.hh:667
size_type nnz_
Definition: bcrsmatrix.hh:1954
row_type::ConstIterator ConstColIterator
Const iterator to the entries of a row.
Definition: bcrsmatrix.hh:700
Build entries randomly with an educated guess for the number of entries per row.
Definition: bcrsmatrix.hh:498
void addindex(size_type row, size_type col)
add index (row,col) to the matrix
Definition: bcrsmatrix.hh:1150
Proxy row object for entry access.
Definition: bcrsmatrix.hh:129
Imp::CompressedBlockVectorWindow< B, A > row_type
implement row_type with compressed vector
Definition: bcrsmatrix.hh:454
A::size_type size_type
Type for indices and sizes.
Definition: matrix.hh:571
CompressionStatistics compress()
Finishes the buildstage in implicit mode.
Definition: bcrsmatrix.hh:1319
size_type getrowsize(size_type i) const
get current number of indices in row i
Definition: bcrsmatrix.hh:1087
Definition: bcrsmatrix.hh:70
void allocateData()
Definition: bcrsmatrix.hh:2178
bool equals(const RealRowIterator< const ValueType > &other) const
equality
Definition: bcrsmatrix.hh:590
void mmhv(const X &x, Y &y) const
y -= A^H x
Definition: bcrsmatrix.hh:1739
BuildMode
we support two modes
Definition: bcrsmatrix.hh:469
BuildMode buildMode() const
The currently selected build mode of the matrix.
Definition: bcrsmatrix.hh:1921
ConstIterator begin() const
Get const iterator to first row.
Definition: bcrsmatrix.hh:671
double avg
average number of non-zeroes per row.
Definition: bcrsmatrix.hh:83
OverflowType overflow
Definition: bcrsmatrix.hh:1972
::Dune::CompressionStatistics< size_type > CompressionStatistics
The type for the statistics object returned by compress()
Definition: bcrsmatrix.hh:460
void allocate(size_type rows, size_type columns, size_type allocationSize, bool allocateRows, bool allocate_data)
Allocate memory for the matrix structure.
Definition: bcrsmatrix.hh:2141
BCRSMatrix(size_type _n, size_type _m, size_type _nnz, BuildMode bm)
matrix with known number of nonzeroes
Definition: bcrsmatrix.hh:715
void setImplicitBuildModeParameters(size_type _avg, double _overflow)
Set parameters needed for creation in implicit build mode.
Definition: bcrsmatrix.hh:848
Iterator access to matrix rows
Definition: bcrsmatrix.hh:536
void mv(const X &x, Y &y) const
y = A x
Definition: bcrsmatrix.hh:1571
size_type overflow_total
total number of elements written to the overflow area during construction.
Definition: bcrsmatrix.hh:87
A wrapper for uniform access to the BCRSMatrix during and after the build stage in implicit build mod...
Definition: bcrsmatrix.hh:109
Definition: matrixutils.hh:511
double mem_ratio
fraction of wasted memory resulting from non-used overflow area.
Definition: bcrsmatrix.hh:92
size_type M() const
The number of columns in the matrix.
Definition: bcrsmatrix.hh:210
ConstIterator beforeBegin() const
Definition: bcrsmatrix.hh:691
size_type maximum
maximum number of non-zeroes per row.
Definition: bcrsmatrix.hh:85
BCRSMatrix(size_type _n, size_type _m, BuildMode bm)
matrix with unknown number of nonzeroes
Definition: bcrsmatrix.hh:724
Definition: matrixmarket.hh:258
void setrowsize(size_type i, size_type s)
Set number of indices in row i to s.
Definition: bcrsmatrix.hh:1076
void mtv(const X &x, Y &y) const
y = A^T x
Definition: bcrsmatrix.hh:1650
~BCRSMatrix()
destructor
Definition: bcrsmatrix.hh:783
size_type m
Definition: bcrsmatrix.hh:1953
Build in a row-wise manner.
Definition: bcrsmatrix.hh:480
void umhv(const X &x, Y &y) const
y += A^H x
Definition: bcrsmatrix.hh:1720
FieldTraits< field_type >::real_type frobenius_norm() const
frobenius norm: sqrt(sum over squared values of entries)
Definition: bcrsmatrix.hh:1800
std::ptrdiff_t distanceTo(const RealRowIterator< ValueType > &other) const
Definition: bcrsmatrix.hh:570
bool contains(size_type j)
return true if column index is in row
Definition: bcrsmatrix.hh:1029
A::size_type size_type
The type for the index access and the size.
Definition: bcrsmatrix.hh:457
Class used by shared_ptr to deallocate memory using the proper allocator.
Definition: bcrsmatrix.hh:2111
Iterator begin()
Get iterator to first row.
Definition: bcrsmatrix.hh:634
BCRSMatrix()
an empty matrix
Definition: bcrsmatrix.hh:708
size_type allocationSize_
Definition: bcrsmatrix.hh:1955
B::field_type field_type
export the type representing the field
Definition: bcrsmatrix.hh:445
The overflow error used during implicit BCRSMatrix construction was exhausted.
Definition: istlexception.hh:32
std::remove_const< T >::type ValueType
The unqualified value type.
Definition: bcrsmatrix.hh:542
BuildStage
Definition: bcrsmatrix.hh:426
Build entries randomly.
Definition: bcrsmatrix.hh:489
size_type index() const
The number of the row that the iterator currently points to.
Definition: bcrsmatrix.hh:1017
ImplicitMatrixBuilder(Matrix &m, size_type rows, size_type cols, size_type avg_cols_per_row, double overflow_fraction)
Sets up matrix m for implicit construction using the given parameters and creates an ImplicitBmatrixu...
Definition: bcrsmatrix.hh:187
bool equals(const RealRowIterator< ValueType > &other) const
equality
Definition: bcrsmatrix.hh:583
size_type nonzeroes() const
number of blocks that are stored (the number of blocks that possibly are nonzero) ...
Definition: bcrsmatrix.hh:1906
void endindices()
indicate that all indices are defined, check consistency
Definition: bcrsmatrix.hh:1207
Iterator end()
Get iterator to one beyond last row.
Definition: bcrsmatrix.hh:640
FieldTraits< ft >::real_type infinity_norm_real() const
simplified infinity norm (uses Manhattan norm for complex values)
Definition: bcrsmatrix.hh:1828
Col col
Definition: matrixmatrix.hh:349
void operator()(size_type *p)
Definition: bcrsmatrix.hh:2120
RealRowIterator< row_type > iterator
The iterator over the (mutable matrix rows.
Definition: bcrsmatrix.hh:630
B & entry(size_type row, size_type col)
Returns reference to entry (row,col) of the matrix.
Definition: bcrsmatrix.hh:1255
size_type n
Definition: bcrsmatrix.hh:1952
void setBuildMode(BuildMode bm)
Sets the build mode of the matrix.
Definition: bcrsmatrix.hh:792
void setWindowPointers(ConstRowIterator row)
Definition: bcrsmatrix.hh:1974
void copyWindowStructure(const BCRSMatrix &Mat)
Copy the window structure from another matrix.
Definition: bcrsmatrix.hh:2044
size_type avg
Definition: bcrsmatrix.hh:1968
ConstIterator end() const
Get const iterator to one beyond last row.
Definition: bcrsmatrix.hh:677
void insert(size_type j)
put column index in row
Definition: bcrsmatrix.hh:1023
B * a
Definition: bcrsmatrix.hh:1962
BuildStage buildStage() const
The current build stage of the matrix.
Definition: bcrsmatrix.hh:1915
Iterator RowIterator
rename the iterators for easier access
Definition: bcrsmatrix.hh:660
PropertyMapTypeSelector< Amg::VertexVisitedTag, Amg::PropertiesGraph< G, Amg::VertexProperties, EP, VM, EM > >::Type get(const Amg::VertexVisitedTag &tag, Amg::PropertiesGraph< G, Amg::VertexProperties, EP, VM, EM > &graph)
Definition: dependency.hh:292
Matrix::size_type size_type
The size_type of the underlying matrix.
Definition: bcrsmatrix.hh:121
void usmtv(const field_type &alpha, const X &x, Y &y) const
y += alpha A^T x
Definition: bcrsmatrix.hh:1701
Iterator beforeBegin()
Definition: bcrsmatrix.hh:654
CreateIterator createend()
get create iterator pointing to one after the last block
Definition: bcrsmatrix.hh:1062
FieldTraits< ft >::real_type infinity_norm() const
infinity norm (row sum norm, how to generalize for blocks?)
Definition: bcrsmatrix.hh:1808
void usmv(F &&alpha, const X &x, Y &y) const
y += alpha A x
Definition: bcrsmatrix.hh:1631
void mmv(const X &x, Y &y) const
y -= A x
Definition: bcrsmatrix.hh:1612
B block_type
export the type representing the components
Definition: bcrsmatrix.hh:448
BuildStage ready
Definition: bcrsmatrix.hh:1942
void usmhv(const field_type &alpha, const X &x, Y &y) const
y += alpha A^H x
Definition: bcrsmatrix.hh:1758
Some handy generic functions for ISTL matrices.
void endrowsizes()
indicate that size of all rows is defined
Definition: bcrsmatrix.hh:1108