Boost-Commit :

Date view	Thread view	Subject view	Author view

From: nesotto_at_[hidden]
Date: 2007-11-09 10:15:29

Next message: john_at_[hidden]: "[Boost-commit] svn:boost r40969 - trunk/boost/math/tools"
Previous message: markus.schoepflin_at_[hidden]: "[Boost-commit] svn:boost r40967 - trunk/boost/interprocess/detail"

Author: nesotto
Date: 2007-11-09 10:15:28 EST (Fri, 09 Nov 2007)
New Revision: 40968
URL: http://svn.boost.org/trac/boost/changeset/40968

Log:
improved reference
Text files modified:
trunk/libs/range/doc/boost_range.html | 169 ++++++++++++++++++++++++++-------------
1 files changed, 114 insertions(+), 55 deletions(-)

Modified: trunk/libs/range/doc/boost_range.html
==============================================================================
--- trunk/libs/range/doc/boost_range.html (original)
+++ trunk/libs/range/doc/boost_range.html 2007-11-09 10:15:28 EST (Fri, 09 Nov 2007)
@@ -71,6 +71,10 @@
class=identifier>range_value</a>;

 template< class T >
+ struct <a href="#range_reference">range_reference</a>;
+
+ template< class T >
 struct <a href="#range_pointer">range_pointer</a>;

@@ -101,23 +105,23 @@

 template< class T >
 typename range_iterator<T>::type
- begin( T& c );
+ begin( T& r );

 template< class T >
 typename range_iterator<const T>::type
- begin( const T& c );
+ begin( const T& r );

 template< class T >
 typename range_iterator<T>::type
- end( T& c );
+ end( T& r );

 template< class T >
 typename range_iterator<const T>::type
- end( const T& c );
+ end( const T& r );

 template< class T >
 bool
- empty( const T& c );
+ empty( const T& r );

 //
 // Forward Range functions
@@ -125,7 +129,7 @@

 template< class T >
 typename range_difference<T>::type
- distance( const T& c );
+ distance( const T& r );

 //
 // Bidirectional Range functions
@@ -133,20 +137,20 @@

 template< class T >
 typename range_reverse_iterator<T>::type
- rbegin( T& c );
+ rbegin( T& r );

 template< class T >
 typename range_reverse_iterator<const T>::type
- rbegin( const T& c );
+ rbegin( const T& r );

 template< class T >
 typename range_reverse_iterator<T>::type
- rend( T& c );
+ rend( T& r );

 template< class T >
 typename range_reverse_iterator<const T>::type
 rend( const T& c );
+class=identifier>T& r );
 
 //
 // Random Access Range functions
@@ -154,7 +158,7 @@

 template< class T >
 typename range_size<T>::type
- size( const T& c );
+ size( const T& r );

 //
 // Special const Range functions
@@ -176,6 +180,26 @@
 typename range_reverse_iterator<const T>::type 
 <a href="#const_rend">const_rend</a>( const T& r );

+ //
+ // String utilities
+ //
+
+ template< class T >
+ iterator_range<...see below...>
+ as_literal( T& r );
+
+ template< class T >
+ iterator_range<...see below...>
+ as_literal( const T& r );
+
+ template< class T >
+ iterator_range< typename range_iterator<T>::type >
+ as_array( T& r );
+
+ template< class T >
+ iterator_range< typename range_iterator<const T>::type >
+ as_array( const T& r );
+
} // namespace 'boost'

</pre>
@@ -236,19 +260,12 @@
 Complexity</th>
 </tr>
 <tr>
- <a name="range_value"></a>
- <td><code>range_value<X>::type</code></td>
- <td><code>boost::iterator_value<range_iterator<X>::type>::type</code>
- </td>
- <td>compile time</td>
- </tr>
- <tr>
 <a name="range_iterator"></a>
 <td><code>range_iterator<X>::type</code></td>
 <td><code>T::iterator</code> 
 <code>P::first_type</code> 
 <code>A*</code> 
