BlockMethods.h 33.6 KB
Newer Older
LM's avatar
LM committed
1 2 3 4 5 6
// This file is part of Eigen, a lightweight C++ template library
// for linear algebra.
//
// Copyright (C) 2008-2010 Gael Guennebaud <gael.guennebaud@inria.fr>
// Copyright (C) 2006-2010 Benoit Jacob <jacob.benoit.1@gmail.com>
//
Don Gagne's avatar
Don Gagne committed
7 8 9
// This Source Code Form is subject to the terms of the Mozilla
// Public License v. 2.0. If a copy of the MPL was not distributed
// with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
LM's avatar
LM committed
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32


#ifndef EIGEN_PARSED_BY_DOXYGEN

/** \internal expression type of a column */
typedef Block<Derived, internal::traits<Derived>::RowsAtCompileTime, 1, !IsRowMajor> ColXpr;
typedef const Block<const Derived, internal::traits<Derived>::RowsAtCompileTime, 1, !IsRowMajor> ConstColXpr;
/** \internal expression type of a row */
typedef Block<Derived, 1, internal::traits<Derived>::ColsAtCompileTime, IsRowMajor> RowXpr;
typedef const Block<const Derived, 1, internal::traits<Derived>::ColsAtCompileTime, IsRowMajor> ConstRowXpr;
/** \internal expression type of a block of whole columns */
typedef Block<Derived, internal::traits<Derived>::RowsAtCompileTime, Dynamic, !IsRowMajor> ColsBlockXpr;
typedef const Block<const Derived, internal::traits<Derived>::RowsAtCompileTime, Dynamic, !IsRowMajor> ConstColsBlockXpr;
/** \internal expression type of a block of whole rows */
typedef Block<Derived, Dynamic, internal::traits<Derived>::ColsAtCompileTime, IsRowMajor> RowsBlockXpr;
typedef const Block<const Derived, Dynamic, internal::traits<Derived>::ColsAtCompileTime, IsRowMajor> ConstRowsBlockXpr;
/** \internal expression type of a block of whole columns */
template<int N> struct NColsBlockXpr { typedef Block<Derived, internal::traits<Derived>::RowsAtCompileTime, N, !IsRowMajor> Type; };
template<int N> struct ConstNColsBlockXpr { typedef const Block<const Derived, internal::traits<Derived>::RowsAtCompileTime, N, !IsRowMajor> Type; };
/** \internal expression type of a block of whole rows */
template<int N> struct NRowsBlockXpr { typedef Block<Derived, N, internal::traits<Derived>::ColsAtCompileTime, IsRowMajor> Type; };
template<int N> struct ConstNRowsBlockXpr { typedef const Block<const Derived, N, internal::traits<Derived>::ColsAtCompileTime, IsRowMajor> Type; };

Don Gagne's avatar
Don Gagne committed
33 34 35 36
typedef VectorBlock<Derived> SegmentReturnType;
typedef const VectorBlock<const Derived> ConstSegmentReturnType;
template<int Size> struct FixedSegmentReturnType { typedef VectorBlock<Derived, Size> Type; };
template<int Size> struct ConstFixedSegmentReturnType { typedef const VectorBlock<const Derived, Size> Type; };
LM's avatar
LM committed
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92

#endif // not EIGEN_PARSED_BY_DOXYGEN

/** \returns a dynamic-size expression of a block in *this.
  *
  * \param startRow the first row in the block
  * \param startCol the first column in the block
  * \param blockRows the number of rows in the block
  * \param blockCols the number of columns in the block
  *
  * Example: \include MatrixBase_block_int_int_int_int.cpp
  * Output: \verbinclude MatrixBase_block_int_int_int_int.out
  *
  * \note Even though the returned expression has dynamic size, in the case
  * when it is applied to a fixed-size matrix, it inherits a fixed maximal size,
  * which means that evaluating it does not cause a dynamic memory allocation.
  *
  * \sa class Block, block(Index,Index)
  */
inline Block<Derived> block(Index startRow, Index startCol, Index blockRows, Index blockCols)
{
  return Block<Derived>(derived(), startRow, startCol, blockRows, blockCols);
}

/** This is the const version of block(Index,Index,Index,Index). */
inline const Block<const Derived> block(Index startRow, Index startCol, Index blockRows, Index blockCols) const
{
  return Block<const Derived>(derived(), startRow, startCol, blockRows, blockCols);
}




/** \returns a dynamic-size expression of a top-right corner of *this.
  *
  * \param cRows the number of rows in the corner
  * \param cCols the number of columns in the corner
  *
  * Example: \include MatrixBase_topRightCorner_int_int.cpp
  * Output: \verbinclude MatrixBase_topRightCorner_int_int.out
  *
  * \sa class Block, block(Index,Index,Index,Index)
  */
inline Block<Derived> topRightCorner(Index cRows, Index cCols)
{
  return Block<Derived>(derived(), 0, cols() - cCols, cRows, cCols);
}

/** This is the const version of topRightCorner(Index, Index).*/
inline const Block<const Derived> topRightCorner(Index cRows, Index cCols) const
{
  return Block<const Derived>(derived(), 0, cols() - cCols, cRows, cCols);
}

