From: karl.meerbergen_at_[hidden]
Date: 2008-09-01 10:42:21
Author: karlmeerbergen
Date: 2008-09-01 10:42:21 EDT (Mon, 01 Sep 2008)
New Revision: 48512
URL: http://svn.boost.org/trac/boost/changeset/48512
Log:
changed documentation following recent modifications:
- std::ptrdiff_t
- size1, size2 --> num_rows, num_columns
Text files modified:
sandbox/libs/numeric/bindings/traits/doc/index.html | 42 ++++++++++++++++++++--------------------
1 files changed, 21 insertions(+), 21 deletions(-)
Modified: sandbox/libs/numeric/bindings/traits/doc/index.html
==============================================================================
--- sandbox/libs/numeric/bindings/traits/doc/index.html (original)
+++ sandbox/libs/numeric/bindings/traits/doc/index.html 2008-09-01 10:42:21 EDT (Mon, 01 Sep 2008)
@@ -209,8 +209,8 @@
typedef T value_type;
typedef typename detail::generate_const<V,T>::type* pointer;
static pointer storage (V& v) { return v.begin(); }
- static int size (V& v) { return v.size(); }
- static int stride (V& v) { return 1; }
+ static std::ptrdiff_t size (V& v) { return v.size(); }
+ static std::ptrdiff_t stride (V& v) { return 1; }
};
</pre>
@@ -277,8 +277,8 @@
typedef T value_type;
typedef typename detail::generate_const<VType,T>::type* pointer;
static pointer storage (VType& a) { return a; }
- static int size (VType&) { return N; }
- static int stride (VType&) { return 1; }
+ static std::ptrdiff_t size (VType&) { return N; }
+ static std::ptrdiff_t stride (VType&) { return 1; }
};
</pre>
@@ -378,8 +378,8 @@
<tr><td>Beginning of storage<td><code>storage(m)</code><td>Returns a pointer to the
beginning of the storage of matrix <code>m</code>
<tr><td>Size of storage<td><code>storage_size(m)</code><td>Returns the size of the storage
-<tr><td>Number of rows<td><code>size1(m)</code><td>Returns the number of rows of matrix <code>m</code>
-<tr><td>Number of columns<td><code>size2(m)</code><td>Returns the number of
+<tr><td>Number of rows<td><code>num_rows(m)</code><td>Returns the number of rows of matrix <code>m</code>
+<tr><td>Number of columns<td><code>num_columns(m)</code><td>Returns the number of
columns matrix <code>m</code>
<tr><td>Leading
dimension<td><code>leading_dimension(m)</code><td>Returns the distance
@@ -397,7 +397,7 @@
(subsection 1.3.5); only, first step is omitted because
there is no reasonable default -- different matrix libraries provide
different interfaces (for example, functions that return number of
-rows and columns are named <code>size1()</code>, <code>size2()</code>
+rows and columns are named <code>num_rows()</code>, <code>num_columns()</code>
in uBLAS, <code>dim1()</code>, <code>dim2()</code> in TNT,
and <code>nrows()</code>, <code>ncols()</code> in MTL).
Definitions in <code>matrix_traits.hpp</code> are:
@@ -427,17 +427,17 @@
typedef T value_type;
typedef typename detail::generate_const<MType,T>::type* pointer;
- static pointer storage (MType& m) {
+ static pointer storage (MType& m) {
typedef typename detail::generate_const<MType,ArrT>::type array_type;
return vector_traits<array_type>::storage (m.data());
}
- static int size1 (MType& m) { return m.size1(); }
- static int size2 (MType& m) { return m.size2(); }
- static int storage_size (MType& m) { return size1 (m) * size2 (m); }
- static int leading_dimension (MType& m) { return F::size2 (m.size1(), m.size2()); }
+ static std::ptrdiff_t num_rows (MType& m) { return m.size1(); }
+ static std::ptrdiff_t num_columns (MType& m) { return m.size2(); }
+ static std::ptrdiff_t storage_size (MType& m) { return num_rows (m) * size2 (m); }
+ static std::ptrdiff_t leading_dimension (MType& m) { return F::size2 (m.size1(), m.size2()); }
- static int stride1 (MType& m) { return F::one1 (m.size1(), m.size2()); }
- static int stride2 (MType& m) { return F::one2 (m.size1(), m.size2()); }
+ static std::ptrdiff_t stride1 (MType& m) { return F::one1 (m.size1(), m.size2()); }
+ static std::ptrdiff_t stride2 (MType& m) { return F::one2 (m.size1(), m.size2()); }
};
</pre>
@@ -482,9 +482,9 @@
typedef typename detail::generate_const<MType,A>::type array_type ;
return vector_traits<array_type>::storage (sm.data());
}
- static int size1 (MType& sm) { return sm.size1(); }
- static int size2 (MType& sm) { return sm.size2(); }
- static int storage_size (MType& sm) { return (size1 (sm) + 1) * size2 (sm) / 2; }
+ static std::ptrdiff_t num_rows (MType& sm) { return sm.size1(); }
+ static std::ptrdiff_t num_columns (MType& sm) { return sm.size2(); }
+ static std::ptrdiff_t storage_size (MType& sm) { return (num_rows (sm) + 1) * num_columns (sm) / 2; }
};
</pre>
@@ -564,8 +564,8 @@
Depends on <code>storage_format</code> and <code>ordering_type</code> [2]
<tr><td>Element storage<td><code>storage(m)</code><td>Returns a pointer to the
beginning of the storage of matrix entries [3]
-<tr><td>Number of rows<td><code>size1(m)</code><td>Returns the number of rows of matrix <code>m</code>
-<tr><td>Number of columns<td><code>size2(m)</code><td>Returns the number of
+<tr><td>Number of rows<td><code>num_rows(m)</code><td>Returns the number of rows of matrix <code>m</code>
+<tr><td>Number of columns<td><code>num_columns(m)</code><td>Returns the number of
columns matrix <code>m</code>
<tr><td>Number of entries<td><code>num_nonzeros(m)</code><td>Returns
the number of matrix entries [3]
@@ -636,8 +636,8 @@
<tr><td><code>matrix_storage(m)</code><td>Returns a pointer to the
beginning of the storage of matrix <code>m</code>
<tr><td><code>matrix_storage_size(m)</code><td>Returns the size of the storage
-<tr><td><code>matrix_size1(m)</code><td>Returns the number of rows of matrix <code>m</code>
-<tr><td><code>matrix_size2(m)</code><td>Returns the number of
+<tr><td><code>matrix_num_rows(m)</code><td>Returns the number of rows of matrix <code>m</code>
+<tr><td><code>matrix_num_columns(m)</code><td>Returns the number of
columns matrix <code>m</code>
<tr><td><code>leading_dimension(m)</code><td>Returns the leading
dimension of matrix <code>m</code>