[Boost-commit] svn:boost r61267 - sandbox/numeric_bindings/libs/numeric/bindings/doc

Subject: [Boost-commit] svn:boost r61267 - sandbox/numeric_bindings/libs/numeric/bindings/doc
From: rutger_at_[hidden]
Date: 2010-04-14 03:18:00

Author: rutger
Date: 2010-04-14 03:17:59 EDT (Wed, 14 Apr 2010)
New Revision: 61267
URL: http://svn.boost.org/trac/boost/changeset/61267

Log:
doc updates

Text files modified: 
   sandbox/numeric_bindings/libs/numeric/bindings/doc/numeric_bindings.qbk |    10 +++++-----                              
   sandbox/numeric_bindings/libs/numeric/bindings/doc/traits.qbk           |    40 ++++++++++++++++++++--------------------
   2 files changed, 25 insertions(+), 25 deletions(-)

Modified: sandbox/numeric_bindings/libs/numeric/bindings/doc/numeric_bindings.qbk
==============================================================================
--- sandbox/numeric_bindings/libs/numeric/bindings/doc/numeric_bindings.qbk	(original)
+++ sandbox/numeric_bindings/libs/numeric/bindings/doc/numeric_bindings.qbk	2010-04-14 03:17:59 EDT (Wed, 14 Apr 2010)
@@ -56,7 +56,7 @@
 * Adaptors for a wide variety of foreign container types, supporting both 
   compile-time statically sized and run-time dynamically sized containers.
   At the moment, the library includes bindings for C-style arrays, 
-  ISO C++ standard vectors, uBLAS', Eigen2, TNT, Boost.Array, 
+  ISO C++ standard vectors, uBLAS', Eigen2, Boost.Array, Boost.MultiArray,
   to name a few.
 * Meta-adaptors to create views on these containers, 
   such as row, transpose, and upper. These are convenient when addressing BLAS or LAPACK.
@@ -65,7 +65,10 @@
 * A BLAS module supporting cblas, blas, and cublas backends. This covers algorithms from 
   the reference BLAS, ATLAS, Intel's MKL, AMD's CML, NVidia's CUBLAS, and 
   many more vendor-specific BLASs.
-* LAPACK. 
+* A LAPACK module supporting lapack and clapack backends. This coverts algorithms from 
+  the reference LAPACK, and from the routines implemented by ATLAS.
+* A MUMPS module.
+* A UMFPACK module.
 
 Out of scope:
 
@@ -163,10 +166,7 @@
 
 [section Reference]
 [include blas.qbk]
-
-[/
 [include lapack.qbk]
-]
 
 [endsect]
 

Modified: sandbox/numeric_bindings/libs/numeric/bindings/doc/traits.qbk
==============================================================================
--- sandbox/numeric_bindings/libs/numeric/bindings/doc/traits.qbk	(original)
+++ sandbox/numeric_bindings/libs/numeric/bindings/doc/traits.qbk	2010-04-14 03:17:59 EDT (Wed, 14 Apr 2010)
@@ -4,20 +4,20 @@
 [section begin]
 
 ``
-// Entity stuff, e.g., in case of Matrix:
-begin< tag::index<1> >(m)        // Row iterator
-begin< tag::index<2> >(m)        // Column iterator
-begin< tag::row >(m)            // Same as <1>
-begin< tag::column >(m)         // Same as <2>
-begin< tag::major >(m)          // Depends on data_order
-begin< tag::minor >(m)          // Depends on data_order
+// Entity stuff, e.g., in case of m being a Matrix:
+begin( m, tag::addressing_index<1>() )  // Row iterator, only dense types supported at the moment
+begin( m, tag::addressing_index<2>() )  // Column iterator
+begin( m, tag::row() )            // Same as <1>
+begin( m, tag::column() )         // Same as <2>
+begin( m, tag::major() )          // Depends on data_order
+begin( m, tag::minor() )          // Depends on data_order
+
+begin( m, tag::index_major() )            // Sparse matrices
+begin( m, tag::index_minor() )            // Sparse matrices
+begin( m, tag::compressed_index_major() ) // Sparse matrices
 
 // Data stuff, e.g.,:
-begin< tag::value >(m)          // Begin of value array or main diagonal
-begin< tag::inner >(m)          // Begin of Yale sparse index array of row/columns
-begin< tag::outer >(m)          // Begin of Yale sparse starting points in row/columns
-begin< tag::subdiagonal >(m)    // Begin of subdiagonal value array
-begin< tag::superdiagonal >(m)  // Begin of superdiagonal value array
+begin( m, tag::value() )          // Begin of value array or main diagonal
 
 // Convenience
 begin1(m)                       // Convenience for tagged version
@@ -27,12 +27,12 @@
 begin_major(m)                  // Convenience for tagged version
 begin_minor(m)                  // Convenience for tagged version
 
+begin_index_major(m)            // Convenience for tagged version
+begin_index_minor(m)            // Convenience for tagged version
+begin_compressed_index_major(m) // Convenience for tagged version
+
 begin_value(m)                  // Convenience for tagged version
-begin_inner(m)                  // Convenience for tagged version
-begin_outer(m)                  // Convenience for tagged version
 
-begin_subdiagonal(m)            // Convenience for tagged version
-begin_superdiagonal(m)          // Convenience for tagged version
 ``
 
 [endsect]
@@ -58,10 +58,10 @@
 
 ``
 // E.g., for matrices
-stride< 1 >(m)                   // Stride for increment of index 1
-stride< 2 >(m)                   // Stride for increment of index 2
-stride< tag::major >(m)          // Depends on data_order
-stride< tag::minor >(m)          // Depends on data_order
+stride< 1() )                   // Stride for increment of index 1
+stride< 2() )                   // Stride for increment of index 2
+stride< tag::major() )          // Depends on data_order
+stride< tag::minor() )          // Depends on data_order
 
 // Convenience stuff
 stride1(m)