/** \returns an expression of a fixed-size top-right corner of *this.
  *
Don Gagne's avatar
Don Gagne committed
93 94
  * \tparam CRows the number of rows in the corner
  * \tparam CCols the number of columns in the corner
LM's avatar
LM committed
95 96 97 98
  *
  * Example: \include MatrixBase_template_int_int_topRightCorner.cpp
  * Output: \verbinclude MatrixBase_template_int_int_topRightCorner.out
  *
Don Gagne's avatar
Don Gagne committed
99
  * \sa class Block, block<int,int>(Index,Index)
LM's avatar
LM committed
100 101 102 103 104 105 106 107 108 109 110 111 112 113
  */
template<int CRows, int CCols>
inline Block<Derived, CRows, CCols> topRightCorner()
{
  return Block<Derived, CRows, CCols>(derived(), 0, cols() - CCols);
}

/** This is the const version of topRightCorner<int, int>().*/
template<int CRows, int CCols>
inline const Block<const Derived, CRows, CCols> topRightCorner() const
{
  return Block<const Derived, CRows, CCols>(derived(), 0, cols() - CCols);
}

Don Gagne's avatar
Don Gagne committed
114 115
/** \returns an expression of a top-right corner of *this.
  *
116 117 118 119
  * \tparam CRows number of rows in corner as specified at compile-time
  * \tparam CCols number of columns in corner as specified at compile-time
  * \param  cRows number of rows in corner as specified at run-time
  * \param  cCols number of columns in corner as specified at run-time
Don Gagne's avatar
Don Gagne committed
120
  *
121 122
  * This function is mainly useful for corners where the number of rows is specified at compile-time
  * and the number of columns is specified at run-time, or vice versa. The compile-time and run-time
Don Gagne's avatar
Don Gagne committed
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142
  * information should not contradict. In other words, \a cRows should equal \a CRows unless
  * \a CRows is \a Dynamic, and the same for the number of columns.
  *
  * Example: \include MatrixBase_template_int_int_topRightCorner_int_int.cpp
  * Output: \verbinclude MatrixBase_template_int_int_topRightCorner_int_int.out
  *
  * \sa class Block
  */
template<int CRows, int CCols>
inline Block<Derived, CRows, CCols> topRightCorner(Index cRows, Index cCols)
{
  return Block<Derived, CRows, CCols>(derived(), 0, cols() - cCols, cRows, cCols);
}

/** This is the const version of topRightCorner<int, int>(Index, Index).*/
template<int CRows, int CCols>
inline const Block<const Derived, CRows, CCols> topRightCorner(Index cRows, Index cCols) const
{
  return Block<const Derived, CRows, CCols>(derived(), 0, cols() - cCols, cRows, cCols);
}
LM's avatar
LM committed
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188



/** \returns a dynamic-size expression of a top-left corner of *this.
  *
  * \param cRows the number of rows in the corner
  * \param cCols the number of columns in the corner
  *
  * Example: \include MatrixBase_topLeftCorner_int_int.cpp
  * Output: \verbinclude MatrixBase_topLeftCorner_int_int.out
  *
  * \sa class Block, block(Index,Index,Index,Index)
  */
inline Block<Derived> topLeftCorner(Index cRows, Index cCols)
{
  return Block<Derived>(derived(), 0, 0, cRows, cCols);
}

/** This is the const version of topLeftCorner(Index, Index).*/
inline const Block<const Derived> topLeftCorner(Index cRows, Index cCols) const
{
  return Block<const Derived>(derived(), 0, 0, cRows, cCols);
}

/** \returns an expression of a fixed-size top-left corner of *this.
  *
  * The template parameters CRows and CCols are the number of rows and columns in the corner.
  *
  * Example: \include MatrixBase_template_int_int_topLeftCorner.cpp
  * Output: \verbinclude MatrixBase_template_int_int_topLeftCorner.out
  *
  * \sa class Block, block(Index,Index,Index,Index)
  */
template<int CRows, int CCols>
inline Block<Derived, CRows, CCols> topLeftCorner()
{
  return Block<Derived, CRows, CCols>(derived(), 0, 0);
}

/** This is the const version of topLeftCorner<int, int>().*/
template<int CRows, int CCols>
inline const Block<const Derived, CRows, CCols> topLeftCorner() const
{
  return Block<const Derived, CRows, CCols>(derived(), 0, 0);
}

Don Gagne's avatar
Don Gagne committed
189 190
/** \returns an expression of a top-left corner of *this.
  *
191 192 193 194
  * \tparam CRows number of rows in corner as specified at compile-time
  * \tparam CCols number of columns in corner as specified at compile-time
  * \param  cRows number of rows in corner as specified at run-time
  * \param  cCols number of columns in corner as specified at run-time
Don Gagne's avatar
Don Gagne committed
195
  *
196 197
  * This function is mainly useful for corners where the number of rows is specified at compile-time
  * and the number of columns is specified at run-time, or vice versa. The compile-time and run-time
Don Gagne's avatar
Don Gagne committed
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
  * information should not contradict. In other words, \a cRows should equal \a CRows unless
  * \a CRows is \a Dynamic, and the same for the number of columns.
  *
  * Example: \include MatrixBase_template_int_int_topLeftCorner_int_int.cpp
  * Output: \verbinclude MatrixBase_template_int_int_topLeftCorner_int_int.out
  *
  * \sa class Block
  */
