Eigen  3.2.10
 
Loading...
Searching...
No Matches
BlockMethods.h
1// This file is part of Eigen, a lightweight C++ template library
2// for linear algebra.
3//
4// Copyright (C) 2008-2010 Gael Guennebaud <gael.guennebaud@inria.fr>
5// Copyright (C) 2006-2010 Benoit Jacob <jacob.benoit.1@gmail.com>
6//
7// This Source Code Form is subject to the terms of the Mozilla
8// Public License v. 2.0. If a copy of the MPL was not distributed
9// with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
10
11
12#ifndef EIGEN_PARSED_BY_DOXYGEN
13
15typedef Block<Derived, internal::traits<Derived>::RowsAtCompileTime, 1, !IsRowMajor> ColXpr;
16typedef const Block<const Derived, internal::traits<Derived>::RowsAtCompileTime, 1, !IsRowMajor> ConstColXpr;
18typedef Block<Derived, 1, internal::traits<Derived>::ColsAtCompileTime, IsRowMajor> RowXpr;
19typedef const Block<const Derived, 1, internal::traits<Derived>::ColsAtCompileTime, IsRowMajor> ConstRowXpr;
21typedef Block<Derived, internal::traits<Derived>::RowsAtCompileTime, Dynamic, !IsRowMajor> ColsBlockXpr;
22typedef const Block<const Derived, internal::traits<Derived>::RowsAtCompileTime, Dynamic, !IsRowMajor> ConstColsBlockXpr;
24typedef Block<Derived, Dynamic, internal::traits<Derived>::ColsAtCompileTime, IsRowMajor> RowsBlockXpr;
25typedef const Block<const Derived, Dynamic, internal::traits<Derived>::ColsAtCompileTime, IsRowMajor> ConstRowsBlockXpr;
27template<int N> struct NColsBlockXpr { typedef Block<Derived, internal::traits<Derived>::RowsAtCompileTime, N, !IsRowMajor> Type; };
28template<int N> struct ConstNColsBlockXpr { typedef const Block<const Derived, internal::traits<Derived>::RowsAtCompileTime, N, !IsRowMajor> Type; };
30template<int N> struct NRowsBlockXpr { typedef Block<Derived, N, internal::traits<Derived>::ColsAtCompileTime, IsRowMajor> Type; };
31template<int N> struct ConstNRowsBlockXpr { typedef const Block<const Derived, N, internal::traits<Derived>::ColsAtCompileTime, IsRowMajor> Type; };
32
33typedef VectorBlock<Derived> SegmentReturnType;
34typedef const VectorBlock<const Derived> ConstSegmentReturnType;
35template<int Size> struct FixedSegmentReturnType { typedef VectorBlock<Derived, Size> Type; };
36template<int Size> struct ConstFixedSegmentReturnType { typedef const VectorBlock<const Derived, Size> Type; };
37
38#endif // not EIGEN_PARSED_BY_DOXYGEN
39
56inline Block<Derived> block(Index startRow, Index startCol, Index blockRows, Index blockCols)
57{
58 return Block<Derived>(derived(), startRow, startCol, blockRows, blockCols);
59}
60
62inline const Block<const Derived> block(Index startRow, Index startCol, Index blockRows, Index blockCols) const
63{
64 return Block<const Derived>(derived(), startRow, startCol, blockRows, blockCols);
65}
66
67
68
69
80inline Block<Derived> topRightCorner(Index cRows, Index cCols)
81{
82 return Block<Derived>(derived(), 0, cols() - cCols, cRows, cCols);
83}
84
86inline const Block<const Derived> topRightCorner(Index cRows, Index cCols) const
87{
88 return Block<const Derived>(derived(), 0, cols() - cCols, cRows, cCols);
89}
90
101template<int CRows, int CCols>
102inline Block<Derived, CRows, CCols> topRightCorner()
103{
104 return Block<Derived, CRows, CCols>(derived(), 0, cols() - CCols);
105}
106
108template<int CRows, int CCols>
109inline const Block<const Derived, CRows, CCols> topRightCorner() const
110{
111 return Block<const Derived, CRows, CCols>(derived(), 0, cols() - CCols);
112}
113
131template<int CRows, int CCols>
132inline Block<Derived, CRows, CCols> topRightCorner(Index cRows, Index cCols)
133{
134 return Block<Derived, CRows, CCols>(derived(), 0, cols() - cCols, cRows, cCols);
135}
136
138template<int CRows, int CCols>
139inline const Block<const Derived, CRows, CCols> topRightCorner(Index cRows, Index cCols) const
140{
141 return Block<const Derived, CRows, CCols>(derived(), 0, cols() - cCols, cRows, cCols);
142}
143
144
145
156inline Block<Derived> topLeftCorner(Index cRows, Index cCols)
157{
158 return Block<Derived>(derived(), 0, 0, cRows, cCols);
159}
160
162inline const Block<const Derived> topLeftCorner(Index cRows, Index cCols) const
163{
164 return Block<const Derived>(derived(), 0, 0, cRows, cCols);
165}
166
176template<int CRows, int CCols>
177inline Block<Derived, CRows, CCols> topLeftCorner()
178{
179 return Block<Derived, CRows, CCols>(derived(), 0, 0);
180}
181
183template<int CRows, int CCols>
184inline const Block<const Derived, CRows, CCols> topLeftCorner() const
185{
186 return Block<const Derived, CRows, CCols>(derived(), 0, 0);
187}
188
206template<int CRows, int CCols>
207inline Block<Derived, CRows, CCols> topLeftCorner(Index cRows, Index cCols)
208{
209 return Block<Derived, CRows, CCols>(derived(), 0, 0, cRows, cCols);
210}
211
213template<int CRows, int CCols>
214inline const Block<const Derived, CRows, CCols> topLeftCorner(Index cRows, Index cCols) const
215{
216 return Block<const Derived, CRows, CCols>(derived(), 0, 0, cRows, cCols);
217}
218
219
220
231inline Block<Derived> bottomRightCorner(Index cRows, Index cCols)
232{
233 return Block<Derived>(derived(), rows() - cRows, cols() - cCols, cRows, cCols);
234}
235
237inline const Block<const Derived> bottomRightCorner(Index cRows, Index cCols) const
238{
239 return Block<const Derived>(derived(), rows() - cRows, cols() - cCols, cRows, cCols);
240}
241
251template<int CRows, int CCols>
252inline Block<Derived, CRows, CCols> bottomRightCorner()
253{
254 return Block<Derived, CRows, CCols>(derived(), rows() - CRows, cols() - CCols);
255}
256
258template<int CRows, int CCols>
259inline const Block<const Derived, CRows, CCols> bottomRightCorner() const
260{
261 return Block<const Derived, CRows, CCols>(derived(), rows() - CRows, cols() - CCols);
262}
263
281template<int CRows, int CCols>
282inline Block<Derived, CRows, CCols> bottomRightCorner(Index cRows, Index cCols)
283{
284 return Block<Derived, CRows, CCols>(derived(), rows() - cRows, cols() - cCols, cRows, cCols);
285}
286
288template<int CRows, int CCols>
289inline const Block<const Derived, CRows, CCols> bottomRightCorner(Index cRows, Index cCols) const
290{
291 return Block<const Derived, CRows, CCols>(derived(), rows() - cRows, cols() - cCols, cRows, cCols);
292}
293
294
295
306inline Block<Derived> bottomLeftCorner(Index cRows, Index cCols)
307{
308 return Block<Derived>(derived(), rows() - cRows, 0, cRows, cCols);
309}
310
312inline const Block<const Derived> bottomLeftCorner(Index cRows, Index cCols) const
313{
314 return Block<const Derived>(derived(), rows() - cRows, 0, cRows, cCols);
315}
316
326template<int CRows, int CCols>
327inline Block<Derived, CRows, CCols> bottomLeftCorner()
328{
329 return Block<Derived, CRows, CCols>(derived(), rows() - CRows, 0);
330}
331
333template<int CRows, int CCols>
334inline const Block<const Derived, CRows, CCols> bottomLeftCorner() const
335{
336 return Block<const Derived, CRows, CCols>(derived(), rows() - CRows, 0);
337}
338
356template<int CRows, int CCols>
357inline Block<Derived, CRows, CCols> bottomLeftCorner(Index cRows, Index cCols)
358{
359 return Block<Derived, CRows, CCols>(derived(), rows() - cRows, 0, cRows, cCols);
360}
361
363template<int CRows, int CCols>
364inline const Block<const Derived, CRows, CCols> bottomLeftCorner(Index cRows, Index cCols) const
365{
366 return Block<const Derived, CRows, CCols>(derived(), rows() - cRows, 0, cRows, cCols);
367}
368
369
370
380inline RowsBlockXpr topRows(Index n)
381{
382 return RowsBlockXpr(derived(), 0, 0, n, cols());
383}
384
386inline ConstRowsBlockXpr topRows(Index n) const
387{
388 return ConstRowsBlockXpr(derived(), 0, 0, n, cols());
389}
390
404template<int N>
405inline typename NRowsBlockXpr<N>::Type topRows(Index n = N)
406{
407 return typename NRowsBlockXpr<N>::Type(derived(), 0, 0, n, cols());
408}
409
411template<int N>
412inline typename ConstNRowsBlockXpr<N>::Type topRows(Index n = N) const
413{
414 return typename ConstNRowsBlockXpr<N>::Type(derived(), 0, 0, n, cols());
415}
416
417
418
428inline RowsBlockXpr bottomRows(Index n)
429{
430 return RowsBlockXpr(derived(), rows() - n, 0, n, cols());
431}
432
434inline ConstRowsBlockXpr bottomRows(Index n) const
435{
436 return ConstRowsBlockXpr(derived(), rows() - n, 0, n, cols());
437}
438
452template<int N>
453inline typename NRowsBlockXpr<N>::Type bottomRows(Index n = N)
454{
455 return typename NRowsBlockXpr<N>::Type(derived(), rows() - n, 0, n, cols());
456}
457
459template<int N>
460inline typename ConstNRowsBlockXpr<N>::Type bottomRows(Index n = N) const
461{
462 return typename ConstNRowsBlockXpr<N>::Type(derived(), rows() - n, 0, n, cols());
463}
464
465
466
477inline RowsBlockXpr middleRows(Index startRow, Index n)
478{
479 return RowsBlockXpr(derived(), startRow, 0, n, cols());
480}
481
483inline ConstRowsBlockXpr middleRows(Index startRow, Index n) const
484{
485 return ConstRowsBlockXpr(derived(), startRow, 0, n, cols());
486}
487
502template<int N>
503inline typename NRowsBlockXpr<N>::Type middleRows(Index startRow, Index n = N)
504{
505 return typename NRowsBlockXpr<N>::Type(derived(), startRow, 0, n, cols());
506}
507
509template<int N>
510inline typename ConstNRowsBlockXpr<N>::Type middleRows(Index startRow, Index n = N) const
511{
512 return typename ConstNRowsBlockXpr<N>::Type(derived(), startRow, 0, n, cols());
513}
514
515
516
526inline ColsBlockXpr leftCols(Index n)
527{
528 return ColsBlockXpr(derived(), 0, 0, rows(), n);
529}
530
532inline ConstColsBlockXpr leftCols(Index n) const
533{
534 return ConstColsBlockXpr(derived(), 0, 0, rows(), n);
535}
536
550template<int N>
551inline typename NColsBlockXpr<N>::Type leftCols(Index n = N)
552{
553 return typename NColsBlockXpr<N>::Type(derived(), 0, 0, rows(), n);
554}
555
557template<int N>
558inline typename ConstNColsBlockXpr<N>::Type leftCols(Index n = N) const
559{
560 return typename ConstNColsBlockXpr<N>::Type(derived(), 0, 0, rows(), n);
561}
562
563
564
574inline ColsBlockXpr rightCols(Index n)
575{
576 return ColsBlockXpr(derived(), 0, cols() - n, rows(), n);
577}
578
580inline ConstColsBlockXpr rightCols(Index n) const
581{
582 return ConstColsBlockXpr(derived(), 0, cols() - n, rows(), n);
583}
584
598template<int N>
599inline typename NColsBlockXpr<N>::Type rightCols(Index n = N)
600{
601 return typename NColsBlockXpr<N>::Type(derived(), 0, cols() - n, rows(), n);
602}
603
605template<int N>
606inline typename ConstNColsBlockXpr<N>::Type rightCols(Index n = N) const
607{
608 return typename ConstNColsBlockXpr<N>::Type(derived(), 0, cols() - n, rows(), n);
609}
610
611
612
623inline ColsBlockXpr middleCols(Index startCol, Index numCols)
624{
625 return ColsBlockXpr(derived(), 0, startCol, rows(), numCols);
626}
627
629inline ConstColsBlockXpr middleCols(Index startCol, Index numCols) const
630{
631 return ConstColsBlockXpr(derived(), 0, startCol, rows(), numCols);
632}
633
648template<int N>
649inline typename NColsBlockXpr<N>::Type middleCols(Index startCol, Index n = N)
650{
651 return typename NColsBlockXpr<N>::Type(derived(), 0, startCol, rows(), n);
652}
653
655template<int N>
656inline typename ConstNColsBlockXpr<N>::Type middleCols(Index startCol, Index n = N) const
657{
658 return typename ConstNColsBlockXpr<N>::Type(derived(), 0, startCol, rows(), n);
659}
660
661
662
679template<int BlockRows, int BlockCols>
680inline Block<Derived, BlockRows, BlockCols> block(Index startRow, Index startCol)
681{
682 return Block<Derived, BlockRows, BlockCols>(derived(), startRow, startCol);
683}
684
686template<int BlockRows, int BlockCols>
687inline const Block<const Derived, BlockRows, BlockCols> block(Index startRow, Index startCol) const
688{
689 return Block<const Derived, BlockRows, BlockCols>(derived(), startRow, startCol);
690}
691
711template<int BlockRows, int BlockCols>
712inline Block<Derived, BlockRows, BlockCols> block(Index startRow, Index startCol,
713 Index blockRows, Index blockCols)
714{
715 return Block<Derived, BlockRows, BlockCols>(derived(), startRow, startCol, blockRows, blockCols);
716}
717
719template<int BlockRows, int BlockCols>
720inline const Block<const Derived, BlockRows, BlockCols> block(Index startRow, Index startCol,
721 Index blockRows, Index blockCols) const
722{
723 return Block<const Derived, BlockRows, BlockCols>(derived(), startRow, startCol, blockRows, blockCols);
724}
725
732inline ColXpr col(Index i)
733{
734 return ColXpr(derived(), i);
735}
736
738inline ConstColXpr col(Index i) const
739{
740 return ConstColXpr(derived(), i);
741}
742
749inline RowXpr row(Index i)
750{
751 return RowXpr(derived(), i);
752}
753
755inline ConstRowXpr row(Index i) const
756{
757 return ConstRowXpr(derived(), i);
758}
759
776inline SegmentReturnType segment(Index start, Index n)
777{
778 EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived)
779 return SegmentReturnType(derived(), start, n);
780}
781
782
784inline ConstSegmentReturnType segment(Index start, Index n) const
785{
786 EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived)
787 return ConstSegmentReturnType(derived(), start, n);
788}
789
805inline SegmentReturnType head(Index n)
806{
807 EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived)
808 return SegmentReturnType(derived(), 0, n);
809}
810
812inline ConstSegmentReturnType head(Index n) const
813{
814 EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived)
815 return ConstSegmentReturnType(derived(), 0, n);
816}
817
833inline SegmentReturnType tail(Index n)
834{
835 EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived)
836 return SegmentReturnType(derived(), this->size() - n, n);
837}
838
840inline ConstSegmentReturnType tail(Index n) const
841{
842 EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived)
843 return ConstSegmentReturnType(derived(), this->size() - n, n);
844}
845
862template<int N>
863inline typename FixedSegmentReturnType<N>::Type segment(Index start, Index n = N)
864{
865 EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived)
866 return typename FixedSegmentReturnType<N>::Type(derived(), start, n);
867}
868
870template<int N>
871inline typename ConstFixedSegmentReturnType<N>::Type segment(Index start, Index n = N) const
872{
873 EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived)
874 return typename ConstFixedSegmentReturnType<N>::Type(derived(), start, n);
875}
876
892template<int N>
893inline typename FixedSegmentReturnType<N>::Type head(Index n = N)
894{
895 EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived)
896 return typename FixedSegmentReturnType<N>::Type(derived(), 0, n);
897}
898
900template<int N>
901inline typename ConstFixedSegmentReturnType<N>::Type head(Index n = N) const
902{
903 EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived)
904 return typename ConstFixedSegmentReturnType<N>::Type(derived(), 0, n);
905}
906
922template<int N>
923inline typename FixedSegmentReturnType<N>::Type tail(Index n = N)
924{
925 EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived)
926 return typename FixedSegmentReturnType<N>::Type(derived(), size() - n);
927}
928
930template<int N>
931inline typename ConstFixedSegmentReturnType<N>::Type tail(Index n = N) const
932{
933 EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived)
934 return typename ConstFixedSegmentReturnType<N>::Type(derived(), size() - n);
935}