Changeset 2275

Timestamp:

Jun 23, 2010, 12:29:28 AM (11 years ago)

Author:

Peter

Message:

improve docs for compose_functors

File:

• trunk/yat/utility/stl_utility.h (modified) (3 diffs)

trunk/yat/utility/stl_utility.h

@@ -101 +101 @@
      to \f$ f(g(x), h(y)) \f$
 
-     F must be an adaptable binary functor
-     G must be an adaptable unary functor
-     H must be an adaptable unary functor
+     - F must be an <a
+     href="http://www.sgi.com/tech/stl/AdaptableBinaryFunction.html">
+     AdaptableBinaryFunction</a>
+     - G must be an <a
+     href="http://www.sgi.com/tech/stl/AdaptableUnaryFunction.html">
+     AdaptableUnaryFunction</a> 
+     - H must be an <a
+     href="http://www.sgi.com/tech/stl/AdaptableUnaryFunction.html">
+     AdaptableUnaryFunction</a> 
+     - \c G::result_type is convertible to \c F::first_argument_type
+     - \c H::result_type is convertible to \c F::second_argument_type
+
+     \see compose_f_gxy and compose_f_gx
    */
   template<class F, class G, class H>
@@ -164 +174 @@
      \f$ f(g(x,y)) \f$
 
-     F must be an adaptable unary functor
-     G must be an adaptable binary functor
+     - F must be an <a
+     href="http://www.sgi.com/tech/stl/AdaptableUnaryFunction.html">
+     AdaptableUnaryFunction</a>
+     - G must be an <a
+     href="http://www.sgi.com/tech/stl/AdaptableBinaryFunction.html">
+     AdaptableBinaryFunction</a> 
+     - \c G::result_type is convertible to \c F::argument_type
+
+     \see compose_f_gx_hy and compose_f_gx
 
      \since New in yat 0.7
@@ -225 +242 @@
      used to create a functor equivalent to \f$ f(g(x)) \f$
 
-     F must be an adaptable binary functor
-     G must be an adaptable unary functor
+     - F must be an <a
+     href="http://www.sgi.com/tech/stl/AdaptableBinaryFunction.html">
+     AdaptableBinaryFunction</a>
+     - G must be an <a
+     href="http://www.sgi.com/tech/stl/AdaptableUnaryFunction.html">
+     AdaptableUnaryFunction</a> 
+     - \c G::result_type is convertible to \c F::argument_type
+
+     \see compose_f_gx_hy and compose_f_gxy
 
      \since New in yat 0.7