template<int CRows, int CCols>
inline Block<Derived, CRows, CCols> topLeftCorner(Index cRows, Index cCols)
{
  return Block<Derived, CRows, CCols>(derived(), 0, 0, cRows, cCols);
}

/** This is the const version of topLeftCorner<int, int>(Index, Index).*/
template<int CRows, int CCols>
inline const Block<const Derived, CRows, CCols> topLeftCorner(Index cRows, Index cCols) const
{
  return Block<const Derived, CRows, CCols>(derived(), 0, 0, cRows, cCols);
}

LM's avatar
LM committed
219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263


/** \returns a dynamic-size expression of a bottom-right corner of *this.
  *
  * \param cRows the number of rows in the corner
  * \param cCols the number of columns in the corner
  *
  * Example: \include MatrixBase_bottomRightCorner_int_int.cpp
  * Output: \verbinclude MatrixBase_bottomRightCorner_int_int.out
  *
  * \sa class Block, block(Index,Index,Index,Index)
  */
inline Block<Derived> bottomRightCorner(Index cRows, Index cCols)
{
  return Block<Derived>(derived(), rows() - cRows, cols() - cCols, cRows, cCols);
}

/** This is the const version of bottomRightCorner(Index, Index).*/
inline const Block<const Derived> bottomRightCorner(Index cRows, Index cCols) const
{
  return Block<const Derived>(derived(), rows() - cRows, cols() - cCols, cRows, cCols);
}

/** \returns an expression of a fixed-size bottom-right corner of *this.
  *
  * The template parameters CRows and CCols are the number of rows and columns in the corner.
  *
  * Example: \include MatrixBase_template_int_int_bottomRightCorner.cpp
  * Output: \verbinclude MatrixBase_template_int_int_bottomRightCorner.out
  *
  * \sa class Block, block(Index,Index,Index,Index)
  */
template<int CRows, int CCols>
inline Block<Derived, CRows, CCols> bottomRightCorner()
{
  return Block<Derived, CRows, CCols>(derived(), rows() - CRows, cols() - CCols);
}

/** This is the const version of bottomRightCorner<int, int>().*/
template<int CRows, int CCols>
inline const Block<const Derived, CRows, CCols> bottomRightCorner() const
{
  return Block<const Derived, CRows, CCols>(derived(), rows() - CRows, cols() - CCols);
}

Don Gagne's avatar
Don Gagne committed
264 265
/** \returns an expression of a bottom-right corner of *this.
  *
266 267 268 269
  * \tparam CRows number of rows in corner as specified at compile-time
  * \tparam CCols number of columns in corner as specified at compile-time
  * \param  cRows number of rows in corner as specified at run-time
  * \param  cCols number of columns in corner as specified at run-time
Don Gagne's avatar
Don Gagne committed
270
  *
271 272
  * This function is mainly useful for corners where the number of rows is specified at compile-time
  * and the number of columns is specified at run-time, or vice versa. The compile-time and run-time
Don Gagne's avatar
Don Gagne committed
273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
  * information should not contradict. In other words, \a cRows should equal \a CRows unless
  * \a CRows is \a Dynamic, and the same for the number of columns.
  *
  * Example: \include MatrixBase_template_int_int_bottomRightCorner_int_int.cpp
  * Output: \verbinclude MatrixBase_template_int_int_bottomRightCorner_int_int.out
  *
  * \sa class Block
  */
template<int CRows, int CCols>
inline Block<Derived, CRows, CCols> bottomRightCorner(Index cRows, Index cCols)
{
  return Block<Derived, CRows, CCols>(derived(), rows() - cRows, cols() - cCols, cRows, cCols);
}

/** This is the const version of bottomRightCorner<int, int>(Index, Index).*/
template<int CRows, int CCols>
inline const Block<const Derived, CRows, CCols> bottomRightCorner(Index cRows, Index cCols) const
{
  return Block<const Derived, CRows, CCols>(derived(), rows() - cRows, cols() - cCols, cRows, cCols);
}

LM's avatar
LM committed
294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338


/** \returns a dynamic-size expression of a bottom-left corner of *this.
  *
  * \param cRows the number of rows in the corner
  * \param cCols the number of columns in the corner
  *
  * Example: \include MatrixBase_bottomLeftCorner_int_int.cpp
  * Output: \verbinclude MatrixBase_bottomLeftCorner_int_int.out
  *
  * \sa class Block, block(Index,Index,Index,Index)
  */
inline Block<Derived> bottomLeftCorner(Index cRows, Index cCols)
{
  return Block<Derived>(derived(), rows() - cRows, 0, cRows, cCols);
}

/** This is the const version of bottomLeftCorner(Index, Index).*/
inline const Block<const Derived> bottomLeftCorner(Index cRows, Index cCols) const
{
  return Block<const Derived>(derived(), rows() - cRows, 0, cRows, cCols);
}

/** \returns an expression of a fixed-size bottom-left corner of *this.
  *
  * The template parameters CRows and CCols are the number of rows and columns in the corner.
  *
  * Example: \include MatrixBase_template_int_int_bottomLeftCorner.cpp
  * Output: \verbinclude MatrixBase_template_int_int_bottomLeftCorner.out
  *
  * \sa class Block, block(Index,Index,Index,Index)
  */
