aboutsummaryrefslogtreecommitdiffhomepage
path: root/src
diff options
context:
space:
mode:
Diffstat (limited to 'src')
-rw-r--r--src/Core/Cast.h2
-rw-r--r--src/Core/Column.h2
-rw-r--r--src/Core/DynBlock.h10
-rw-r--r--src/Core/MatrixBase.h12
-rw-r--r--src/Core/Minor.h3
-rw-r--r--src/Core/Row.h2
6 files changed, 20 insertions, 11 deletions
diff --git a/src/Core/Cast.h b/src/Core/Cast.h
index 7dfce45b0..4d6a30159 100644
--- a/src/Core/Cast.h
+++ b/src/Core/Cast.h
@@ -55,6 +55,8 @@ template<typename NewScalar, typename MatrixType> class Cast : NoOperatorEquals,
MatRef m_matrix;
};
+/** \returns an expression of *this with the \a Scalar type casted to
+ * \a NewScalar. */
template<typename Scalar, typename Derived>
template<typename NewScalar>
const Cast<NewScalar, Derived>
diff --git a/src/Core/Column.h b/src/Core/Column.h
index 39b8263e7..d1d7f1453 100644
--- a/src/Core/Column.h
+++ b/src/Core/Column.h
@@ -67,6 +67,8 @@ template<typename MatrixType> class Column
const int m_col;
};
+/** \returns an expression of the \a i-th column of *this.
+ * \sa row(int) */
template<typename Scalar, typename Derived>
Column<Derived>
MatrixBase<Scalar, Derived>::col(int i) const
diff --git a/src/Core/DynBlock.h b/src/Core/DynBlock.h
index 3fa0e9c9b..b6795151c 100644
--- a/src/Core/DynBlock.h
+++ b/src/Core/DynBlock.h
@@ -75,6 +75,16 @@ template<typename MatrixType> class DynBlock
const int m_startRow, m_startCol, m_blockRows, m_blockCols;
};
+/** \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_dynBlock.cpp
+ */
template<typename Scalar, typename Derived>
DynBlock<Derived> MatrixBase<Scalar, Derived>
::dynBlock(int startRow, int startCol, int blockRows, int blockCols) const
diff --git a/src/Core/MatrixBase.h b/src/Core/MatrixBase.h
index db8eaadb5..6ca815ef0 100644
--- a/src/Core/MatrixBase.h
+++ b/src/Core/MatrixBase.h
@@ -46,7 +46,7 @@
*
* \code
template<typename Scalar, typename Derived>
- void printFirstRow(const Eigen::MatrixBase<Scalar, Derived>& m)
+ void printFirstRow(const Eigen::MatrixBase<Scalar, Derived>& x)
{
cout << x.row(0) << endl;
}
@@ -111,21 +111,11 @@ template<typename Scalar, typename Derived> class MatrixBase
return this->operator=<Derived>(other);
}
- /** \returns an expression of *this with the \a Scalar type casted to
- * \a NewScalar. */
template<typename NewScalar> const Cast<NewScalar, Derived> cast() const;
- /** \returns an expression of the \a i-th row of *this.
- * \sa col(int)*/
Row<Derived> row(int i) const;
- /** \returns an expression of the \a i-th column of *this.
- * \sa row(int) */
Column<Derived> col(int i) const;
- /** \return an expression of the (\a row, \a col)-minor of *this,
- * i.e. an expression constructed from *this by removing the specified
- * row and column. */
Minor<Derived> minor(int row, int col) const;
-
DynBlock<Derived> dynBlock(int startRow, int startCol,
int blockRows, int blockCols) const;
template<int BlockRows, int BlockCols>
diff --git a/src/Core/Minor.h b/src/Core/Minor.h
index 01389ed22..50422c5dd 100644
--- a/src/Core/Minor.h
+++ b/src/Core/Minor.h
@@ -73,6 +73,9 @@ template<typename MatrixType> class Minor
const int m_row, m_col;
};
+/** \return an expression of the (\a row, \a col)-minor of *this,
+ * i.e. an expression constructed from *this by removing the specified
+ * row and column. */
template<typename Scalar, typename Derived>
Minor<Derived>
MatrixBase<Scalar, Derived>::minor(int row, int col) const
diff --git a/src/Core/Row.h b/src/Core/Row.h
index af46dc280..a9168bb45 100644
--- a/src/Core/Row.h
+++ b/src/Core/Row.h
@@ -75,6 +75,8 @@ template<typename MatrixType> class Row
const int m_row;
};
+/** \returns an expression of the \a i-th row of *this.
+ * \sa col(int)*/
template<typename Scalar, typename Derived>
Row<Derived>
MatrixBase<Scalar, Derived>::row(int i) const