aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorGravatar Jitse Niesen <jitse@maths.leeds.ac.uk>2011-12-08 14:22:06 +0000
committerGravatar Jitse Niesen <jitse@maths.leeds.ac.uk>2011-12-08 14:22:06 +0000
commitdd232e30b0a0ce4e8fe13622fe28d293b1ed40f5 (patch)
treecd4c7f761f6e20c009e165fcf0b7785578363a2d
parenta1fa05f14e312d3e05914d2fe40ef04c2ac34b66 (diff)
Document QuaternionBase, minor doc improvements.
* Document class QuaternionBase so that docs for members are displayed. * Remove obsolete \redstar refering to Array module * Fix typo in Constants.h * Document EIGEN_NO_AUTOMATIC_RESIZING
-rw-r--r--Eigen/src/Core/util/Constants.h4
-rw-r--r--Eigen/src/Geometry/Quaternion.h6
-rw-r--r--doc/Doxyfile.in1
-rw-r--r--doc/I14_PreprocessorDirectives.dox3
-rw-r--r--doc/QuickReference.dox6
-rw-r--r--unsupported/doc/Doxyfile.in1
6 files changed, 14 insertions, 7 deletions
diff --git a/Eigen/src/Core/util/Constants.h b/Eigen/src/Core/util/Constants.h
index cd7cdfd7c..da67649c3 100644
--- a/Eigen/src/Core/util/Constants.h
+++ b/Eigen/src/Core/util/Constants.h
@@ -378,7 +378,7 @@ enum QRPreconditioners {
#error The preprocessor symbol 'Success' is defined, possibly by the X11 header file X.h
#endif
-/** \ingroups enums
+/** \ingroup enums
* Enum for reporting the status of a computation. */
enum ComputationInfo {
/** Computation was successful. */
@@ -387,7 +387,7 @@ enum ComputationInfo {
NumericalIssue = 1,
/** Iterative procedure did not converge. */
NoConvergence = 2,
- /** The inputs are invalid, or the algorithm has been properly called.
+ /** The inputs are invalid, or the algorithm has been improperly called.
* When assertions are enabled, such errors trigger an assert. */
InvalidInput = 3
};
diff --git a/Eigen/src/Geometry/Quaternion.h b/Eigen/src/Geometry/Quaternion.h
index b2f127b6a..c6c2213ab 100644
--- a/Eigen/src/Geometry/Quaternion.h
+++ b/Eigen/src/Geometry/Quaternion.h
@@ -38,6 +38,12 @@ template<typename Other,
struct quaternionbase_assign_impl;
}
+/** \geometry_module \ingroup Geometry_Module
+ * \class QuaternionBase
+ * \brief Base class for quaternion expressions
+ * \tparam Derived derived type (CRTP)
+ * \sa class Quaternion
+ */
template<class Derived>
class QuaternionBase : public RotationBase<Derived, 3>
{
diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in
index 6a659d9c2..94a0cf44b 100644
--- a/doc/Doxyfile.in
+++ b/doc/Doxyfile.in
@@ -206,7 +206,6 @@ ALIASES = "only_for_vectors=This is only for vectors (either row-
"qr_module=This is defined in the %QR module. \code #include <Eigen/QR> \endcode" \
"svd_module=This is defined in the %SVD module. \code #include <Eigen/SVD> \endcode" \
"label=\bug" \
- "redstar=<a href='#warningarraymodule' style='color:red;text-decoration: none;'>*</a>" \
"matrixworld=<a href='#matrixonly' style='color:green;text-decoration: none;'>*</a>" \
"arrayworld=<a href='#arrayonly' style='color:blue;text-decoration: none;'>*</a>" \
"note_about_arbitrary_choice_of_solution=If there exists more than one solution, this method will arbitrarily choose one." \
diff --git a/doc/I14_PreprocessorDirectives.dox b/doc/I14_PreprocessorDirectives.dox
index 3d3cf0246..81ec3963e 100644
--- a/doc/I14_PreprocessorDirectives.dox
+++ b/doc/I14_PreprocessorDirectives.dox
@@ -29,6 +29,9 @@ This page lists the preprocesor tokens recognised by %Eigen.
Defaults to the #IOFormat constructed by the default constructor IOFormat().
- \b EIGEN_INITIALIZE_MATRICES_BY_ZERO - if defined, all entries of newly constructed matrices and arrays are
initializes to zero, as are new entries in matrices and arrays after resizing. Not defined by default.
+ - \b EIGEN_NO_AUTOMATIC_RESIZING - if defined, the matrices (or arrays) on both sides of an assignment
+ <tt>a = b</tt> have to be of the same size; otherwise, %Eigen automatically resizes \c a so that it is of
+ the correct size. Not defined by default.
\section TopicPreprocessorDirectivesAssertions Assertions
diff --git a/doc/QuickReference.dox b/doc/QuickReference.dox
index 68845772d..65cdf527e 100644
--- a/doc/QuickReference.dox
+++ b/doc/QuickReference.dox
@@ -440,10 +440,10 @@ Eigen provides several reduction methods such as:
\link DenseBase::sum() sum() \endlink, \link DenseBase::prod() prod() \endlink,
\link MatrixBase::trace() trace() \endlink \matrixworld,
\link MatrixBase::norm() norm() \endlink \matrixworld, \link MatrixBase::squaredNorm() squaredNorm() \endlink \matrixworld,
-\link DenseBase::all() all() \endlink \redstar,and \link DenseBase::any() any() \endlink \redstar.
+\link DenseBase::all() all() \endlink, and \link DenseBase::any() any() \endlink.
All reduction operations can be done matrix-wise,
-\link DenseBase::colwise() column-wise \endlink \redstar or
-\link DenseBase::rowwise() row-wise \endlink \redstar. Usage example:
+\link DenseBase::colwise() column-wise \endlink or
+\link DenseBase::rowwise() row-wise \endlink. Usage example:
<table class="manual">
<tr><td rowspan="3" style="border-right-style:dashed;vertical-align:middle">\code
5 3 1
diff --git a/unsupported/doc/Doxyfile.in b/unsupported/doc/Doxyfile.in
index 2e309bbdb..bb9da3b7e 100644
--- a/unsupported/doc/Doxyfile.in
+++ b/unsupported/doc/Doxyfile.in
@@ -203,7 +203,6 @@ ALIASES = "only_for_vectors=This is only for vectors (either row-
"svd_module=This is defined in the %SVD module. \code #include <Eigen/SVD> \endcode" \
"geometry_module=This is defined in the %Geometry module. \code #include <Eigen/Geometry> \endcode" \
"label=\bug" \
- "redstar=<a href='#warningarraymodule' style='color:red;text-decoration: none;'>*</a>" \
"nonstableyet=\warning This is not considered to be part of the stable public API yet. Changes may happen in future releases. See \ref Experimental \"Experimental parts of Eigen\""
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C