- <code>Char*</code>
+
 <td>compile time</td>
 </tr>
 <tr>
@@ -257,7 +274,37 @@
 <td><code>T::const_iterator</code> 
 <code>P::first_type</code> 
 <code>const A*</code> 
- <code>const Char*</code>
+
+ <td>compile time</td>
+ </tr>
+ <tr>
+ <a name="range_value"></a>
+ <td><code>range_value<X>::type</code></td>
+ <td><code>boost::iterator_value<range_iterator<X>::type>::type</code>
+ </td>
+ <td>compile time</td>
+ </tr>
+ <tr>
+ <a name="range_reference"></a>
+ <td><code>range_reference<X>::type</code></td>
+ <td><code>boost::iterator_reference<range_iterator<X>::type>::type</code>
+ </td>
+ <td>compile time</td>
+ </tr>
+
+ <tr>
+ <a name="range_pointer"></a>
+ <td><code>range_pointer<X>::type</code></td>
+ <td><code>boost::iterator_pointer<range_iterator<X>::type>::type</code>
+ </td>
+ <td>compile time</td>
+ </tr>
+
+ <tr>
+ <a name="range_category"></a>
+ <td><code>range_category<X>::type</code></td>
+ <td><code>boost::iterator_category<range_iterator<X>::type>::type</code>
+ </td>
 <td>compile time</td>
 </tr>
 <tr>
@@ -269,15 +316,7 @@
 <td>compile time</td>
 </tr>
 </tr>
- <tr>
- <a name="range_result_iterator"></a>
- <td><code>range_result_iterator<X>::type</code></td>
- <td><code>range_const_iterator<X>::type</code> if <code>X</code> is <code>const</code>
- 
- <code>range_iterator<X>::type</code> otherwise
- </td>
- <td>compile time</td>
- </tr>
+
 <tr>
 <a name="range_reverse_iterator"></a>
 <td><code>range_reverse_iterator<X>::type</code></td>
@@ -309,11 +348,10 @@
 <tr>
 <a name="begin"></a>
 <td><code>begin(x)</code></td>
- <td><code>range_result_iterator<X>::type</code></td>
+ <td><code>range_iterator<X>::type</code></td>
 <td>
 <code>p.first</code> if <code>p</code> is of type <code>std::pair&ltT><code> 
 <code>a</code> if <code>a</code> is an array 
- <code>s</code> if <code>s</code> is a string literal 
 <code>range_begin(x)</code> if that expression would invoke a function found by ADL 
 <code>t.begin()</code> otherwise

@@ -322,29 +360,24 @@
 <tr>
 <a name="end"></a>
 <td><code>end(x)</code></td>
- <td><code>range_result_iterator<X>::type</code></td>
+ <td><code>range_iterator<X>::type</code></td>
 <td>
 <code>p.second</code> if <code>p</code> is of type <code>std::pair&ltT><code> 
- <code>a + sz</code> if <code>a</code> is an array of size <code>sz</code> 
- <code>s + std::char_traits<X>::length( s )</code> if <code>s</code> is a <code>Char*</code>
- 
- <code>s + sz - 1</code> if <code>s</code> is a string literal of size <code>sz</code>
+ <code>a + sz</code> if <code>a</code> is an array of size <code>sz</code>
+
 
 <code>range_end(x)</code> if that expression would invoke a function found by ADL 
 <code>t.end()</code> otherwise

- <td>linear if <code>X</code> is <code>Char*</code>
- 
- constant time otherwise</td>
+ <td>
+ constant time </td>
 </tr>
 <tr>
 <a name="empty"></a>
 <td><code>empty(x)</code></td>
 <td><code>bool</code></td>
- <td><code>begin(x) == end( x )</code> 
- <td>linear if <code>X</code> is <code>Char*</code>
- 
- constant time otherwise 
+ <td><code>boost::begin(x) == boost::end(x)</code> 
+ <td> constant time 
 </td>
 </tr>
 <tr>
