diff options
author | Benoit Jacob <jacob.benoit.1@gmail.com> | 2008-01-13 23:38:48 +0000 |
---|---|---|
committer | Benoit Jacob <jacob.benoit.1@gmail.com> | 2008-01-13 23:38:48 +0000 |
commit | 183bf54d27c948219585f52657355338eb695d08 (patch) | |
tree | bc7162ce64d582dd2e2cf4fad7be027058b32f0b /doc | |
parent | 57d7b7d97bc5f57bcf587708a3647da0dce73fea (diff) |
final fixes and updates for alpha3
Diffstat (limited to 'doc')
-rw-r--r-- | doc/Doxyfile.in | 2 | ||||
-rw-r--r-- | doc/Mainpage.dox | 8 | ||||
-rw-r--r-- | doc/examples/class_Block.cpp | 18 | ||||
-rw-r--r-- | doc/examples/class_DynBlock.cpp | 26 | ||||
-rw-r--r-- | doc/examples/class_FixedBlock.cpp | 26 |
5 files changed, 42 insertions, 38 deletions
diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index fc699b0d0..6462239e0 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -5,7 +5,7 @@ #--------------------------------------------------------------------------- DOXYFILE_ENCODING = UTF-8 PROJECT_NAME = Eigen -PROJECT_NUMBER = 2.0-alpha2 +PROJECT_NUMBER = 2.0-alpha3 OUTPUT_DIRECTORY = ${CMAKE_BINARY_DIR}/doc CREATE_SUBDIRS = NO OUTPUT_LANGUAGE = English diff --git a/doc/Mainpage.dox b/doc/Mainpage.dox index 29ee996eb..0ca176854 100644 --- a/doc/Mainpage.dox +++ b/doc/Mainpage.dox @@ -42,7 +42,11 @@ Here are general features of Eigen and more specific features of the Core module \code matrix.row(i) += factor * matrix.row(j); \endcode</li> <li>Both fixed-size and dynamic-size objects are supported, with uniform API, in a way that allows Eigen to make - all usual optimizations in the case of fixed size, such as loop unrolling.</li> + all usual optimizations in the case of fixed size, such as loop unrolling. Moreover + special care is used to ensure that the fixed-size types never cause dynamic memory + allocations. Even when the dimensions of an expression at not known at compile-time, + if a fixed bound is known (e.g. when taking a block in a fixed-size matrix) then + Eigen uses it to allocate a static array instead of a dynamic one.</li> <li>Both column-vectors and row-vectors are supported, as special cases of matrices.</li> <li>The following scalar types are supported and well tested: \c int, \c float, \c double, \c std::complex<float>, \c std::complex<double>. </li> @@ -69,7 +73,7 @@ If you want to stay informed of Eigen news and releases, please subscribe to our <a name="download"></a> <h2>Download</h2> -The source code of the latest release is here: <a href="http://download.tuxfamily.org/eigen/eigen-2.0-alpha2.tar.gz">eigen-2.0-alpha2.tar.gz</a><br/> +The source code of the latest release is here: <a href="http://download.tuxfamily.org/eigen/eigen-2.0-alpha3.tar.gz">eigen-2.0-alpha3.tar.gz</a><br/> Alternatively, you can checkout the development tree by anonymous svn, by doing: <pre>svn co svn://anonsvn.kde.org/home/kde/branches/work/eigen2</pre> diff --git a/doc/examples/class_Block.cpp b/doc/examples/class_Block.cpp index b34cf13ad..6d48d235d 100644 --- a/doc/examples/class_Block.cpp +++ b/doc/examples/class_Block.cpp @@ -3,24 +3,24 @@ USING_PART_OF_NAMESPACE_EIGEN using namespace std; template<typename Scalar, typename Derived> -Eigen::FixedBlock<Derived, 2, 2> -topLeft2x2Corner(MatrixBase<Scalar, Derived>& m) +Eigen::Block<Derived> +topLeftCorner(MatrixBase<Scalar, Derived>& m, int rows, int cols) { - return Eigen::FixedBlock<Derived, 2, 2>(m.ref(), 0, 0); + return Eigen::Block<Derived>(m.ref(), 0, 0, rows, cols); } template<typename Scalar, typename Derived> -const Eigen::FixedBlock<Derived, 2, 2> -topLeft2x2Corner(const MatrixBase<Scalar, Derived>& m) +const Eigen::Block<Derived> +topLeftCorner(const MatrixBase<Scalar, Derived>& m, int rows, int cols) { - return Eigen::FixedBlock<Derived, 2, 2>(m.ref(), 0, 0); + return Eigen::Block<Derived>(m.ref(), 0, 0, rows, cols); } int main(int, char**) { - Matrix3d m = Matrix3d::identity(); - cout << topLeft2x2Corner(4*m) << endl; // calls the const version - topLeft2x2Corner(m) *= 2; // calls the non-const version + Matrix4d m = Matrix4d::identity(); + cout << topLeftCorner(4*m, 2, 3) << endl; // calls the const version + topLeftCorner(m, 2, 3) *= 5; // calls the non-const version cout << "Now the matrix m is:" << endl << m << endl; return 0; } diff --git a/doc/examples/class_DynBlock.cpp b/doc/examples/class_DynBlock.cpp deleted file mode 100644 index 6d48d235d..000000000 --- a/doc/examples/class_DynBlock.cpp +++ /dev/null @@ -1,26 +0,0 @@ -#include <Eigen/Core> -USING_PART_OF_NAMESPACE_EIGEN -using namespace std; - -template<typename Scalar, typename Derived> -Eigen::Block<Derived> -topLeftCorner(MatrixBase<Scalar, Derived>& m, int rows, int cols) -{ - return Eigen::Block<Derived>(m.ref(), 0, 0, rows, cols); -} - -template<typename Scalar, typename Derived> -const Eigen::Block<Derived> -topLeftCorner(const MatrixBase<Scalar, Derived>& m, int rows, int cols) -{ - return Eigen::Block<Derived>(m.ref(), 0, 0, rows, cols); -} - -int main(int, char**) -{ - Matrix4d m = Matrix4d::identity(); - cout << topLeftCorner(4*m, 2, 3) << endl; // calls the const version - topLeftCorner(m, 2, 3) *= 5; // calls the non-const version - cout << "Now the matrix m is:" << endl << m << endl; - return 0; -} diff --git a/doc/examples/class_FixedBlock.cpp b/doc/examples/class_FixedBlock.cpp new file mode 100644 index 000000000..b34cf13ad --- /dev/null +++ b/doc/examples/class_FixedBlock.cpp @@ -0,0 +1,26 @@ +#include <Eigen/Core> +USING_PART_OF_NAMESPACE_EIGEN +using namespace std; + +template<typename Scalar, typename Derived> +Eigen::FixedBlock<Derived, 2, 2> +topLeft2x2Corner(MatrixBase<Scalar, Derived>& m) +{ + return Eigen::FixedBlock<Derived, 2, 2>(m.ref(), 0, 0); +} + +template<typename Scalar, typename Derived> +const Eigen::FixedBlock<Derived, 2, 2> +topLeft2x2Corner(const MatrixBase<Scalar, Derived>& m) +{ + return Eigen::FixedBlock<Derived, 2, 2>(m.ref(), 0, 0); +} + +int main(int, char**) +{ + Matrix3d m = Matrix3d::identity(); + cout << topLeft2x2Corner(4*m) << endl; // calls the const version + topLeft2x2Corner(m) *= 2; // calls the non-const version + cout << "Now the matrix m is:" << endl << m << endl; + return 0; +} |