template<int CRows, int CCols>
inline Block<Derived, CRows, CCols> bottomLeftCorner()
{
  return Block<Derived, CRows, CCols>(derived(), rows() - CRows, 0);
}

/** This is the const version of bottomLeftCorner<int, int>().*/
template<int CRows, int CCols>
inline const Block<const Derived, CRows, CCols> bottomLeftCorner() const
{
  return Block<const Derived, CRows, CCols>(derived(), rows() - CRows, 0);
}

Don Gagne's avatar
Don Gagne committed
339 340
/** \returns an expression of a bottom-left corner of *this.
  *
341 342 343 344
  * \tparam CRows number of rows in corner as specified at compile-time
  * \tparam CCols number of columns in corner as specified at compile-time
  * \param  cRows number of rows in corner as specified at run-time
  * \param  cCols number of columns in corner as specified at run-time
Don Gagne's avatar
Don Gagne committed
345
  *
346 347
  * This function is mainly useful for corners where the number of rows is specified at compile-time
  * and the number of columns is specified at run-time, or vice versa. The compile-time and run-time
Don Gagne's avatar
Don Gagne committed
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368
  * information should not contradict. In other words, \a cRows should equal \a CRows unless
  * \a CRows is \a Dynamic, and the same for the number of columns.
  *
  * Example: \include MatrixBase_template_int_int_bottomLeftCorner_int_int.cpp
  * Output: \verbinclude MatrixBase_template_int_int_bottomLeftCorner_int_int.out
  *
  * \sa class Block
  */
template<int CRows, int CCols>
inline Block<Derived, CRows, CCols> bottomLeftCorner(Index cRows, Index cCols)
{
  return Block<Derived, CRows, CCols>(derived(), rows() - cRows, 0, cRows, cCols);
}

/** This is the const version of bottomLeftCorner<int, int>(Index, Index).*/
template<int CRows, int CCols>
inline const Block<const Derived, CRows, CCols> bottomLeftCorner(Index cRows, Index cCols) const
{
  return Block<const Derived, CRows, CCols>(derived(), rows() - cRows, 0, cRows, cCols);
}

LM's avatar
LM committed
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392


/** \returns a block consisting of the top rows of *this.
  *
  * \param n the number of rows in the block
  *
  * Example: \include MatrixBase_topRows_int.cpp
  * Output: \verbinclude MatrixBase_topRows_int.out
  *
  * \sa class Block, block(Index,Index,Index,Index)
  */
inline RowsBlockXpr topRows(Index n)
{
  return RowsBlockXpr(derived(), 0, 0, n, cols());
}

/** This is the const version of topRows(Index).*/
inline ConstRowsBlockXpr topRows(Index n) const
{
  return ConstRowsBlockXpr(derived(), 0, 0, n, cols());
}

/** \returns a block consisting of the top rows of *this.
  *
393 394 395 396 397
  * \tparam N the number of rows in the block as specified at compile-time
  * \param n the number of rows in the block as specified at run-time
  *
  * The compile-time and run-time information should not contradict. In other words,
  * \a n should equal \a N unless \a N is \a Dynamic.
LM's avatar
LM committed
398 399 400 401 402 403 404
  *
  * Example: \include MatrixBase_template_int_topRows.cpp
  * Output: \verbinclude MatrixBase_template_int_topRows.out
  *
  * \sa class Block, block(Index,Index,Index,Index)
  */
template<int N>
405
inline typename NRowsBlockXpr<N>::Type topRows(Index n = N)
LM's avatar
LM committed
406
{
407
  return typename NRowsBlockXpr<N>::Type(derived(), 0, 0, n, cols());
LM's avatar
LM committed
408 409 410 411
}

/** This is the const version of topRows<int>().*/
template<int N>
412
inline typename ConstNRowsBlockXpr<N>::Type topRows(Index n = N) const
LM's avatar
LM committed
413
{
414
  return typename ConstNRowsBlockXpr<N>::Type(derived(), 0, 0, n, cols());
LM's avatar
LM committed
415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440
}



/** \returns a block consisting of the bottom rows of *this.
  *
  * \param n the number of rows in the block
  *
  * Example: \include MatrixBase_bottomRows_int.cpp
  * Output: \verbinclude MatrixBase_bottomRows_int.out
  *
  * \sa class Block, block(Index,Index,Index,Index)
  */
inline RowsBlockXpr bottomRows(Index n)
{
  return RowsBlockXpr(derived(), rows() - n, 0, n, cols());
}

/** This is the const version of bottomRows(Index).*/
inline ConstRowsBlockXpr bottomRows(Index n) const
{
  return ConstRowsBlockXpr(derived(), rows() - n, 0, n, cols());
}

/** \returns a block consisting of the bottom rows of *this.
  *
441 442 443 444 445
  * \tparam N the number of rows in the block as specified at compile-time
  * \param n the number of rows in the block as specified at run-time
  *
  * The compile-time and run-time information should not contradict. In other words,
  * \a n should equal \a N unless \a N is \a Dynamic.
LM's avatar
LM committed
446 447 448 449 450 451 452
  *
  * Example: \include MatrixBase_template_int_bottomRows.cpp
  * Output: \verbinclude MatrixBase_template_int_bottomRows.out
  *
  * \sa class Block, block(Index,Index,Index,Index)
  */