@@ -372,49 +405,71 @@
 <a name="rbegin"></a>
 <td><code>rbegin(x)</code></td>
 <td><code>range_reverse_iterator<X>::type</code></td>
- <td><code>range_reverse_iterator<X>::type( end(x) )</code>
+ <td><code>range_reverse_iterator<X>::type( boost::end(x) )</code>
 
- <td>same as <code>end(x)</code>
+ <td>constant time
 </td>
 </tr>
 <tr>
 <a name="rend"></a>
 <td><code>rend(x)</code></td>
 <td><code>range_reverse_iterator<X>::type</code></td>
- <td><code>range_reverse_iterator<X>::type( begin(x) )</code>
- <td>same as <code>begin(x)</code></td>
+ <td><code>range_reverse_iterator<X>::type( boost::begin(x) )</code>
+ <td>constant time</td>
 </tr>
 <tr>
 <a name="const_begin"></a>
 <td><code>const_begin(x)</code></td>
 <td><code>range_iterator<const X>::type</code></td>
- <td><code>range_iterator<const X>::type( begin(x) )</code>
+ <td><code>range_iterator<const X>::type( boost::begin(x) )</code>
 
- <td>same as <code>begin(x)</code>
+ <td>constant time
 </td>
 </tr>
 <tr>
 <a name="const_end"></a>
 <td><code>const_end(x)</code></td>
 <td><code>range_iterator<const X>::type</code></td>
- <td><code>range_iterator<const X>::type( end(x) )</code>
- <td>same as <code>end(x)</code></td>
+ <td><code>range_iterator<const X>::type( boost::end(x) )</code>
+ <td>constant time</td>
 </tr>
 <tr>
 <a name="const_rbegin"></a>
 <td><code>const_rbegin(x)</code></td>
 <td><code>range_reverse_iterator<const X>::type</code></td>
- <td><code>range_reverse_iterator<const X>::type( rbegin(x) )</code>
+ <td><code>range_reverse_iterator<const X>::type( boost::rbegin(x) )</code>
 
- <td>same as <code>rbegin(x)</code>
+ <td>constant time
 </td>
 </tr>
 <tr>
 <a name="const_rend"></a>
 <td><code>const_rend(x)</code></td>
 <td><code>range_reverse_iterator<const X>::type</code></td>
- <td><code>range_reverse_iterator<const X>::type( rend(x) )</code>
- <td>same as <code>rend(x)</code></td>
+ <td><code>range_reverse_iterator<const X>::type( boost::rend(x) )</code>
+
+ <td>constant time</td>
+ </tr>
+ <tr>
+ <a name="as_literal"></a>
+ <td><code>as_literal(x)</code></td>
+ <td><code>iterator_range</code> where <code>U</code> is
+ <code>Char*</code> if <code>x</code> is a pointer to a
+ string and <code>U</code> is
+ <code>range_iterator<X>::type</code> otherwise
+ </td>
+ <td>
+
+ <code>[a,a+sz-1)</code> if <code>a</code> is an array of size <code>sz</code> 
+ <code>[s,s + std::char_traits<X>::length(s))</code> if <code>s</code> is a <code>Char*</code>
+ 
+ <code>[boost::begin(x),boost::end(x))</code> otherwise
+
+
+
+ </td>
+ <td>linear time for pointers to a string, constant time
+ otherwise</td>
 </tr>
 </table>
 
@@ -422,6 +477,10 @@
 The special <code>const_</code>-named functions are useful when you
 want to document clearly that your code is read-only.
 
+ Notice that the above functions should always be called with
+ qualification (<code>boost::</code>) to prevent unintended
+ Argument Dependent Lookup (ADL).
+ 
 <hr>
 <a name="minimal_interface"></a>
 <h3>Extending the library</h3>

Next message: john_at_[hidden]: "[Boost-commit] svn:boost r40969 - trunk/boost/math/tools"
Previous message: markus.schoepflin_at_[hidden]: "[Boost-commit] svn:boost r40967 - trunk/boost/interprocess/detail"

Date view	Thread view	Subject view	Author view

Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk