aboutsummaryrefslogtreecommitdiffhomepage
path: root/Eigen/src/Array
diff options
context:
space:
mode:
authorGravatar Gael Guennebaud <g.gael@free.fr>2010-01-04 19:13:08 +0100
committerGravatar Gael Guennebaud <g.gael@free.fr>2010-01-04 19:13:08 +0100
commit71a171c267df54118cda01d845d42f3d3d465de3 (patch)
tree9432398656cee78e36fde1841cf7453af18dae2f /Eigen/src/Array
parentb6898996d4107b5823fc0fdaa22bfe0811716863 (diff)
s/asMatrix()/matrix()
Diffstat (limited to 'Eigen/src/Array')
-rw-r--r--Eigen/src/Array/ArrayBase.h6
-rw-r--r--Eigen/src/Array/ArrayWrapper.h19
2 files changed, 22 insertions, 3 deletions
diff --git a/Eigen/src/Array/ArrayBase.h b/Eigen/src/Array/ArrayBase.h
index 1ec2a3516..d846c4a9c 100644
--- a/Eigen/src/Array/ArrayBase.h
+++ b/Eigen/src/Array/ArrayBase.h
@@ -154,11 +154,11 @@ template<typename Derived> class ArrayBase
{ return cwiseNotEqual(other).all(); }
public:
- MatrixWrapper<Derived> asMatrix() { return derived(); }
- const MatrixWrapper<Derived> asMatrix() const { return derived(); }
+ MatrixWrapper<Derived> matrix() { return derived(); }
+ const MatrixWrapper<Derived> matrix() const { return derived(); }
// template<typename Dest>
-// inline void evalTo(Dest& dst) const { dst = asMatrix(); }
+// inline void evalTo(Dest& dst) const { dst = matrix(); }
protected:
ArrayBase() : Base() {}
diff --git a/Eigen/src/Array/ArrayWrapper.h b/Eigen/src/Array/ArrayWrapper.h
index 5850b6cb5..b62d66d8c 100644
--- a/Eigen/src/Array/ArrayWrapper.h
+++ b/Eigen/src/Array/ArrayWrapper.h
@@ -25,6 +25,15 @@
#ifndef EIGEN_ARRAYWRAPPER_H
#define EIGEN_ARRAYWRAPPER_H
+/** \class ArrayWrapper
+ *
+ * \brief Expression of a mathematical vector or matrix as an array object
+ *
+ * This class is the return type of MatrixBase::array(), and most of the time
+ * this is the only way it is use.
+ *
+ * \sa MatrixBase::array(), class MatrixWrapper
+ */
template<typename ExpressionType>
struct ei_traits<ArrayWrapper<ExpressionType> >
: public ei_traits<ExpressionType>
@@ -97,6 +106,16 @@ class ArrayWrapper : public ArrayBase<ArrayWrapper<ExpressionType> >
const ExpressionType& m_expression;
};
+/** \class MatrixWrapper
+ *
+ * \brief Expression of an array as a mathematical vector or matrix
+ *
+ * This class is the return type of ArrayBase::matrix(), and most of the time
+ * this is the only way it is use.
+ *
+ * \sa MatrixBase::matrix(), class ArrayWrapper
+ */
+
template<typename ExpressionType>
struct ei_traits<MatrixWrapper<ExpressionType> >
: public ei_traits<ExpressionType>