template<int N>
453
inline typename NRowsBlockXpr<N>::Type bottomRows(Index n = N)
LM's avatar
LM committed
454
{
455
  return typename NRowsBlockXpr<N>::Type(derived(), rows() - n, 0, n, cols());
LM's avatar
LM committed
456 457 458 459
}

/** This is the const version of bottomRows<int>().*/
template<int N>
460
inline typename ConstNRowsBlockXpr<N>::Type bottomRows(Index n = N) const
LM's avatar
LM committed
461
{
462
  return typename ConstNRowsBlockXpr<N>::Type(derived(), rows() - n, 0, n, cols());
LM's avatar
LM committed
463 464 465 466 467 468 469
}



/** \returns a block consisting of a range of rows of *this.
  *
  * \param startRow the index of the first row in the block
470
  * \param n the number of rows in the block
LM's avatar
LM committed
471 472 473 474 475 476
  *
  * Example: \include DenseBase_middleRows_int.cpp
  * Output: \verbinclude DenseBase_middleRows_int.out
  *
  * \sa class Block, block(Index,Index,Index,Index)
  */
477
inline RowsBlockXpr middleRows(Index startRow, Index n)
LM's avatar
LM committed
478
{
479
  return RowsBlockXpr(derived(), startRow, 0, n, cols());
LM's avatar
LM committed
480 481 482
}

/** This is the const version of middleRows(Index,Index).*/
483
inline ConstRowsBlockXpr middleRows(Index startRow, Index n) const
LM's avatar
LM committed
484
{
485
  return ConstRowsBlockXpr(derived(), startRow, 0, n, cols());
LM's avatar
LM committed
486 487 488 489
}

/** \returns a block consisting of a range of rows of *this.
  *
490
  * \tparam N the number of rows in the block as specified at compile-time
LM's avatar
LM committed
491
  * \param startRow the index of the first row in the block
492 493 494 495
  * \param n the number of rows in the block as specified at run-time
  *
  * The compile-time and run-time information should not contradict. In other words,
  * \a n should equal \a N unless \a N is \a Dynamic.
LM's avatar
LM committed
496 497 498 499 500 501 502
  *
  * Example: \include DenseBase_template_int_middleRows.cpp
  * Output: \verbinclude DenseBase_template_int_middleRows.out
  *
  * \sa class Block, block(Index,Index,Index,Index)
  */
template<int N>
503
inline typename NRowsBlockXpr<N>::Type middleRows(Index startRow, Index n = N)
LM's avatar
LM committed
504
{
505
  return typename NRowsBlockXpr<N>::Type(derived(), startRow, 0, n, cols());
LM's avatar
LM committed
506 507 508 509
}

/** This is the const version of middleRows<int>().*/
template<int N>
510
inline typename ConstNRowsBlockXpr<N>::Type middleRows(Index startRow, Index n = N) const
LM's avatar
LM committed
511
{
512
  return typename ConstNRowsBlockXpr<N>::Type(derived(), startRow, 0, n, cols());
LM's avatar
LM committed
513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538
}



/** \returns a block consisting of the left columns of *this.
  *
  * \param n the number of columns in the block
  *
  * Example: \include MatrixBase_leftCols_int.cpp
  * Output: \verbinclude MatrixBase_leftCols_int.out
  *
  * \sa class Block, block(Index,Index,Index,Index)
  */
inline ColsBlockXpr leftCols(Index n)
{
  return ColsBlockXpr(derived(), 0, 0, rows(), n);
}

/** This is the const version of leftCols(Index).*/
inline ConstColsBlockXpr leftCols(Index n) const
{
  return ConstColsBlockXpr(derived(), 0, 0, rows(), n);
}

/** \returns a block consisting of the left columns of *this.
  *
539 540 541 542 543
  * \tparam N the number of columns in the block as specified at compile-time
  * \param n the number of columns in the block as specified at run-time
  *
  * The compile-time and run-time information should not contradict. In other words,
  * \a n should equal \a N unless \a N is \a Dynamic.
LM's avatar
LM committed
544 545 546 547 548 549 550
  *
  * Example: \include MatrixBase_template_int_leftCols.cpp
  * Output: \verbinclude MatrixBase_template_int_leftCols.out
  *
  * \sa class Block, block(Index,Index,Index,Index)
  */
template<int N>
551
inline typename NColsBlockXpr<N>::Type leftCols(Index n = N)
LM's avatar
LM committed
552
{
553
  return typename NColsBlockXpr<N>::Type(derived(), 0, 0, rows(), n);
LM's avatar
LM committed
554 555 556 557
}

/** This is the const version of leftCols<int>().*/
template<int N>
558
inline typename ConstNColsBlockXpr<N>::Type leftCols(Index n = N) const
LM's avatar
LM committed
559
{
560
  return typename ConstNColsBlockXpr<N>::Type(derived(), 0, 0, rows(), n);
LM's avatar
LM committed
561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586
}



/** \returns a block consisting of the right columns of *this.
  *
  * \param n the number of columns in the block
  *
  * Example: \include MatrixBase_rightCols_int.cpp
  * Output: \verbinclude MatrixBase_rightCols_int.out
  *
  * \sa class Block, block(Index,Index,Index,Index)
  */
