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(XprType& xpr,
Index i)
32 : m_matrix(xpr), m_outerStart(convert_index(i)), m_outerSize(OuterSize)
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 XprType& nestedExpression()
const {
return m_matrix; }
65 inline XprType& nestedExpression() {
return m_matrix; }
66 Index startRow()
const {
return IsRowMajor ? m_outerStart : 0; }
67 Index startCol()
const {
return IsRowMajor ? 0 : m_outerStart; }
68 Index blockRows()
const {
return IsRowMajor ? m_outerSize.value() : m_matrix.rows(); }
69 Index blockCols()
const {
return IsRowMajor ? m_matrix.cols() : m_outerSize.value(); }
73 typename internal::ref_selector<XprType>::non_const_type m_matrix;
75 const internal::variable_if_dynamic<Index, OuterSize> m_outerSize;
81 BlockImpl& operator=(
const T&)
83 EIGEN_STATIC_ASSERT(
sizeof(T)==0, THIS_SPARSE_BLOCK_SUBEXPRESSION_IS_READ_ONLY);
95 template<
typename SparseMatrixType,
int BlockRows,
int BlockCols>
96 class sparse_matrix_block_impl
97 :
public SparseCompressedBase<Block<SparseMatrixType,BlockRows,BlockCols,true> >
99 typedef typename internal::remove_all<typename SparseMatrixType::Nested>::type _MatrixTypeNested;
100 typedef Block<SparseMatrixType, BlockRows, BlockCols, true> BlockType;
101 typedef SparseCompressedBase<Block<SparseMatrixType,BlockRows,BlockCols,true> > Base;
102 using Base::convert_index;
104 enum { IsRowMajor = internal::traits<BlockType>::IsRowMajor };
105 EIGEN_SPARSE_PUBLIC_INTERFACE(BlockType)
107 typedef typename Base::IndexVector IndexVector;
108 enum { OuterSize = IsRowMajor ? BlockRows : BlockCols };
111 inline sparse_matrix_block_impl(SparseMatrixType& xpr,
Index i)
112 : m_matrix(xpr), m_outerStart(convert_index(i)), m_outerSize(OuterSize)
115 inline sparse_matrix_block_impl(SparseMatrixType& xpr,
Index startRow,
Index startCol,
Index blockRows,
Index blockCols)
116 : m_matrix(xpr), m_outerStart(convert_index(IsRowMajor ? startRow : startCol)), m_outerSize(convert_index(IsRowMajor ? blockRows : blockCols))
119 template<
typename OtherDerived>
120 inline BlockType& operator=(
const SparseMatrixBase<OtherDerived>& other)
122 typedef typename internal::remove_all<typename SparseMatrixType::Nested>::type _NestedMatrixType;
123 _NestedMatrixType& matrix = m_matrix;
128 Ref<const SparseMatrix<Scalar, IsRowMajor ? RowMajor : ColMajor, StorageIndex> > tmp(other.derived());
129 eigen_internal_assert(tmp.outerSize()==m_outerSize.value());
132 Index nnz = tmp.nonZeros();
133 Index start = m_outerStart==0 ? 0 : matrix.outerIndexPtr()[m_outerStart];
134 Index end = m_matrix.outerIndexPtr()[m_outerStart+m_outerSize.value()];
135 Index block_size = end - start;
136 Index tail_size = m_matrix.outerIndexPtr()[m_matrix.outerSize()] - end;
138 Index free_size = m_matrix.isCompressed()
139 ?
Index(matrix.data().allocatedSize()) + block_size
142 bool update_trailing_pointers =
false;
146 typename SparseMatrixType::Storage newdata(m_matrix.data().allocatedSize() - block_size + nnz);
148 internal::smart_copy(m_matrix.valuePtr(), m_matrix.valuePtr() + start, newdata.valuePtr());
149 internal::smart_copy(m_matrix.innerIndexPtr(), m_matrix.innerIndexPtr() + start, newdata.indexPtr());
151 internal::smart_copy(tmp.valuePtr(), tmp.valuePtr() + nnz, newdata.valuePtr() + start);
152 internal::smart_copy(tmp.innerIndexPtr(), tmp.innerIndexPtr() + nnz, newdata.indexPtr() + start);
154 internal::smart_copy(matrix.valuePtr()+end, matrix.valuePtr()+end + tail_size, newdata.valuePtr()+start+nnz);
155 internal::smart_copy(matrix.innerIndexPtr()+end, matrix.innerIndexPtr()+end + tail_size, newdata.indexPtr()+start+nnz);
157 newdata.resize(m_matrix.outerIndexPtr()[m_matrix.outerSize()] - block_size + nnz);
159 matrix.data().swap(newdata);
161 update_trailing_pointers =
true;
165 if(m_matrix.isCompressed())
168 matrix.data().resize(start + nnz + tail_size);
170 internal::smart_memmove(matrix.valuePtr()+end, matrix.valuePtr() + end+tail_size, matrix.valuePtr() + start+nnz);
171 internal::smart_memmove(matrix.innerIndexPtr()+end, matrix.innerIndexPtr() + end+tail_size, matrix.innerIndexPtr() + start+nnz);
173 update_trailing_pointers =
true;
176 internal::smart_copy(tmp.valuePtr(), tmp.valuePtr() + nnz, matrix.valuePtr() + start);
177 internal::smart_copy(tmp.innerIndexPtr(), tmp.innerIndexPtr() + nnz, matrix.innerIndexPtr() + start);
181 if(IsVectorAtCompileTime)
183 if(!m_matrix.isCompressed())
184 matrix.innerNonZeroPtr()[m_outerStart] = StorageIndex(nnz);
185 matrix.outerIndexPtr()[m_outerStart] = StorageIndex(start);
189 StorageIndex p = StorageIndex(start);
190 for(
Index k=0; k<m_outerSize.value(); ++k)
192 StorageIndex nnz_k = internal::convert_index<StorageIndex>(tmp.innerVector(k).nonZeros());
193 if(!m_matrix.isCompressed())
194 matrix.innerNonZeroPtr()[m_outerStart+k] = nnz_k;
195 matrix.outerIndexPtr()[m_outerStart+k] = p;
200 if(update_trailing_pointers)
202 StorageIndex offset = internal::convert_index<StorageIndex>(nnz - block_size);
203 for(
Index k = m_outerStart + m_outerSize.value(); k<=matrix.outerSize(); ++k)
205 matrix.outerIndexPtr()[k] += offset;
212 inline BlockType& operator=(
const BlockType& other)
214 return operator=<BlockType>(other);
217 inline const Scalar* valuePtr()
const 218 {
return m_matrix.valuePtr(); }
219 inline Scalar* valuePtr()
220 {
return m_matrix.valuePtr(); }
222 inline const StorageIndex* innerIndexPtr()
const 223 {
return m_matrix.innerIndexPtr(); }
224 inline StorageIndex* innerIndexPtr()
225 {
return m_matrix.innerIndexPtr(); }
227 inline const StorageIndex* outerIndexPtr()
const 228 {
return m_matrix.outerIndexPtr() + m_outerStart; }
229 inline StorageIndex* outerIndexPtr()
230 {
return m_matrix.outerIndexPtr() + m_outerStart; }
232 inline const StorageIndex* innerNonZeroPtr()
const 233 {
return isCompressed() ? 0 : (m_matrix.innerNonZeroPtr()+m_outerStart); }
234 inline StorageIndex* innerNonZeroPtr()
235 {
return isCompressed() ? 0 : (m_matrix.innerNonZeroPtr()+m_outerStart); }
237 bool isCompressed()
const {
return m_matrix.innerNonZeroPtr()==0; }
241 return m_matrix.coeffRef(row + (IsRowMajor ? m_outerStart : 0), col + (IsRowMajor ? 0 : m_outerStart));
244 inline const Scalar coeff(
Index row,
Index col)
const 246 return m_matrix.coeff(row + (IsRowMajor ? m_outerStart : 0), col + (IsRowMajor ? 0 : m_outerStart));
249 inline const Scalar coeff(
Index index)
const 251 return m_matrix.coeff(IsRowMajor ? m_outerStart : index, IsRowMajor ? index : m_outerStart);
254 const Scalar& lastCoeff()
const 256 EIGEN_STATIC_ASSERT_VECTOR_ONLY(sparse_matrix_block_impl);
257 eigen_assert(Base::nonZeros()>0);
258 if(m_matrix.isCompressed())
259 return m_matrix.valuePtr()[m_matrix.outerIndexPtr()[m_outerStart+1]-1];
261 return m_matrix.valuePtr()[m_matrix.outerIndexPtr()[m_outerStart]+m_matrix.innerNonZeroPtr()[m_outerStart]-1];
264 EIGEN_STRONG_INLINE
Index rows()
const {
return IsRowMajor ? m_outerSize.value() : m_matrix.rows(); }
265 EIGEN_STRONG_INLINE
Index cols()
const {
return IsRowMajor ? m_matrix.cols() : m_outerSize.value(); }
267 inline const SparseMatrixType& nestedExpression()
const {
return m_matrix; }
268 inline SparseMatrixType& nestedExpression() {
return m_matrix; }
269 Index startRow()
const {
return IsRowMajor ? m_outerStart : 0; }
270 Index startCol()
const {
return IsRowMajor ? 0 : m_outerStart; }
271 Index blockRows()
const {
return IsRowMajor ? m_outerSize.value() : m_matrix.rows(); }
272 Index blockCols()
const {
return IsRowMajor ? m_matrix.cols() : m_outerSize.value(); }
276 typename internal::ref_selector<SparseMatrixType>::non_const_type m_matrix;
278 const internal::variable_if_dynamic<Index, OuterSize> m_outerSize;
284 template<
typename _Scalar,
int _Options,
typename _StorageIndex,
int BlockRows,
int BlockCols>
285 class BlockImpl<SparseMatrix<_Scalar, _Options, _StorageIndex>,BlockRows,BlockCols,true,Sparse>
286 :
public internal::sparse_matrix_block_impl<SparseMatrix<_Scalar, _Options, _StorageIndex>,BlockRows,BlockCols>
289 typedef _StorageIndex StorageIndex;
290 typedef SparseMatrix<_Scalar, _Options, _StorageIndex> SparseMatrixType;
291 typedef internal::sparse_matrix_block_impl<SparseMatrixType,BlockRows,BlockCols> Base;
292 inline BlockImpl(SparseMatrixType& xpr,
Index i)
296 inline BlockImpl(SparseMatrixType& xpr,
Index startRow,
Index startCol,
Index blockRows,
Index blockCols)
297 : Base(xpr, startRow, startCol, blockRows, blockCols)
300 using Base::operator=;
303 template<
typename _Scalar,
int _Options,
typename _StorageIndex,
int BlockRows,
int BlockCols>
304 class BlockImpl<const SparseMatrix<_Scalar, _Options, _StorageIndex>,BlockRows,BlockCols,true,Sparse>
305 :
public internal::sparse_matrix_block_impl<const SparseMatrix<_Scalar, _Options, _StorageIndex>,BlockRows,BlockCols>
308 typedef _StorageIndex StorageIndex;
309 typedef const SparseMatrix<_Scalar, _Options, _StorageIndex> SparseMatrixType;
310 typedef internal::sparse_matrix_block_impl<SparseMatrixType,BlockRows,BlockCols> Base;
311 inline BlockImpl(SparseMatrixType& xpr,
Index i)
315 inline BlockImpl(SparseMatrixType& xpr,
Index startRow,
Index startCol,
Index blockRows,
Index blockCols)
316 : Base(xpr, startRow, startCol, blockRows, blockCols)
319 using Base::operator=;
321 template<
typename Derived> BlockImpl(
const SparseMatrixBase<Derived>& xpr,
Index i);
322 template<
typename Derived> BlockImpl(
const SparseMatrixBase<Derived>& xpr);
330 template<
typename Derived>
337 template<
typename Derived>
344 template<
typename Derived>
349 IsRowMajor ? outerStart : 0, IsRowMajor ? 0 : outerStart,
350 IsRowMajor ? outerSize : rows(), IsRowMajor ? cols() : outerSize);
357 template<
typename Derived>
362 IsRowMajor ? outerStart : 0, IsRowMajor ? 0 : outerStart,
363 IsRowMajor ? outerSize : rows(), IsRowMajor ? cols() : outerSize);
370 template<
typename XprType,
int BlockRows,
int BlockCols,
bool InnerPanel>
371 class BlockImpl<XprType,BlockRows,BlockCols,InnerPanel,
Sparse>
372 :
public SparseMatrixBase<Block<XprType,BlockRows,BlockCols,InnerPanel> >, internal::no_assignment_operator
376 using Base::convert_index;
378 enum { IsRowMajor = internal::traits<BlockType>::IsRowMajor };
379 EIGEN_SPARSE_PUBLIC_INTERFACE(BlockType)
381 typedef typename internal::remove_all<typename XprType::Nested>::type _MatrixTypeNested;
387 m_startRow( (BlockRows==1) && (BlockCols==XprType::ColsAtCompileTime) ? convert_index(i) : 0),
388 m_startCol( (BlockRows==XprType::RowsAtCompileTime) && (BlockCols==1) ? convert_index(i) : 0),
389 m_blockRows(BlockRows==1 ? 1 : xpr.rows()),
390 m_blockCols(BlockCols==1 ? 1 : xpr.cols())
396 : m_matrix(xpr), m_startRow(convert_index(startRow)), m_startCol(convert_index(startCol)), m_blockRows(convert_index(blockRows)), m_blockCols(convert_index(blockCols))
399 inline Index rows()
const {
return m_blockRows.value(); }
400 inline Index cols()
const {
return m_blockCols.value(); }
404 return m_matrix.coeffRef(row + m_startRow.value(), col + m_startCol.value());
407 inline const Scalar coeff(
Index row,
Index col)
const 409 return m_matrix.coeff(row + m_startRow.value(), col + m_startCol.value());
412 inline Scalar& coeffRef(
Index index)
414 return m_matrix.coeffRef(m_startRow.value() + (RowsAtCompileTime == 1 ? 0 : index),
415 m_startCol.value() + (RowsAtCompileTime == 1 ? index : 0));
418 inline const Scalar coeff(
Index index)
const 420 return m_matrix.coeff(m_startRow.value() + (RowsAtCompileTime == 1 ? 0 : index),
421 m_startCol.value() + (RowsAtCompileTime == 1 ? index : 0));
424 inline const XprType& nestedExpression()
const {
return m_matrix; }
425 inline XprType& nestedExpression() {
return m_matrix; }
426 Index startRow()
const {
return m_startRow.value(); }
427 Index startCol()
const {
return m_startCol.value(); }
428 Index blockRows()
const {
return m_blockRows.value(); }
429 Index blockCols()
const {
return m_blockCols.value(); }
433 friend class ReverseInnerIterator;
434 friend struct internal::unary_evaluator<Block<XprType,BlockRows,BlockCols,InnerPanel>, internal::IteratorBased, Scalar >;
438 typename internal::ref_selector<XprType>::non_const_type m_matrix;
439 const internal::variable_if_dynamic<Index, XprType::RowsAtCompileTime == 1 ? 0 : Dynamic> m_startRow;
440 const internal::variable_if_dynamic<Index, XprType::ColsAtCompileTime == 1 ? 0 : Dynamic> m_startCol;
441 const internal::variable_if_dynamic<Index, RowsAtCompileTime> m_blockRows;
442 const internal::variable_if_dynamic<Index, ColsAtCompileTime> m_blockCols;
448 BlockImpl& operator=(
const T&)
450 EIGEN_STATIC_ASSERT(
sizeof(T)==0, THIS_SPARSE_BLOCK_SUBEXPRESSION_IS_READ_ONLY);
458 template<
typename ArgType,
int BlockRows,
int BlockCols,
bool InnerPanel>
459 struct unary_evaluator<Block<ArgType,BlockRows,BlockCols,InnerPanel>, IteratorBased >
460 :
public evaluator_base<Block<ArgType,BlockRows,BlockCols,InnerPanel> >
462 class InnerVectorInnerIterator;
463 class OuterVectorInnerIterator;
466 typedef typename XprType::StorageIndex StorageIndex;
467 typedef typename XprType::Scalar Scalar;
469 class ReverseInnerIterator;
472 IsRowMajor = XprType::IsRowMajor,
474 OuterVector = (BlockCols==1 && ArgType::IsRowMajor)
477 (BlockRows==1 && !ArgType::IsRowMajor),
479 CoeffReadCost = evaluator<ArgType>::CoeffReadCost,
480 Flags = XprType::Flags
483 typedef typename internal::conditional<OuterVector,OuterVectorInnerIterator,InnerVectorInnerIterator>::type InnerIterator;
485 explicit unary_evaluator(
const XprType& op)
486 : m_argImpl(op.nestedExpression()), m_block(op)
489 inline Index nonZerosEstimate()
const {
490 Index nnz = m_block.nonZeros();
492 return m_argImpl.nonZerosEstimate() * m_block.size() / m_block.nestedExpression().size();
497 typedef typename evaluator<ArgType>::InnerIterator EvalIterator;
499 evaluator<ArgType> m_argImpl;
500 const XprType &m_block;
503 template<
typename ArgType,
int BlockRows,
int BlockCols,
bool InnerPanel>
504 class unary_evaluator<Block<ArgType,BlockRows,BlockCols,InnerPanel>, IteratorBased>::InnerVectorInnerIterator
505 :
public EvalIterator
507 enum { IsRowMajor = unary_evaluator::IsRowMajor };
508 const XprType& m_block;
512 EIGEN_STRONG_INLINE InnerVectorInnerIterator(
const unary_evaluator& aEval,
Index outer)
513 : EvalIterator(aEval.m_argImpl, outer + (IsRowMajor ? aEval.m_block.startRow() : aEval.m_block.startCol())),
514 m_block(aEval.m_block),
515 m_end(IsRowMajor ? aEval.m_block.startCol()+aEval.m_block.blockCols() : aEval.m_block.startRow()+aEval.m_block.blockRows())
517 while( (EvalIterator::operator
bool()) && (EvalIterator::index() < (IsRowMajor ? m_block.startCol() : m_block.startRow())) )
518 EvalIterator::operator++();
521 inline StorageIndex index()
const {
return EvalIterator::index() - convert_index<StorageIndex>(IsRowMajor ? m_block.startCol() : m_block.startRow()); }
522 inline Index outer()
const {
return EvalIterator::outer() - (IsRowMajor ? m_block.startRow() : m_block.startCol()); }
523 inline Index row()
const {
return EvalIterator::row() - m_block.startRow(); }
524 inline Index col()
const {
return EvalIterator::col() - m_block.startCol(); }
526 inline operator bool()
const {
return EvalIterator::operator bool() && EvalIterator::index() < m_end; }
529 template<
typename ArgType,
int BlockRows,
int BlockCols,
bool InnerPanel>
530 class unary_evaluator<Block<ArgType,BlockRows,BlockCols,InnerPanel>, IteratorBased>::OuterVectorInnerIterator
532 enum { IsRowMajor = unary_evaluator::IsRowMajor };
533 const unary_evaluator& m_eval;
540 EIGEN_STRONG_INLINE OuterVectorInnerIterator(
const unary_evaluator& aEval,
Index outer)
542 m_outerPos( (IsRowMajor ? aEval.m_block.startCol() : aEval.m_block.startRow()) - 1),
543 m_innerIndex(IsRowMajor ? aEval.m_block.startRow() : aEval.m_block.startCol()),
545 m_end(IsRowMajor ? aEval.m_block.startCol()+aEval.m_block.blockCols() : aEval.m_block.startRow()+aEval.m_block.blockRows())
547 EIGEN_UNUSED_VARIABLE(outer);
548 eigen_assert(outer==0);
553 inline StorageIndex index()
const {
return convert_index<StorageIndex>(m_outerPos - (IsRowMajor ? m_eval.m_block.startCol() : m_eval.m_block.startRow())); }
554 inline Index outer()
const {
return 0; }
555 inline Index row()
const {
return IsRowMajor ? 0 : index(); }
556 inline Index col()
const {
return IsRowMajor ? index() : 0; }
558 inline Scalar value()
const {
return m_value; }
560 inline OuterVectorInnerIterator& operator++()
563 while(++m_outerPos<m_end)
565 EvalIterator it(m_eval.m_argImpl, m_outerPos);
567 while(it && it.index() < m_innerIndex) ++it;
568 if(it && it.index()==m_innerIndex)
570 m_value = it.value();
577 inline operator bool()
const {
return m_outerPos < m_end; }
580 template<
typename _Scalar,
int _Options,
typename _StorageIndex,
int BlockRows,
int BlockCols>
581 struct unary_evaluator<Block<SparseMatrix<_Scalar, _Options, _StorageIndex>,BlockRows,BlockCols,true>, IteratorBased>
582 : evaluator<SparseCompressedBase<Block<SparseMatrix<_Scalar, _Options, _StorageIndex>,BlockRows,BlockCols,true> > >
585 typedef evaluator<SparseCompressedBase<XprType> > Base;
586 explicit unary_evaluator(
const XprType &xpr) : Base(xpr) {}
589 template<
typename _Scalar,
int _Options,
typename _StorageIndex,
int BlockRows,
int BlockCols>
590 struct unary_evaluator<Block<const SparseMatrix<_Scalar, _Options, _StorageIndex>,BlockRows,BlockCols,true>, IteratorBased>
591 : evaluator<SparseCompressedBase<Block<const SparseMatrix<_Scalar, _Options, _StorageIndex>,BlockRows,BlockCols,true> > >
594 typedef evaluator<SparseCompressedBase<XprType> > Base;
595 explicit unary_evaluator(
const XprType &xpr) : Base(xpr) {}
603 #endif // EIGEN_SPARSE_BLOCK_H Namespace containing all symbols from the Eigen library.
Definition: Core:287
Eigen::Index Index
The interface type of indices.
Definition: EigenBase.h:37
BlockImpl(XprType &xpr, Index i)
Definition: SparseBlock.h:385
BlockImpl(XprType &xpr, Index startRow, Index startCol, Index blockRows, Index blockCols)
Definition: SparseBlock.h:395
Base class of any sparse matrices or sparse expressions.
Definition: ForwardDeclarations.h:281
EIGEN_DEFAULT_DENSE_INDEX_TYPE Index
The Index type as used for the API.
Definition: Meta.h:33
InnerVectorReturnType innerVector(Index outer)
Definition: SparseBlock.h:331
Definition: Constants.h:494
Definition: Eigen_Colamd.h:50
InnerVectorsReturnType innerVectors(Index outerStart, Index outerSize)
Definition: SparseBlock.h:346
Expression of a fixed-size or dynamic-size block.
Definition: Block.h:103
const int Dynamic
Definition: Constants.h:21