25 #ifndef EIGEN_SKYLINEMATRIX_H
26 #define EIGEN_SKYLINEMATRIX_H
28 #include "SkylineStorage.h"
29 #include "SkylineMatrixBase.h"
49 template<
typename _Scalar,
int _Options>
50 struct traits<SkylineMatrix<_Scalar, _Options> > {
51 typedef _Scalar Scalar;
52 typedef Sparse StorageKind;
59 Flags = SkylineBit | _Options,
60 CoeffReadCost = NumTraits<Scalar>::ReadCost,
65 template<
typename _Scalar,
int _Options>
73 using Base::IsRowMajor;
83 Index* m_colStartIndex;
84 Index* m_rowStartIndex;
89 inline Index
rows()
const {
90 return IsRowMajor ? m_outerSize : m_innerSize;
93 inline Index
cols()
const {
94 return IsRowMajor ? m_innerSize : m_outerSize;
105 inline Index upperNonZeros()
const {
106 return m_data.upperSize();
109 inline Index lowerNonZeros()
const {
110 return m_data.lowerSize();
113 inline Index upperNonZeros(Index j)
const {
114 return m_colStartIndex[j + 1] - m_colStartIndex[j];
117 inline Index lowerNonZeros(Index j)
const {
118 return m_rowStartIndex[j + 1] - m_rowStartIndex[j];
121 inline const Scalar* _diagPtr()
const {
122 return &m_data.diag(0);
125 inline Scalar* _diagPtr() {
126 return &m_data.diag(0);
129 inline const Scalar* _upperPtr()
const {
130 return &m_data.upper(0);
133 inline Scalar* _upperPtr() {
134 return &m_data.upper(0);
137 inline const Scalar* _lowerPtr()
const {
138 return &m_data.lower(0);
141 inline Scalar* _lowerPtr() {
142 return &m_data.lower(0);
145 inline const Index* _upperProfilePtr()
const {
146 return &m_data.upperProfile(0);
149 inline Index* _upperProfilePtr() {
150 return &m_data.upperProfile(0);
153 inline const Index* _lowerProfilePtr()
const {
154 return &m_data.lowerProfile(0);
157 inline Index* _lowerProfilePtr() {
158 return &m_data.lowerProfile(0);
161 inline Scalar coeff(Index row, Index col)
const {
162 const Index outer = IsRowMajor ? row : col;
163 const Index inner = IsRowMajor ? col : row;
169 return this->m_data.diag(outer);
174 const Index minOuterIndex = inner - m_data.upperProfile(inner);
175 if (outer >= minOuterIndex)
176 return this->m_data.upper(m_colStartIndex[inner] + outer - (inner - m_data.upperProfile(inner)));
182 const Index minInnerIndex = outer - m_data.lowerProfile(outer);
183 if (inner >= minInnerIndex)
184 return this->m_data.lower(m_rowStartIndex[outer] + inner - (outer - m_data.lowerProfile(outer)));
188 return m_data.upper(m_colStartIndex[inner] + outer - inner);
192 const Index maxOuterIndex = inner + m_data.upperProfile(inner);
193 if (outer <= maxOuterIndex)
194 return this->m_data.upper(m_colStartIndex[inner] + (outer - inner));
200 const Index maxInnerIndex = outer + m_data.lowerProfile(outer);
202 if (inner <= maxInnerIndex)
203 return this->m_data.lower(m_rowStartIndex[outer] + (inner - outer));
210 inline Scalar& coeffRef(Index row, Index col) {
211 const Index outer = IsRowMajor ? row : col;
212 const Index inner = IsRowMajor ? col : row;
218 return this->m_data.diag(outer);
223 const Index minOuterIndex = inner - m_data.upperProfile(inner);
224 eigen_assert(outer >= minOuterIndex &&
"you try to acces a coeff that do not exist in the storage");
225 return this->m_data.upper(m_colStartIndex[inner] + outer - (inner - m_data.upperProfile(inner)));
229 const Index minInnerIndex = outer - m_data.lowerProfile(outer);
230 eigen_assert(inner >= minInnerIndex &&
"you try to acces a coeff that do not exist in the storage");
231 return this->m_data.lower(m_rowStartIndex[outer] + inner - (outer - m_data.lowerProfile(outer)));
236 const Index maxOuterIndex = inner + m_data.upperProfile(inner);
237 eigen_assert(outer <= maxOuterIndex &&
"you try to acces a coeff that do not exist in the storage");
238 return this->m_data.upper(m_colStartIndex[inner] + (outer - inner));
242 const Index maxInnerIndex = outer + m_data.lowerProfile(outer);
243 eigen_assert(inner <= maxInnerIndex &&
"you try to acces a coeff that do not exist in the storage");
244 return this->m_data.lower(m_rowStartIndex[outer] + (inner - outer));
249 inline Scalar coeffDiag(Index idx)
const {
252 return this->m_data.diag(idx);
255 inline Scalar coeffLower(Index row, Index col)
const {
256 const Index outer = IsRowMajor ? row : col;
257 const Index inner = IsRowMajor ? col : row;
261 eigen_assert(inner != outer);
264 const Index minInnerIndex = outer - m_data.lowerProfile(outer);
265 if (inner >= minInnerIndex)
266 return this->m_data.lower(m_rowStartIndex[outer] + inner - (outer - m_data.lowerProfile(outer)));
271 const Index maxInnerIndex = outer + m_data.lowerProfile(outer);
272 if (inner <= maxInnerIndex)
273 return this->m_data.lower(m_rowStartIndex[outer] + (inner - outer));
279 inline Scalar coeffUpper(Index row, Index col)
const {
280 const Index outer = IsRowMajor ? row : col;
281 const Index inner = IsRowMajor ? col : row;
285 eigen_assert(inner != outer);
288 const Index minOuterIndex = inner - m_data.upperProfile(inner);
289 if (outer >= minOuterIndex)
290 return this->m_data.upper(m_colStartIndex[inner] + outer - (inner - m_data.upperProfile(inner)));
294 const Index maxOuterIndex = inner + m_data.upperProfile(inner);
295 if (outer <= maxOuterIndex)
296 return this->m_data.upper(m_colStartIndex[inner] + (outer - inner));
302 inline Scalar& coeffRefDiag(Index idx) {
305 return this->m_data.diag(idx);
308 inline Scalar& coeffRefLower(Index row, Index col) {
309 const Index outer = IsRowMajor ? row : col;
310 const Index inner = IsRowMajor ? col : row;
314 eigen_assert(inner != outer);
317 const Index minInnerIndex = outer - m_data.lowerProfile(outer);
318 eigen_assert(inner >= minInnerIndex &&
"you try to acces a coeff that do not exist in the storage");
319 return this->m_data.lower(m_rowStartIndex[outer] + inner - (outer - m_data.lowerProfile(outer)));
321 const Index maxInnerIndex = outer + m_data.lowerProfile(outer);
322 eigen_assert(inner <= maxInnerIndex &&
"you try to acces a coeff that do not exist in the storage");
323 return this->m_data.lower(m_rowStartIndex[outer] + (inner - outer));
327 inline bool coeffExistLower(Index row, Index col) {
328 const Index outer = IsRowMajor ? row : col;
329 const Index inner = IsRowMajor ? col : row;
333 eigen_assert(inner != outer);
336 const Index minInnerIndex = outer - m_data.lowerProfile(outer);
337 return inner >= minInnerIndex;
339 const Index maxInnerIndex = outer + m_data.lowerProfile(outer);
340 return inner <= maxInnerIndex;
344 inline Scalar& coeffRefUpper(Index row, Index col) {
345 const Index outer = IsRowMajor ? row : col;
346 const Index inner = IsRowMajor ? col : row;
350 eigen_assert(inner != outer);
353 const Index minOuterIndex = inner - m_data.upperProfile(inner);
354 eigen_assert(outer >= minOuterIndex &&
"you try to acces a coeff that do not exist in the storage");
355 return this->m_data.upper(m_colStartIndex[inner] + outer - (inner - m_data.upperProfile(inner)));
357 const Index maxOuterIndex = inner + m_data.upperProfile(inner);
358 eigen_assert(outer <= maxOuterIndex &&
"you try to acces a coeff that do not exist in the storage");
359 return this->m_data.upper(m_colStartIndex[inner] + (outer - inner));
363 inline bool coeffExistUpper(Index row, Index col) {
364 const Index outer = IsRowMajor ? row : col;
365 const Index inner = IsRowMajor ? col : row;
369 eigen_assert(inner != outer);
372 const Index minOuterIndex = inner - m_data.upperProfile(inner);
373 return outer >= minOuterIndex;
375 const Index maxOuterIndex = inner + m_data.upperProfile(inner);
376 return outer <= maxOuterIndex;
384 class InnerUpperIterator;
385 class InnerLowerIterator;
387 class OuterUpperIterator;
388 class OuterLowerIterator;
393 memset(m_colStartIndex, 0, (m_outerSize + 1) *
sizeof (Index));
394 memset(m_rowStartIndex, 0, (m_outerSize + 1) *
sizeof (Index));
399 return m_data.diagSize() + m_data.upperSize() + m_data.lowerSize();
403 inline void reserve(Index reserveSize, Index reserveUpperSize, Index reserveLowerSize) {
404 m_data.reserve(reserveSize, reserveUpperSize, reserveLowerSize);
415 EIGEN_DONT_INLINE Scalar &
insert(Index row, Index col) {
416 const Index outer = IsRowMajor ? row : col;
417 const Index inner = IsRowMajor ? col : row;
423 return m_data.diag(col);
428 Index minOuterIndex = 0;
429 minOuterIndex = inner - m_data.upperProfile(inner);
431 if (outer < minOuterIndex)
433 const Index previousProfile = m_data.upperProfile(inner);
435 m_data.upperProfile(inner) = inner - outer;
438 const Index bandIncrement = m_data.upperProfile(inner) - previousProfile;
440 const Index stop = m_colStartIndex[
cols()];
441 const Index start = m_colStartIndex[inner];
444 for (Index innerIdx = stop; innerIdx >= start; innerIdx--) {
445 m_data.upper(innerIdx + bandIncrement) = m_data.upper(innerIdx);
448 for (Index innerIdx =
cols(); innerIdx > inner; innerIdx--) {
449 m_colStartIndex[innerIdx] += bandIncrement;
453 memset(this->_upperPtr() + start, 0, (bandIncrement - 1) *
sizeof (Scalar));
455 return m_data.upper(m_colStartIndex[inner]);
457 return m_data.upper(m_colStartIndex[inner] + outer - (inner - m_data.upperProfile(inner)));
463 const Index minInnerIndex = outer - m_data.lowerProfile(outer);
464 if (inner < minInnerIndex)
466 const Index previousProfile = m_data.lowerProfile(outer);
467 m_data.lowerProfile(outer) = outer - inner;
469 const Index bandIncrement = m_data.lowerProfile(outer) - previousProfile;
471 const Index stop = m_rowStartIndex[
rows()];
472 const Index start = m_rowStartIndex[outer];
475 for (Index innerIdx = stop; innerIdx >= start; innerIdx--) {
476 m_data.lower(innerIdx + bandIncrement) = m_data.lower(innerIdx);
479 for (Index innerIdx =
rows(); innerIdx > outer; innerIdx--) {
480 m_rowStartIndex[innerIdx] += bandIncrement;
484 memset(this->_lowerPtr() + start, 0, (bandIncrement - 1) *
sizeof (Scalar));
485 return m_data.lower(m_rowStartIndex[outer]);
487 return m_data.lower(m_rowStartIndex[outer] + inner - (outer - m_data.lowerProfile(outer)));
493 const Index maxOuterIndex = inner + m_data.upperProfile(inner);
494 if (outer > maxOuterIndex)
496 const Index previousProfile = m_data.upperProfile(inner);
497 m_data.upperProfile(inner) = outer - inner;
499 const Index bandIncrement = m_data.upperProfile(inner) - previousProfile;
501 const Index stop = m_rowStartIndex[
rows()];
502 const Index start = m_rowStartIndex[inner + 1];
504 for (Index innerIdx = stop; innerIdx >= start; innerIdx--) {
505 m_data.upper(innerIdx + bandIncrement) = m_data.upper(innerIdx);
508 for (Index innerIdx = inner + 1; innerIdx <
outerSize() + 1; innerIdx++) {
509 m_rowStartIndex[innerIdx] += bandIncrement;
511 memset(this->_upperPtr() + m_rowStartIndex[inner] + previousProfile + 1, 0, (bandIncrement - 1) *
sizeof (Scalar));
512 return m_data.upper(m_rowStartIndex[inner] + m_data.upperProfile(inner));
514 return m_data.upper(m_rowStartIndex[inner] + (outer - inner));
520 const Index maxInnerIndex = outer + m_data.lowerProfile(outer);
521 if (inner > maxInnerIndex)
523 const Index previousProfile = m_data.lowerProfile(outer);
524 m_data.lowerProfile(outer) = inner - outer;
526 const Index bandIncrement = m_data.lowerProfile(outer) - previousProfile;
528 const Index stop = m_colStartIndex[
cols()];
529 const Index start = m_colStartIndex[outer + 1];
531 for (Index innerIdx = stop; innerIdx >= start; innerIdx--) {
532 m_data.lower(innerIdx + bandIncrement) = m_data.lower(innerIdx);
535 for (Index innerIdx = outer + 1; innerIdx <
outerSize() + 1; innerIdx++) {
536 m_colStartIndex[innerIdx] += bandIncrement;
538 memset(this->_lowerPtr() + m_colStartIndex[outer] + previousProfile + 1, 0, (bandIncrement - 1) *
sizeof (Scalar));
539 return m_data.lower(m_colStartIndex[outer] + m_data.lowerProfile(outer));
541 return m_data.lower(m_colStartIndex[outer] + (inner - outer));
552 m_data.resize(
cols(),
cols(),
rows(), m_colStartIndex[
cols()] + 1, m_rowStartIndex[
rows()] + 1);
554 m_data.resize(
rows(),
cols(),
rows(), m_colStartIndex[
cols()] + 1, m_rowStartIndex[
rows()] + 1);
586 m_data.resize(
cols(),
rows(),
cols(), m_rowStartIndex[
cols()] + 1, m_colStartIndex[
cols()] + 1);
588 m_data.resize(
rows(),
rows(),
cols(), m_rowStartIndex[
rows()] + 1, m_colStartIndex[
rows()] + 1);
592 inline void squeeze() {
597 void prune(Scalar reference, RealScalar epsilon = dummy_precision<RealScalar > ()) {
605 const Index diagSize = rows > cols ? cols :
rows;
606 m_innerSize = IsRowMajor ? cols :
rows;
608 eigen_assert(rows == cols &&
"Skyline matrix must be square matrix");
611 const Index k = (diagSize - 1) / 2;
613 m_data.resize(diagSize, IsRowMajor ? cols : rows, IsRowMajor ? rows : cols,
619 const Index k = diagSize / 2;
620 m_data.resize(diagSize, IsRowMajor ? cols : rows, IsRowMajor ? rows : cols,
625 if (m_colStartIndex && m_rowStartIndex) {
626 delete[] m_colStartIndex;
627 delete[] m_rowStartIndex;
629 m_colStartIndex =
new Index [cols + 1];
630 m_rowStartIndex =
new Index [rows + 1];
631 m_outerSize = diagSize;
636 m_outerSize = diagSize;
637 memset(m_colStartIndex, 0, (cols + 1) *
sizeof (Index));
638 memset(m_rowStartIndex, 0, (rows + 1) *
sizeof (Index));
641 void resizeNonZeros(Index
size) {
645 inline SkylineMatrix()
646 : m_outerSize(-1), m_innerSize(0), m_colStartIndex(0), m_rowStartIndex(0) {
650 inline SkylineMatrix(
size_t rows,
size_t cols)
651 : m_outerSize(0), m_innerSize(0), m_colStartIndex(0), m_rowStartIndex(0) {
655 template<
typename OtherDerived>
656 inline SkylineMatrix(
const SkylineMatrixBase<OtherDerived>& other)
657 : m_outerSize(0), m_innerSize(0), m_colStartIndex(0), m_rowStartIndex(0) {
658 *
this = other.derived();
661 inline SkylineMatrix(
const SkylineMatrix & other)
662 : Base(), m_outerSize(0), m_innerSize(0), m_colStartIndex(0), m_rowStartIndex(0) {
663 *
this = other.derived();
666 inline void swap(SkylineMatrix & other) {
668 std::swap(m_colStartIndex, other.m_colStartIndex);
669 std::swap(m_rowStartIndex, other.m_rowStartIndex);
670 std::swap(m_innerSize, other.m_innerSize);
671 std::swap(m_outerSize, other.m_outerSize);
672 m_data.swap(other.m_data);
675 inline SkylineMatrix & operator=(
const SkylineMatrix & other) {
676 std::cout <<
"SkylineMatrix& operator=(const SkylineMatrix& other)\n";
677 if (other.isRValue()) {
678 swap(other.const_cast_derived());
680 resize(other.rows(), other.cols());
681 memcpy(m_colStartIndex, other.m_colStartIndex, (m_outerSize + 1) * sizeof (Index));
682 memcpy(m_rowStartIndex, other.m_rowStartIndex, (m_outerSize + 1) * sizeof (Index));
683 m_data = other.m_data;
688 template<
typename OtherDerived>
689 inline SkylineMatrix & operator=(
const SkylineMatrixBase<OtherDerived>& other) {
690 const bool needToTranspose = (
Flags &
RowMajorBit) != (OtherDerived::Flags & RowMajorBit);
691 if (needToTranspose) {
696 return SkylineMatrixBase<SkylineMatrix>::operator=(other.derived());
700 friend std::ostream & operator <<(std::ostream & s,
const SkylineMatrix & m) {
703 std::cout <<
"upper elements : " << std::endl;
704 for (Index i = 0; i < m.m_data.upperSize(); i++)
705 std::cout << m.m_data.upper(i) <<
"\t";
706 std::cout << std::endl;
707 std::cout <<
"upper profile : " << std::endl;
708 for (Index i = 0; i < m.m_data.upperProfileSize(); i++)
709 std::cout << m.m_data.upperProfile(i) <<
"\t";
710 std::cout << std::endl;
711 std::cout <<
"lower startIdx : " << std::endl;
712 for (Index i = 0; i < m.m_data.upperProfileSize(); i++)
713 std::cout << (IsRowMajor ? m.m_colStartIndex[i] : m.m_rowStartIndex[i]) <<
"\t";
714 std::cout << std::endl;
717 std::cout <<
"lower elements : " << std::endl;
718 for (Index i = 0; i < m.m_data.lowerSize(); i++)
719 std::cout << m.m_data.lower(i) <<
"\t";
720 std::cout << std::endl;
721 std::cout <<
"lower profile : " << std::endl;
722 for (Index i = 0; i < m.m_data.lowerProfileSize(); i++)
723 std::cout << m.m_data.lowerProfile(i) <<
"\t";
724 std::cout << std::endl;
725 std::cout <<
"lower startIdx : " << std::endl;
726 for (Index i = 0; i < m.m_data.lowerProfileSize(); i++)
727 std::cout << (IsRowMajor ? m.m_rowStartIndex[i] : m.m_colStartIndex[i]) <<
"\t";
728 std::cout << std::endl;
730 for (Index rowIdx = 0; rowIdx < m.rows(); rowIdx++) {
731 for (Index colIdx = 0; colIdx < m.cols(); colIdx++) {
732 s << m.coeff(rowIdx, colIdx) <<
"\t";
741 delete[] m_colStartIndex;
742 delete[] m_rowStartIndex;
749 template<
typename Scalar,
int _Options>
750 class SkylineMatrix<Scalar, _Options>::InnerUpperIterator {
753 InnerUpperIterator(
const SkylineMatrix& mat, Index outer)
754 : m_matrix(mat), m_outer(outer),
755 m_id(_Options ==
RowMajor ? mat.m_colStartIndex[outer] : mat.m_rowStartIndex[outer] + 1),
757 m_end(_Options ==
RowMajor ? mat.m_colStartIndex[outer + 1] : mat.m_rowStartIndex[outer + 1] + 1) {
760 inline InnerUpperIterator & operator++() {
765 inline InnerUpperIterator & operator+=(Index shift) {
770 inline Scalar value()
const {
771 return m_matrix.m_data.upper(m_id);
774 inline Scalar* valuePtr() {
775 return const_cast<Scalar*
> (&(m_matrix.m_data.upper(m_id)));
778 inline Scalar& valueRef() {
779 return const_cast<Scalar&
> (m_matrix.m_data.upper(m_id));
782 inline Index index()
const {
783 return IsRowMajor ? m_outer - m_matrix.m_data.upperProfile(m_outer) + (m_id - m_start) :
784 m_outer + (m_id - m_start) + 1;
787 inline Index row()
const {
788 return IsRowMajor ? index() : m_outer;
791 inline Index col()
const {
792 return IsRowMajor ? m_outer : index();
795 inline size_t size()
const {
796 return m_matrix.m_data.upperProfile(m_outer);
799 inline operator bool()
const {
800 return (m_id < m_end) && (m_id >= m_start);
804 const SkylineMatrix& m_matrix;
811 template<
typename Scalar,
int _Options>
812 class SkylineMatrix<Scalar, _Options>::InnerLowerIterator {
815 InnerLowerIterator(
const SkylineMatrix& mat, Index outer)
818 m_id(_Options ==
RowMajor ? mat.m_rowStartIndex[outer] : mat.m_colStartIndex[outer] + 1),
820 m_end(_Options ==
RowMajor ? mat.m_rowStartIndex[outer + 1] : mat.m_colStartIndex[outer + 1] + 1) {
823 inline InnerLowerIterator & operator++() {
828 inline InnerLowerIterator & operator+=(Index shift) {
833 inline Scalar value()
const {
834 return m_matrix.m_data.lower(m_id);
837 inline Scalar* valuePtr() {
838 return const_cast<Scalar*
> (&(m_matrix.m_data.lower(m_id)));
841 inline Scalar& valueRef() {
842 return const_cast<Scalar&
> (m_matrix.m_data.lower(m_id));
845 inline Index index()
const {
846 return IsRowMajor ? m_outer - m_matrix.m_data.lowerProfile(m_outer) + (m_id - m_start) :
847 m_outer + (m_id - m_start) + 1;
851 inline Index row()
const {
852 return IsRowMajor ? m_outer : index();
855 inline Index col()
const {
856 return IsRowMajor ? index() : m_outer;
859 inline size_t size()
const {
860 return m_matrix.m_data.lowerProfile(m_outer);
863 inline operator bool()
const {
864 return (m_id < m_end) && (m_id >= m_start);
868 const SkylineMatrix& m_matrix;
877 #endif // EIGEN_SkylineMatrix_H