inline ColsBlockXpr rightCols(Index n)
{
  return ColsBlockXpr(derived(), 0, cols() - n, rows(), n);
}

/** This is the const version of rightCols(Index).*/
inline ConstColsBlockXpr rightCols(Index n) const
{
  return ConstColsBlockXpr(derived(), 0, cols() - n, rows(), n);
}

/** \returns a block consisting of the right columns of *this.
  *
587 588 589 590 591
  * \tparam N the number of columns in the block as specified at compile-time
  * \param n the number of columns in the block as specified at run-time
  *
  * The compile-time and run-time information should not contradict. In other words,
  * \a n should equal \a N unless \a N is \a Dynamic.
LM's avatar
LM committed
592 593 594 595 596 597 598
  *
  * Example: \include MatrixBase_template_int_rightCols.cpp
  * Output: \verbinclude MatrixBase_template_int_rightCols.out
  *
  * \sa class Block, block(Index,Index,Index,Index)
  */
template<int N>
599
inline typename NColsBlockXpr<N>::Type rightCols(Index n = N)
LM's avatar
LM committed
600
{
601
  return typename NColsBlockXpr<N>::Type(derived(), 0, cols() - n, rows(), n);
LM's avatar
LM committed
602 603 604 605
}

/** This is the const version of rightCols<int>().*/
template<int N>
606
inline typename ConstNColsBlockXpr<N>::Type rightCols(Index n = N) const
LM's avatar
LM committed
607
{
608
  return typename ConstNColsBlockXpr<N>::Type(derived(), 0, cols() - n, rows(), n);
LM's avatar
LM committed
609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635
}



/** \returns a block consisting of a range of columns of *this.
  *
  * \param startCol the index of the first column in the block
  * \param numCols the number of columns in the block
  *
  * Example: \include DenseBase_middleCols_int.cpp
  * Output: \verbinclude DenseBase_middleCols_int.out
  *
  * \sa class Block, block(Index,Index,Index,Index)
  */
inline ColsBlockXpr middleCols(Index startCol, Index numCols)
{
  return ColsBlockXpr(derived(), 0, startCol, rows(), numCols);
}

/** This is the const version of middleCols(Index,Index).*/
inline ConstColsBlockXpr middleCols(Index startCol, Index numCols) const
{
  return ConstColsBlockXpr(derived(), 0, startCol, rows(), numCols);
}

/** \returns a block consisting of a range of columns of *this.
  *
636
  * \tparam N the number of columns in the block as specified at compile-time
LM's avatar
LM committed
637
  * \param startCol the index of the first column in the block
638 639 640 641
  * \param n the number of columns in the block as specified at run-time
  *
  * The compile-time and run-time information should not contradict. In other words,
  * \a n should equal \a N unless \a N is \a Dynamic.
LM's avatar
LM committed
642 643 644 645 646 647 648
  *
  * Example: \include DenseBase_template_int_middleCols.cpp
  * Output: \verbinclude DenseBase_template_int_middleCols.out
  *
  * \sa class Block, block(Index,Index,Index,Index)
  */
template<int N>
649
inline typename NColsBlockXpr<N>::Type middleCols(Index startCol, Index n = N)
LM's avatar
LM committed
650
{
651
  return typename NColsBlockXpr<N>::Type(derived(), 0, startCol, rows(), n);
LM's avatar
LM committed
652 653 654 655
}

/** This is the const version of middleCols<int>().*/
template<int N>
656
inline typename ConstNColsBlockXpr<N>::Type middleCols(Index startCol, Index n = N) const
LM's avatar
LM committed
657
{
658
  return typename ConstNColsBlockXpr<N>::Type(derived(), 0, startCol, rows(), n);
LM's avatar
LM committed
659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691
}



/** \returns a fixed-size expression of a block in *this.
  *
  * The template parameters \a BlockRows and \a BlockCols are the number of
  * rows and columns in the block.
  *
  * \param startRow the first row in the block
  * \param startCol the first column in the block
  *
  * Example: \include MatrixBase_block_int_int.cpp
  * Output: \verbinclude MatrixBase_block_int_int.out
  *
  * \note since block is a templated member, the keyword template has to be used
  * if the matrix type is also a template parameter: \code m.template block<3,3>(1,1); \endcode
  *
  * \sa class Block, block(Index,Index,Index,Index)
  */
template<int BlockRows, int BlockCols>
inline Block<Derived, BlockRows, BlockCols> block(Index startRow, Index startCol)
{
  return Block<Derived, BlockRows, BlockCols>(derived(), startRow, startCol);
}

/** This is the const version of block<>(Index, Index). */
template<int BlockRows, int BlockCols>
inline const Block<const Derived, BlockRows, BlockCols> block(Index startRow, Index startCol) const
{
  return Block<const Derived, BlockRows, BlockCols>(derived(), startRow, startCol);
}

