10 #ifndef EIGEN_SPARSE_BLOCK_H 11 #define EIGEN_SPARSE_BLOCK_H 16 template<
typename XprType,
int BlockRows,
int BlockCols>
17 class BlockImpl<XprType,BlockRows,BlockCols,true,Sparse>
18 :
public SparseMatrixBase<Block<XprType,BlockRows,BlockCols,true> >
20 typedef typename internal::remove_all<typename XprType::Nested>::type _MatrixTypeNested;
21 typedef Block<XprType, BlockRows, BlockCols, true> BlockType;
23 enum { IsRowMajor = internal::traits<BlockType>::IsRowMajor };
25 enum { OuterSize = IsRowMajor ? BlockRows : BlockCols };
26 typedef SparseMatrixBase<BlockType> Base;
27 using Base::convert_index;
29 EIGEN_SPARSE_PUBLIC_INTERFACE(BlockType)
31 inline BlockImpl(const XprType& xpr, Index i)
32 : m_matrix(xpr), m_outerStart(convert_index(i)), m_outerSize(OuterSize)
35 inline BlockImpl(
const XprType& xpr, Index startRow, Index startCol, Index blockRows, Index blockCols)
36 : m_matrix(xpr), m_outerStart(convert_index(IsRowMajor ? startRow : startCol)), m_outerSize(convert_index(IsRowMajor ? blockRows : blockCols))
39 EIGEN_STRONG_INLINE Index rows()
const {
return IsRowMajor ? m_outerSize.value() : m_matrix.rows(); }
40 EIGEN_STRONG_INLINE Index cols()
const {
return IsRowMajor ? m_matrix.cols() : m_outerSize.value(); }
42 Index nonZeros()
const 44 typedef internal::evaluator<XprType> EvaluatorType;
45 EvaluatorType matEval(m_matrix);
47 Index end = m_outerStart + m_outerSize.value();
48 for(Index j=m_outerStart; j<end; ++j)
49 for(
typename EvaluatorType::InnerIterator it(matEval, j); it; ++it)
54 inline const Scalar coeff(Index row, Index col)
const 56 return m_matrix.coeff(row + (IsRowMajor ? m_outerStart : 0), col + (IsRowMajor ? 0 : m_outerStart));
59 inline const Scalar coeff(Index index)
const 61 return m_matrix.coeff(IsRowMajor ? m_outerStart : index, IsRowMajor ? index : m_outerStart);
64 inline const _MatrixTypeNested& nestedExpression()
const {
return m_matrix; }
65 Index startRow()
const {
return IsRowMajor ? m_outerStart : 0; }
66 Index startCol()
const {
return IsRowMajor ? 0 : m_outerStart; }
67 Index blockRows()
const {
return IsRowMajor ? m_outerSize.value() : m_matrix.rows(); }
68 Index blockCols()
const {
return IsRowMajor ? m_matrix.cols() : m_outerSize.value(); }
72 typename XprType::Nested m_matrix;
74 const internal::variable_if_dynamic<Index, OuterSize> m_outerSize;
77 EIGEN_INHERIT_ASSIGNMENT_OPERATORS(BlockImpl)
87 template<
typename SparseMatrixType,
int BlockRows,
int BlockCols>
88 class sparse_matrix_block_impl
89 :
public SparseCompressedBase<Block<SparseMatrixType,BlockRows,BlockCols,true> >
91 typedef typename internal::remove_all<typename SparseMatrixType::Nested>::type _MatrixTypeNested;
92 typedef Block<SparseMatrixType, BlockRows, BlockCols, true> BlockType;
93 typedef SparseCompressedBase<Block<SparseMatrixType,BlockRows,BlockCols,true> > Base;
94 using Base::convert_index;
96 enum { IsRowMajor = internal::traits<BlockType>::IsRowMajor };
97 EIGEN_SPARSE_PUBLIC_INTERFACE(BlockType)
99 typedef typename Base::IndexVector IndexVector;
100 enum { OuterSize = IsRowMajor ? BlockRows : BlockCols };
103 inline sparse_matrix_block_impl(
const SparseMatrixType& xpr, Index i)
104 : m_matrix(xpr), m_outerStart(convert_index(i)), m_outerSize(OuterSize)
107 inline sparse_matrix_block_impl(
const SparseMatrixType& xpr, Index startRow, Index startCol, Index blockRows, Index blockCols)
108 : m_matrix(xpr), m_outerStart(convert_index(IsRowMajor ? startRow : startCol)), m_outerSize(convert_index(IsRowMajor ? blockRows : blockCols))
111 template<
typename OtherDerived>
112 inline BlockType& operator=(
const SparseMatrixBase<OtherDerived>& other)
114 typedef typename internal::remove_all<typename SparseMatrixType::Nested>::type _NestedMatrixType;
115 _NestedMatrixType& matrix =
const_cast<_NestedMatrixType&
>(m_matrix);;
120 Ref<const SparseMatrix<Scalar, IsRowMajor ? RowMajor : ColMajor, StorageIndex> > tmp(other.derived());
121 eigen_internal_assert(tmp.outerSize()==m_outerSize.value());
124 Index nnz = tmp.nonZeros();
125 Index start = m_outerStart==0 ? 0 : matrix.outerIndexPtr()[m_outerStart];
126 Index end = m_matrix.outerIndexPtr()[m_outerStart+m_outerSize.value()];
127 Index block_size = end - start;
128 Index tail_size = m_matrix.outerIndexPtr()[m_matrix.outerSize()] - end;
130 Index free_size = m_matrix.isCompressed()
131 ? Index(matrix.data().allocatedSize()) + block_size
134 bool update_trailing_pointers =
false;
138 typename SparseMatrixType::Storage newdata(m_matrix.data().allocatedSize() - block_size + nnz);
140 internal::smart_copy(&m_matrix.data().value(0), &m_matrix.data().value(0) + start, &newdata.value(0));
141 internal::smart_copy(&m_matrix.data().index(0), &m_matrix.data().index(0) + start, &newdata.index(0));
143 internal::smart_copy(tmp.valuePtr(), tmp.valuePtr() + nnz, &newdata.value(start));
144 internal::smart_copy(tmp.innerIndexPtr(), tmp.innerIndexPtr() + nnz, &newdata.index(start));
146 internal::smart_copy(&matrix.data().value(end), &matrix.data().value(end) + tail_size, &newdata.value(start+nnz));
147 internal::smart_copy(&matrix.data().index(end), &matrix.data().index(end) + tail_size, &newdata.index(start+nnz));
149 newdata.resize(m_matrix.outerIndexPtr()[m_matrix.outerSize()] - block_size + nnz);
151 matrix.data().swap(newdata);
153 update_trailing_pointers =
true;
157 if(m_matrix.isCompressed())
160 matrix.data().resize(start + nnz + tail_size);
162 internal::smart_memmove(&matrix.data().value(end), &matrix.data().value(end) + tail_size, &matrix.data().value(start + nnz));
163 internal::smart_memmove(&matrix.data().index(end), &matrix.data().index(end) + tail_size, &matrix.data().index(start + nnz));
165 update_trailing_pointers =
true;
168 internal::smart_copy(tmp.valuePtr(), tmp.valuePtr() + nnz, &matrix.data().value(start));
169 internal::smart_copy(tmp.innerIndexPtr(), tmp.innerIndexPtr() + nnz, &matrix.data().index(start));
173 if(IsVectorAtCompileTime)
175 if(!m_matrix.isCompressed())
176 matrix.innerNonZeroPtr()[m_outerStart] = StorageIndex(nnz);
177 matrix.outerIndexPtr()[m_outerStart] = StorageIndex(start);
181 StorageIndex p = StorageIndex(start);
182 for(Index k=0; k<m_outerSize.value(); ++k)
184 Index nnz_k = tmp.innerVector(k).nonZeros();
185 if(!m_matrix.isCompressed())
186 matrix.innerNonZeroPtr()[m_outerStart+k] = StorageIndex(nnz_k);
187 matrix.outerIndexPtr()[m_outerStart+k] = p;
192 if(update_trailing_pointers)
194 StorageIndex offset = internal::convert_index<StorageIndex>(nnz - block_size);
195 for(Index k = m_outerStart + m_outerSize.value(); k<=matrix.outerSize(); ++k)
197 matrix.outerIndexPtr()[k] += offset;
204 inline BlockType& operator=(
const BlockType& other)
206 return operator=<BlockType>(other);
209 inline const Scalar* valuePtr()
const 210 {
return m_matrix.valuePtr(); }
211 inline Scalar* valuePtr()
212 {
return m_matrix.const_cast_derived().valuePtr(); }
214 inline const StorageIndex* innerIndexPtr()
const 215 {
return m_matrix.innerIndexPtr(); }
216 inline StorageIndex* innerIndexPtr()
217 {
return m_matrix.const_cast_derived().innerIndexPtr(); }
219 inline const StorageIndex* outerIndexPtr()
const 220 {
return m_matrix.outerIndexPtr() + m_outerStart; }
221 inline StorageIndex* outerIndexPtr()
222 {
return m_matrix.const_cast_derived().outerIndexPtr() + m_outerStart; }
224 inline const StorageIndex* innerNonZeroPtr()
const 225 {
return isCompressed() ? 0 : (m_matrix.innerNonZeroPtr()+m_outerStart); }
226 inline StorageIndex* innerNonZeroPtr()
227 {
return isCompressed() ? 0 : (m_matrix.const_cast_derived().innerNonZeroPtr()+m_outerStart); }
229 bool isCompressed()
const {
return m_matrix.innerNonZeroPtr()==0; }
231 inline Scalar& coeffRef(Index row, Index col)
233 return m_matrix.const_cast_derived().coeffRef(row + (IsRowMajor ? m_outerStart : 0), col + (IsRowMajor ? 0 : m_outerStart));
236 inline const Scalar coeff(Index row, Index col)
const 238 return m_matrix.coeff(row + (IsRowMajor ? m_outerStart : 0), col + (IsRowMajor ? 0 : m_outerStart));
241 inline const Scalar coeff(Index index)
const 243 return m_matrix.coeff(IsRowMajor ? m_outerStart : index, IsRowMajor ? index : m_outerStart);
246 const Scalar& lastCoeff()
const 248 EIGEN_STATIC_ASSERT_VECTOR_ONLY(sparse_matrix_block_impl);
249 eigen_assert(Base::nonZeros()>0);
250 if(m_matrix.isCompressed())
251 return m_matrix.valuePtr()[m_matrix.outerIndexPtr()[m_outerStart+1]-1];
253 return m_matrix.valuePtr()[m_matrix.outerIndexPtr()[m_outerStart]+m_matrix.innerNonZeroPtr()[m_outerStart]-1];
256 EIGEN_STRONG_INLINE Index rows()
const {
return IsRowMajor ? m_outerSize.value() : m_matrix.rows(); }
257 EIGEN_STRONG_INLINE Index cols()
const {
return IsRowMajor ? m_matrix.cols() : m_outerSize.value(); }
259 inline const _MatrixTypeNested& nestedExpression()
const {
return m_matrix; }
260 Index startRow()
const {
return IsRowMajor ? m_outerStart : 0; }
261 Index startCol()
const {
return IsRowMajor ? 0 : m_outerStart; }
262 Index blockRows()
const {
return IsRowMajor ? m_outerSize.value() : m_matrix.rows(); }
263 Index blockCols()
const {
return IsRowMajor ? m_matrix.cols() : m_outerSize.value(); }
267 typename SparseMatrixType::Nested m_matrix;
269 const internal::variable_if_dynamic<Index, OuterSize> m_outerSize;
275 template<
typename _Scalar,
int _Options,
typename _StorageIndex,
int BlockRows,
int BlockCols>
276 class BlockImpl<SparseMatrix<_Scalar, _Options, _StorageIndex>,BlockRows,BlockCols,true,Sparse>
277 :
public internal::sparse_matrix_block_impl<SparseMatrix<_Scalar, _Options, _StorageIndex>,BlockRows,BlockCols>
280 typedef _StorageIndex StorageIndex;
281 typedef SparseMatrix<_Scalar, _Options, _StorageIndex> SparseMatrixType;
282 typedef internal::sparse_matrix_block_impl<SparseMatrixType,BlockRows,BlockCols> Base;
283 inline BlockImpl(SparseMatrixType& xpr, Index i)
287 inline BlockImpl(SparseMatrixType& xpr, Index startRow, Index startCol, Index blockRows, Index blockCols)
288 : Base(xpr, startRow, startCol, blockRows, blockCols)
291 using Base::operator=;
294 template<
typename _Scalar,
int _Options,
typename _StorageIndex,
int BlockRows,
int BlockCols>
295 class BlockImpl<const SparseMatrix<_Scalar, _Options, _StorageIndex>,BlockRows,BlockCols,true,Sparse>
296 :
public internal::sparse_matrix_block_impl<const SparseMatrix<_Scalar, _Options, _StorageIndex>,BlockRows,BlockCols>
299 typedef _StorageIndex StorageIndex;
300 typedef const SparseMatrix<_Scalar, _Options, _StorageIndex> SparseMatrixType;
301 typedef internal::sparse_matrix_block_impl<SparseMatrixType,BlockRows,BlockCols> Base;
302 inline BlockImpl(SparseMatrixType& xpr, Index i)
306 inline BlockImpl(SparseMatrixType& xpr, Index startRow, Index startCol, Index blockRows, Index blockCols)
307 : Base(xpr, startRow, startCol, blockRows, blockCols)
310 using Base::operator=;
312 template<
typename Derived> BlockImpl(
const SparseMatrixBase<Derived>& xpr, Index i);
313 template<
typename Derived> BlockImpl(
const SparseMatrixBase<Derived>& xpr);
321 template<
typename Derived>
328 template<
typename Derived>
335 template<
typename Derived>
340 IsRowMajor ? outerStart : 0, IsRowMajor ? 0 : outerStart,
341 IsRowMajor ? outerSize : rows(), IsRowMajor ? cols() : outerSize);
348 template<
typename Derived>
353 IsRowMajor ? outerStart : 0, IsRowMajor ? 0 : outerStart,
354 IsRowMajor ? outerSize : rows(), IsRowMajor ? cols() : outerSize);
361 template<
typename XprType,
int BlockRows,
int BlockCols,
bool InnerPanel>
362 class BlockImpl<XprType,BlockRows,BlockCols,InnerPanel,
Sparse>
363 :
public SparseMatrixBase<Block<XprType,BlockRows,BlockCols,InnerPanel> >, internal::no_assignment_operator
367 using Base::convert_index;
369 enum { IsRowMajor = internal::traits<BlockType>::IsRowMajor };
370 EIGEN_SPARSE_PUBLIC_INTERFACE(BlockType)
372 typedef typename internal::remove_all<typename XprType::Nested>::type _MatrixTypeNested;
378 m_startRow( (BlockRows==1) && (BlockCols==XprType::ColsAtCompileTime) ? convert_index(i) : 0),
379 m_startCol( (BlockRows==XprType::RowsAtCompileTime) && (BlockCols==1) ? convert_index(i) : 0),
380 m_blockRows(BlockRows==1 ? 1 : xpr.rows()),
381 m_blockCols(BlockCols==1 ? 1 : xpr.cols())
386 inline BlockImpl(
const XprType& xpr, Index startRow, Index startCol, Index blockRows, Index blockCols)
387 : m_matrix(xpr), m_startRow(convert_index(startRow)), m_startCol(convert_index(startCol)), m_blockRows(convert_index(blockRows)), m_blockCols(convert_index(blockCols))
390 inline Index rows()
const {
return m_blockRows.value(); }
391 inline Index cols()
const {
return m_blockCols.value(); }
393 inline Scalar& coeffRef(Index row, Index col)
395 return m_matrix.const_cast_derived()
396 .coeffRef(row + m_startRow.value(), col + m_startCol.value());
399 inline const Scalar coeff(Index row, Index col)
const 401 return m_matrix.coeff(row + m_startRow.value(), col + m_startCol.value());
404 inline Scalar& coeffRef(Index index)
406 return m_matrix.const_cast_derived()
407 .coeffRef(m_startRow.value() + (RowsAtCompileTime == 1 ? 0 : index),
408 m_startCol.value() + (RowsAtCompileTime == 1 ? index : 0));
411 inline const Scalar coeff(Index index)
const 414 .coeff(m_startRow.value() + (RowsAtCompileTime == 1 ? 0 : index),
415 m_startCol.value() + (RowsAtCompileTime == 1 ? index : 0));
418 inline const _MatrixTypeNested& nestedExpression()
const {
return m_matrix; }
419 Index startRow()
const {
return m_startRow.value(); }
420 Index startCol()
const {
return m_startCol.value(); }
421 Index blockRows()
const {
return m_blockRows.value(); }
422 Index blockCols()
const {
return m_blockCols.value(); }
426 friend class ReverseInnerIterator;
427 friend struct internal::unary_evaluator<Block<XprType,BlockRows,BlockCols,InnerPanel>, internal::IteratorBased, Scalar >;
429 Index nonZeros() const {
return Dynamic; }
431 EIGEN_INHERIT_ASSIGNMENT_OPERATORS(BlockImpl)
433 typename XprType::Nested m_matrix;
434 const internal::variable_if_dynamic<Index, XprType::RowsAtCompileTime == 1 ? 0 : Dynamic> m_startRow;
435 const internal::variable_if_dynamic<Index, XprType::ColsAtCompileTime == 1 ? 0 : Dynamic> m_startCol;
436 const internal::variable_if_dynamic<Index, RowsAtCompileTime> m_blockRows;
437 const internal::variable_if_dynamic<Index, ColsAtCompileTime> m_blockCols;
443 template<
typename ArgType,
int BlockRows,
int BlockCols,
bool InnerPanel>
444 struct unary_evaluator<Block<ArgType,BlockRows,BlockCols,InnerPanel>, IteratorBased >
445 :
public evaluator_base<Block<ArgType,BlockRows,BlockCols,InnerPanel> >
447 class InnerVectorInnerIterator;
448 class OuterVectorInnerIterator;
451 typedef typename XprType::StorageIndex StorageIndex;
452 typedef typename XprType::Scalar Scalar;
454 class ReverseInnerIterator;
457 IsRowMajor = XprType::IsRowMajor,
459 OuterVector = (BlockCols==1 && ArgType::IsRowMajor)
462 (BlockRows==1 && !ArgType::IsRowMajor),
464 CoeffReadCost = evaluator<ArgType>::CoeffReadCost,
465 Flags = XprType::Flags
468 typedef typename internal::conditional<OuterVector,OuterVectorInnerIterator,InnerVectorInnerIterator>::type InnerIterator;
470 explicit unary_evaluator(
const XprType& op)
471 : m_argImpl(op.nestedExpression()), m_block(op)
474 inline Index nonZerosEstimate()
const {
475 Index nnz = m_block.nonZeros();
477 return m_argImpl.nonZerosEstimate() * m_block.size() / m_block.nestedExpression().size();
482 typedef typename evaluator<ArgType>::InnerIterator EvalIterator;
484 evaluator<ArgType> m_argImpl;
485 const XprType &m_block;
488 template<
typename ArgType,
int BlockRows,
int BlockCols,
bool InnerPanel>
489 class unary_evaluator<Block<ArgType,BlockRows,BlockCols,InnerPanel>, IteratorBased>::InnerVectorInnerIterator
490 :
public EvalIterator
492 const XprType& m_block;
496 EIGEN_STRONG_INLINE InnerVectorInnerIterator(
const unary_evaluator& aEval, Index outer)
497 : EvalIterator(aEval.m_argImpl, outer + (IsRowMajor ? aEval.m_block.startRow() : aEval.m_block.startCol())),
498 m_block(aEval.m_block),
499 m_end(IsRowMajor ? aEval.m_block.startCol()+aEval.m_block.blockCols() : aEval.m_block.startRow()+aEval.m_block.blockRows())
501 while( (EvalIterator::operator
bool()) && (EvalIterator::index() < (IsRowMajor ? m_block.startCol() : m_block.startRow())) )
502 EvalIterator::operator++();
505 inline StorageIndex index()
const {
return EvalIterator::index() - convert_index<StorageIndex>(IsRowMajor ? m_block.startCol() : m_block.startRow()); }
506 inline Index outer()
const {
return EvalIterator::outer() - (IsRowMajor ? m_block.startRow() : m_block.startCol()); }
507 inline Index row()
const {
return EvalIterator::row() - m_block.startRow(); }
508 inline Index col()
const {
return EvalIterator::col() - m_block.startCol(); }
510 inline operator bool()
const {
return EvalIterator::operator bool() && EvalIterator::index() < m_end; }
513 template<
typename ArgType,
int BlockRows,
int BlockCols,
bool InnerPanel>
514 class unary_evaluator<Block<ArgType,BlockRows,BlockCols,InnerPanel>, IteratorBased>::OuterVectorInnerIterator
516 const unary_evaluator& m_eval;
523 EIGEN_STRONG_INLINE OuterVectorInnerIterator(
const unary_evaluator& aEval, Index outer)
525 m_outerPos( (IsRowMajor ? aEval.m_block.startCol() : aEval.m_block.startRow()) - 1),
526 m_innerIndex(IsRowMajor ? aEval.m_block.startRow() : aEval.m_block.startCol()),
528 m_end(IsRowMajor ? aEval.m_block.startCol()+aEval.m_block.blockCols() : aEval.m_block.startRow()+aEval.m_block.blockRows())
530 EIGEN_UNUSED_VARIABLE(outer);
531 eigen_assert(outer==0);
536 inline StorageIndex index()
const {
return convert_index<StorageIndex>(m_outerPos - (IsRowMajor ? m_eval.m_block.startCol() : m_eval.m_block.startRow())); }
537 inline Index outer()
const {
return 0; }
538 inline Index row()
const {
return IsRowMajor ? 0 : index(); }
539 inline Index col()
const {
return IsRowMajor ? index() : 0; }
541 inline Scalar value()
const {
return m_value; }
543 inline OuterVectorInnerIterator& operator++()
546 while(++m_outerPos<m_end)
548 EvalIterator it(m_eval.m_argImpl, m_outerPos);
550 while(it && it.index() < m_innerIndex) ++it;
551 if(it && it.index()==m_innerIndex)
553 m_value = it.value();
560 inline operator bool()
const {
return m_outerPos < m_end; }
563 template<
typename _Scalar,
int _Options,
typename _StorageIndex,
int BlockRows,
int BlockCols>
564 struct unary_evaluator<Block<SparseMatrix<_Scalar, _Options, _StorageIndex>,BlockRows,BlockCols,true>, IteratorBased>
565 : evaluator<SparseCompressedBase<Block<SparseMatrix<_Scalar, _Options, _StorageIndex>,BlockRows,BlockCols,true> > >
568 typedef evaluator<SparseCompressedBase<XprType> > Base;
569 explicit unary_evaluator(
const XprType &xpr) : Base(xpr) {}
572 template<
typename _Scalar,
int _Options,
typename _StorageIndex,
int BlockRows,
int BlockCols>
573 struct unary_evaluator<Block<const SparseMatrix<_Scalar, _Options, _StorageIndex>,BlockRows,BlockCols,true>, IteratorBased>
574 : evaluator<SparseCompressedBase<Block<const SparseMatrix<_Scalar, _Options, _StorageIndex>,BlockRows,BlockCols,true> > >
577 typedef evaluator<SparseCompressedBase<XprType> > Base;
578 explicit unary_evaluator(
const XprType &xpr) : Base(xpr) {}
586 #endif // EIGEN_SPARSE_BLOCK_H
Eigen::Index Index
The interface type of indices.
Definition: EigenBase.h:37
Base class of any sparse matrices or sparse expressions.
Definition: ForwardDeclarations.h:278
InnerVectorReturnType innerVector(Index outer)
Definition: SparseBlock.h:322
Definition: Constants.h:493
BlockImpl(const XprType &xpr, Index i)
Definition: SparseBlock.h:376
Definition: Eigen_Colamd.h:54
InnerVectorsReturnType innerVectors(Index outerStart, Index outerSize)
Definition: SparseBlock.h:337
Expression of a fixed-size or dynamic-size block.
Definition: Block.h:104
BlockImpl(const XprType &xpr, Index startRow, Index startCol, Index blockRows, Index blockCols)
Definition: SparseBlock.h:386