From 3d9764ee24f846d96a948680c2288032244e1dcb Mon Sep 17 00:00:00 2001 From: Jitse Niesen Date: Sat, 24 Jul 2010 16:43:07 +0100 Subject: Add some more examples for the API documentation. The only missing examples now are for homogeneous() and hnormalized(); I don't know what they're used for ... --- doc/examples/MatrixBase_cwise_const.cpp | 18 ++++++++++++++++++ doc/snippets/ColPivHouseholderQR_solve.cpp | 8 ++++++++ doc/snippets/DirectionWise_replicate.cpp | 4 ++++ doc/snippets/DirectionWise_replicate_int.cpp | 4 ++++ doc/snippets/FullPivHouseholderQR_solve.cpp | 8 ++++++++ doc/snippets/MatrixBase_replicate.cpp | 4 ++++ doc/snippets/MatrixBase_replicate_int_int.cpp | 4 ++++ 7 files changed, 50 insertions(+) create mode 100644 doc/examples/MatrixBase_cwise_const.cpp create mode 100644 doc/snippets/ColPivHouseholderQR_solve.cpp create mode 100644 doc/snippets/DirectionWise_replicate.cpp create mode 100644 doc/snippets/DirectionWise_replicate_int.cpp create mode 100644 doc/snippets/FullPivHouseholderQR_solve.cpp create mode 100644 doc/snippets/MatrixBase_replicate.cpp create mode 100644 doc/snippets/MatrixBase_replicate_int_int.cpp (limited to 'doc') diff --git a/doc/examples/MatrixBase_cwise_const.cpp b/doc/examples/MatrixBase_cwise_const.cpp new file mode 100644 index 000000000..23700e0b6 --- /dev/null +++ b/doc/examples/MatrixBase_cwise_const.cpp @@ -0,0 +1,18 @@ +#define EIGEN2_SUPPORT +#include +#include + +using namespace Eigen; +using namespace std; + +int main() +{ + Matrix3i m = Matrix3i::Random(); + cout << "Here is the matrix m:" << endl << m << endl; + Matrix3i n = Matrix3i::Random(); + cout << "And here is the matrix n:" << endl << n << endl; + cout << "The coefficient-wise product of m and n is:" << endl; + cout << m.cwise() * n << endl; + cout << "Taking the cube of the coefficients of m yields:" << endl; + cout << m.cwise().pow(3) << endl; +} diff --git a/doc/snippets/ColPivHouseholderQR_solve.cpp b/doc/snippets/ColPivHouseholderQR_solve.cpp new file mode 100644 index 000000000..b7b204a18 --- /dev/null +++ b/doc/snippets/ColPivHouseholderQR_solve.cpp @@ -0,0 +1,8 @@ +Matrix3f m = Matrix3f::Random(); +Matrix3f y = Matrix3f::Random(); +cout << "Here is the matrix m:" << endl << m << endl; +cout << "Here is the matrix y:" << endl << y << endl; +Matrix3f x; +x = m.colPivHouseholderQr().solve(y); +assert(y.isApprox(m*x)); +cout << "Here is a solution x to the equation mx=y:" << endl << x << endl; diff --git a/doc/snippets/DirectionWise_replicate.cpp b/doc/snippets/DirectionWise_replicate.cpp new file mode 100644 index 000000000..d92d4a350 --- /dev/null +++ b/doc/snippets/DirectionWise_replicate.cpp @@ -0,0 +1,4 @@ +MatrixXi m = MatrixXi::Random(2,3); +cout << "Here is the matrix m:" << endl << m << endl; +cout << "m.colwise().replicate<3>() = ..." << endl; +cout << m.colwise().replicate<3>() << endl; diff --git a/doc/snippets/DirectionWise_replicate_int.cpp b/doc/snippets/DirectionWise_replicate_int.cpp new file mode 100644 index 000000000..f9b1b5355 --- /dev/null +++ b/doc/snippets/DirectionWise_replicate_int.cpp @@ -0,0 +1,4 @@ +Vector3i v = Vector3i::Random(); +cout << "Here is the vector v:" << endl << v << endl; +cout << "v.rowwise().replicate(5) = ..." << endl; +cout << v.rowwise().replicate(5) << endl; diff --git a/doc/snippets/FullPivHouseholderQR_solve.cpp b/doc/snippets/FullPivHouseholderQR_solve.cpp new file mode 100644 index 000000000..23bc0749d --- /dev/null +++ b/doc/snippets/FullPivHouseholderQR_solve.cpp @@ -0,0 +1,8 @@ +Matrix3f m = Matrix3f::Random(); +Matrix3f y = Matrix3f::Random(); +cout << "Here is the matrix m:" << endl << m << endl; +cout << "Here is the matrix y:" << endl << y << endl; +Matrix3f x; +x = m.fullPivHouseholderQr().solve(y); +assert(y.isApprox(m*x)); +cout << "Here is a solution x to the equation mx=y:" << endl << x << endl; diff --git a/doc/snippets/MatrixBase_replicate.cpp b/doc/snippets/MatrixBase_replicate.cpp new file mode 100644 index 000000000..3ce52bcd5 --- /dev/null +++ b/doc/snippets/MatrixBase_replicate.cpp @@ -0,0 +1,4 @@ +MatrixXi m = MatrixXi::Random(2,3); +cout << "Here is the matrix m:" << endl << m << endl; +cout << "m.replicate<3,2>() = ..." << endl; +cout << m.replicate<3,2>() << endl; diff --git a/doc/snippets/MatrixBase_replicate_int_int.cpp b/doc/snippets/MatrixBase_replicate_int_int.cpp new file mode 100644 index 000000000..b1dbc70bc --- /dev/null +++ b/doc/snippets/MatrixBase_replicate_int_int.cpp @@ -0,0 +1,4 @@ +Vector3i v = Vector3i::Random(); +cout << "Here is the vector v:" << endl << v << endl; +cout << "v.replicate(2,5) = ..." << endl; +cout << v.replicate(2,5) << endl; -- cgit v1.2.3