Don Gagne's avatar
Don Gagne committed
692 693
/** \returns an expression of a block in *this.
  *
694 695
  * \tparam BlockRows number of rows in block as specified at compile-time
  * \tparam BlockCols number of columns in block as specified at compile-time
Don Gagne's avatar
Don Gagne committed
696 697
  * \param  startRow  the first row in the block
  * \param  startCol  the first column in the block
698 699
  * \param  blockRows number of rows in block as specified at run-time
  * \param  blockCols number of columns in block as specified at run-time
Don Gagne's avatar
Don Gagne committed
700
  *
701 702
  * This function is mainly useful for blocks where the number of rows is specified at compile-time
  * and the number of columns is specified at run-time, or vice versa. The compile-time and run-time
Don Gagne's avatar
Don Gagne committed
703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725
  * information should not contradict. In other words, \a blockRows should equal \a BlockRows unless
  * \a BlockRows is \a Dynamic, and the same for the number of columns.
  *
  * Example: \include MatrixBase_template_int_int_block_int_int_int_int.cpp
  * Output: \verbinclude MatrixBase_template_int_int_block_int_int_int_int.cpp
  *
  * \sa class Block, block(Index,Index,Index,Index)
  */
template<int BlockRows, int BlockCols>
inline Block<Derived, BlockRows, BlockCols> block(Index startRow, Index startCol, 
                                                  Index blockRows, Index blockCols)
{
  return Block<Derived, BlockRows, BlockCols>(derived(), startRow, startCol, blockRows, blockCols);
}

/** This is the const version of block<>(Index, Index, Index, Index). */
template<int BlockRows, int BlockCols>
inline const Block<const Derived, BlockRows, BlockCols> block(Index startRow, Index startCol,
                                                              Index blockRows, Index blockCols) const
{
  return Block<const Derived, BlockRows, BlockCols>(derived(), startRow, startCol, blockRows, blockCols);
}

LM's avatar
LM committed
726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759
/** \returns an expression of the \a i-th column of *this. Note that the numbering starts at 0.
  *
  * Example: \include MatrixBase_col.cpp
  * Output: \verbinclude MatrixBase_col.out
  *
  * \sa row(), class Block */
inline ColXpr col(Index i)
{
  return ColXpr(derived(), i);
}

/** This is the const version of col(). */
inline ConstColXpr col(Index i) const
{
  return ConstColXpr(derived(), i);
}

/** \returns an expression of the \a i-th row of *this. Note that the numbering starts at 0.
  *
  * Example: \include MatrixBase_row.cpp
  * Output: \verbinclude MatrixBase_row.out
  *
  * \sa col(), class Block */
inline RowXpr row(Index i)
{
  return RowXpr(derived(), i);
}

/** This is the const version of row(). */
inline ConstRowXpr row(Index i) const
{
  return ConstRowXpr(derived(), i);
}

Don Gagne's avatar
Don Gagne committed
760 761 762 763 764
/** \returns a dynamic-size expression of a segment (i.e. a vector block) in *this.
  *
  * \only_for_vectors
  *
  * \param start the first coefficient in the segment
765
  * \param n the number of coefficients in the segment
Don Gagne's avatar
Don Gagne committed
766 767 768 769 770 771 772 773 774 775
  *
  * Example: \include MatrixBase_segment_int_int.cpp
  * Output: \verbinclude MatrixBase_segment_int_int.out
  *
  * \note Even though the returned expression has dynamic size, in the case
  * when it is applied to a fixed-size vector, it inherits a fixed maximal size,
  * which means that evaluating it does not cause a dynamic memory allocation.
  *
  * \sa class Block, segment(Index)
  */
776
inline SegmentReturnType segment(Index start, Index n)
Don Gagne's avatar
Don Gagne committed
777 778
{
  EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived)
779
  return SegmentReturnType(derived(), start, n);
Don Gagne's avatar
Don Gagne committed
780 781 782 783
}


/** This is the const version of segment(Index,Index).*/
784
inline ConstSegmentReturnType segment(Index start, Index n) const
Don Gagne's avatar
Don Gagne committed
785 786
{
  EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived)
787
  return ConstSegmentReturnType(derived(), start, n);
Don Gagne's avatar
Don Gagne committed
788 789 790 791 792 793
}

/** \returns a dynamic-size expression of the first coefficients of *this.
  *
  * \only_for_vectors
  *
794
  * \param n the number of coefficients in the segment
Don Gagne's avatar
Don Gagne committed
795 796 797 798 799 800 801 802 803 804
  *
  * Example: \include MatrixBase_start_int.cpp
  * Output: \verbinclude MatrixBase_start_int.out
  *
  * \note Even though the returned expression has dynamic size, in the case
  * when it is applied to a fixed-size vector, it inherits a fixed maximal size,
  * which means that evaluating it does not cause a dynamic memory allocation.
  *
  * \sa class Block, block(Index,Index)
  */
805
inline SegmentReturnType head(Index n)
Don Gagne's avatar
Don Gagne committed
806 807
{
  EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived)
808
  return SegmentReturnType(derived(), 0, n);
Don Gagne's avatar
Don Gagne committed
809 810 811
}

/** This is the const version of head(Index).*/
812
inline ConstSegmentReturnType head(Index n) const
Don Gagne's avatar
Don Gagne committed
813 814
{
  EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived)
815
  return ConstSegmentReturnType(derived(), 0, n);
Don Gagne's avatar
Don Gagne committed
816 817 818 819 820 821
}

