GitHub-Proxy/eigen
1
0
Fork 0
mirror of https://gitlab.com/libeigen/eigen.git synced 2025-05-01 08:14:10 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update docs of PlainObjectBase::Map(); fixes bug #335.

Browse Source 
Also fix some typos.
This commit is contained in:
Jitse Niesen 2011-09-03 15:18:21 +01:00
parent a2feb6f3c7
commit 477d3e5726
3 changed files with 4 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Eigen/src/Core/Fuzzy.h
View File

@ -94,7 +94,7 @@ struct isMuchSmallerThan_scalar_selector<Derived, true>
* *
* \note The fuzzy compares are done multiplicatively. Two vectors \f$ v \f$ and \f$ w \f$ * \note The fuzzy compares are done multiplicatively. Two vectors \f$ v \f$ and \f$ w \f$
* are considered to be approximately equal within precision \f$ p \f$ if * are considered to be approximately equal within precision \f$ p \f$ if
* \f[ \Vert v - w \Vert \leqslant p\,\(min)(\Vert v\Vert, \Vert w\Vert). \f] * \f[ \Vert v - w \Vert \leqslant p\,\min(\Vert v\Vert, \Vert w\Vert). \f]
* For matrices, the comparison is done using the Hilbert-Schmidt norm (aka Frobenius norm * For matrices, the comparison is done using the Hilbert-Schmidt norm (aka Frobenius norm
* L2 norm). * L2 norm).
* *

6
Eigen/src/Core/Map.h
View File

@ -34,7 +34,7 @@
* \tparam PlainObjectType the equivalent matrix type of the mapped data * \tparam PlainObjectType the equivalent matrix type of the mapped data
* \tparam MapOptions specifies whether the pointer is \c #Aligned, or \c #Unaligned. * \tparam MapOptions specifies whether the pointer is \c #Aligned, or \c #Unaligned.
* The default is \c #Unaligned. * The default is \c #Unaligned.
* \tparam StrideType optionnally specifies strides. By default, Map assumes the memory layout * \tparam StrideType optionally specifies strides. By default, Map assumes the memory layout
* of an ordinary, contiguous array. This can be overridden by specifying strides. * of an ordinary, contiguous array. This can be overridden by specifying strides.
* The type passed here must be a specialization of the Stride template, see examples below. * The type passed here must be a specialization of the Stride template, see examples below.
* *
@ -72,9 +72,9 @@
* Example: \include Map_placement_new.cpp * Example: \include Map_placement_new.cpp
* Output: \verbinclude Map_placement_new.out * Output: \verbinclude Map_placement_new.out
* *
* This class is the return type of Matrix::Map() but can also be used directly. * This class is the return type of PlainObjectBase::Map() but can also be used directly.
* *
* \sa Matrix::Map(), \ref TopicStorageOrders * \sa PlainObjectBase::Map(), \ref TopicStorageOrders
*/ */
namespace internal { namespace internal {

3
Eigen/src/Core/PlainObjectBase.h
View File

@ -425,9 +425,6 @@ class PlainObjectBase : public internal::dense_xpr_base<Derived>::type
* while the AlignedMap() functions return aligned Map objects and thus should be called only with 16-byte-aligned * while the AlignedMap() functions return aligned Map objects and thus should be called only with 16-byte-aligned
* \a data pointers. * \a data pointers.
* *
* These methods do not allow to specify strides. If you need to specify strides, you have to
* use the Map class directly.
*
* \see class Map * \see class Map
*/ */
//@{ //@{