/** \returns a dynamic-size expression of the last coefficients of *this.
  *
  * \only_for_vectors
  *
822
  * \param n the number of coefficients in the segment
Don Gagne's avatar
Don Gagne committed
823 824 825 826 827 828 829 830 831 832
  *
  * Example: \include MatrixBase_end_int.cpp
  * Output: \verbinclude MatrixBase_end_int.out
  *
  * \note Even though the returned expression has dynamic size, in the case
  * when it is applied to a fixed-size vector, it inherits a fixed maximal size,
  * which means that evaluating it does not cause a dynamic memory allocation.
  *
  * \sa class Block, block(Index,Index)
  */
833
inline SegmentReturnType tail(Index n)
Don Gagne's avatar
Don Gagne committed
834 835
{
  EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived)
836
  return SegmentReturnType(derived(), this->size() - n, n);
Don Gagne's avatar
Don Gagne committed
837 838 839
}

/** This is the const version of tail(Index).*/
840
inline ConstSegmentReturnType tail(Index n) const
Don Gagne's avatar
Don Gagne committed
841 842
{
  EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived)
843
  return ConstSegmentReturnType(derived(), this->size() - n, n);
Don Gagne's avatar
Don Gagne committed
844 845 846 847 848 849
}

/** \returns a fixed-size expression of a segment (i.e. a vector block) in \c *this
  *
  * \only_for_vectors
  *
850 851 852
  * \tparam N the number of coefficients in the segment as specified at compile-time
  * \param start the index of the first element in the segment
  * \param n the number of coefficients in the segment as specified at compile-time
Don Gagne's avatar
Don Gagne committed
853
  *
854 855
  * The compile-time and run-time information should not contradict. In other words,
  * \a n should equal \a N unless \a N is \a Dynamic.
Don Gagne's avatar
Don Gagne committed
856 857 858 859 860 861
  *
  * Example: \include MatrixBase_template_int_segment.cpp
  * Output: \verbinclude MatrixBase_template_int_segment.out
  *
  * \sa class Block
  */
862 863
template<int N>
inline typename FixedSegmentReturnType<N>::Type segment(Index start, Index n = N)
Don Gagne's avatar
Don Gagne committed
864 865
{
  EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived)
866
  return typename FixedSegmentReturnType<N>::Type(derived(), start, n);
Don Gagne's avatar
Don Gagne committed
867 868 869
}

/** This is the const version of segment<int>(Index).*/
870 871
template<int N>
inline typename ConstFixedSegmentReturnType<N>::Type segment(Index start, Index n = N) const
Don Gagne's avatar
Don Gagne committed
872 873
{
  EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived)
874
  return typename ConstFixedSegmentReturnType<N>::Type(derived(), start, n);
Don Gagne's avatar
Don Gagne committed
875 876 877 878 879 880
}

/** \returns a fixed-size expression of the first coefficients of *this.
  *
  * \only_for_vectors
  *
881 882 883 884 885
  * \tparam N the number of coefficients in the segment as specified at compile-time
  * \param  n the number of coefficients in the segment as specified at run-time
  *
  * The compile-time and run-time information should not contradict. In other words,
  * \a n should equal \a N unless \a N is \a Dynamic.
Don Gagne's avatar
Don Gagne committed
886 887 888 889 890 891
  *
  * Example: \include MatrixBase_template_int_start.cpp
  * Output: \verbinclude MatrixBase_template_int_start.out
  *
  * \sa class Block
  */
892 893
template<int N>
inline typename FixedSegmentReturnType<N>::Type head(Index n = N)
Don Gagne's avatar
Don Gagne committed
894 895
{
  EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived)
896
  return typename FixedSegmentReturnType<N>::Type(derived(), 0, n);
Don Gagne's avatar
Don Gagne committed
897 898 899
}

/** This is the const version of head<int>().*/
900 901
template<int N>
inline typename ConstFixedSegmentReturnType<N>::Type head(Index n = N) const
Don Gagne's avatar
Don Gagne committed
902 903
{
  EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived)
904
  return typename ConstFixedSegmentReturnType<N>::Type(derived(), 0, n);
Don Gagne's avatar
Don Gagne committed
905 906 907 908 909 910
}

/** \returns a fixed-size expression of the last coefficients of *this.
  *
  * \only_for_vectors
  *
911 912 913 914 915
  * \tparam N the number of coefficients in the segment as specified at compile-time
  * \param  n the number of coefficients in the segment as specified at run-time
  *
  * The compile-time and run-time information should not contradict. In other words,
  * \a n should equal \a N unless \a N is \a Dynamic.
Don Gagne's avatar
Don Gagne committed
916 917 918 919 920 921
  *
  * Example: \include MatrixBase_template_int_end.cpp
  * Output: \verbinclude MatrixBase_template_int_end.out
  *
  * \sa class Block
  */
922 923
template<int N>
inline typename FixedSegmentReturnType<N>::Type tail(Index n = N)
Don Gagne's avatar
Don Gagne committed
924 925
{
  EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived)
926
  return typename FixedSegmentReturnType<N>::Type(derived(), size() - n);
Don Gagne's avatar
Don Gagne committed
927 928 929
}

/** This is the const version of tail<int>.*/
930 931
template<int N>
inline typename ConstFixedSegmentReturnType<N>::Type tail(Index n = N) const
Don Gagne's avatar
Don Gagne committed
932 933
{
  EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived)
934
  return typename ConstFixedSegmentReturnType<N>::Type(derived(), size() - n);
Don Gagne's avatar
Don Gagne committed
935
}