[Boost-commit] svn:boost r83399 - in trunk/libs/math: doc/sf_and_dist example

Subject: [Boost-commit] svn:boost r83399 - in trunk/libs/math: doc/sf_and_dist example
From: john_at_[hidden]
Date: 2013-03-10 13:20:56

Author: johnmaddock
Date: 2013-03-10 13:20:55 EDT (Sun, 10 Mar 2013)
New Revision: 83399
URL: http://svn.boost.org/trac/boost/changeset/83399

Log:
Beautify formatting a little.
Text files modified: 
   trunk/libs/math/doc/sf_and_dist/bessel_jy.qbk      |    79 +++++++++++++++++++++++---------------- 
   trunk/libs/math/example/bessel_zeros_example_1.cpp |    25 +++++++-----                            
   2 files changed, 60 insertions(+), 44 deletions(-)

Modified: trunk/libs/math/doc/sf_and_dist/bessel_jy.qbk
==============================================================================
--- trunk/libs/math/doc/sf_and_dist/bessel_jy.qbk	(original)
+++ trunk/libs/math/doc/sf_and_dist/bessel_jy.qbk	2013-03-10 13:20:55 EDT (Sun, 10 Mar 2013)
@@ -290,53 +290,66 @@
 The signature of the single value functions are:
 
   template <class T>
-  T cyl_bessel_j_zero(T v,  // Floating-point value for Jv.
-    int m); // 1-based index of zero.
+  T cyl_bessel_j_zero(
+           T v,            // Floating-point value for Jv.
+           int m);         // 1-based index of zero.
+
   template <class T>
-  T cyl_neumann_zero(T v,  // Floating-point value for Jv.
-    int m); // 1-based index of zero.
+  T cyl_neumann_zero(
+           T v,            // Floating-point value for Jv.
+           int m);         // 1-based index of zero.
 
 and for multiple zeros:
 
  template <class T, class OutputIterator>
- OutputIterator cyl_bessel_j_zero(T v, // Floating-point value for Jv.
-                                int start_index, // 1-based index of zero.
-                                unsigned number_of_zeros,
-                                OutputIterator out_it); //
+ OutputIterator cyl_bessel_j_zero(
+                      T v,                       // Floating-point value for Jv.
+                      int start_index,           // 1-based index of first zero.
+                      unsigned number_of_zeros,  // How many zeros to generate
+                      OutputIterator out_it);    // Destination for zeros
+
  template <class T, class OutputIterator>
- OutputIterator cyl_neumann_zero(T v, // Floating-point value for Jv.
-                                int start_index, // 1-based index of zero.
-                                unsigned number_of_zeros,
-                                OutputIterator out_it); //
+ OutputIterator cyl_neumann_zero(
+                      T v,                       // Floating-point value for Jv.
+                      int start_index,           // 1-based index of zero.
+                      unsigned number_of_zeros,  // How many zeros to generate
+                      OutputIterator out_it);    // Destination for zeros
 
 There are also versions which allow control of the
 __policy_section for error handling and precision.
 
+template <class T>
+  T cyl_bessel_j_zero(
+           T v,            // Floating-point value for Jv.
+           int m,          // 1-based index of zero.
+           const Policy&); // Policy to use
+
   template <class T>
-  T cyl_bessel_j_zero(T v,  // Floating-point value for Jv.
-    int m,  // 1-based start index.
-    const Policy& pol); // Policy
-  template <class T>
-  T cyl_neumann_zero(T v,  // Floating-point value for Jv.
-    int m,  // 1-based start index.
-    const Policy& pol); // Policy
-
-  template <class T, class OutputIterator, class Policy>
-  OutputIterator cyl_bessel_j_zero(T v, // Floating-point value for Jv.
-                                int start_index, // 1-based start index.
-                                unsigned number_of_zeros,
-                                OutputIterator out_it,
-                                const Policy& pol);
-  template <class T, class OutputIterator, class Policy>
-  OutputIterator cyl_neumann_zero(T v, // Floating-point value for Jv.
-                                int start_index, // 1-based start index.
-                                unsigned number_of_zeros,
-                                OutputIterator out_it,
-                                const Policy& pol);
+  T cyl_neumann_zero(
+           T v,            // Floating-point value for Jv.
+           int m,          // 1-based index of zero.
+           const Policy&); // Policy to use
+
+
+ template <class T, class OutputIterator>
+ OutputIterator cyl_bessel_j_zero(
+                      T v,                       // Floating-point value for Jv.
+                      int start_index,           // 1-based index of first zero.
+                      unsigned number_of_zeros,  // How many zeros to generate
+                      OutputIterator out_it,     // Destination for zeros
+                      const Policy& pol);        // Policy to use
+
+ template <class T, class OutputIterator>
+ OutputIterator cyl_neumann_zero(
+                      T v,                       // Floating-point value for Jv.
+                      int start_index,           // 1-based index of zero.
+                      unsigned number_of_zeros,  // How many zeros to generate
+                      OutputIterator out_it,     // Destination for zeros
+                      const Policy& pol);        // Policy to use
 
 [h4 Description]
 
-For every real order [nu] cylindrical Bessel and Neumann functions have an infinite
+Every real order [nu] cylindrical Bessel and Neumann functions have an infinite
 number of zeros on the positive real axis. The real zeros on the positive real
 axis can be found by solving for the roots of
 

Modified: trunk/libs/math/example/bessel_zeros_example_1.cpp
==============================================================================
--- trunk/libs/math/example/bessel_zeros_example_1.cpp	(original)
+++ trunk/libs/math/example/bessel_zeros_example_1.cpp	2013-03-10 13:20:55 EDT (Sun, 10 Mar 2013)
@@ -56,8 +56,9 @@
 
   template <class T>
   inline typename detail::bessel_traits<T, T, policies::policy<> >::result_type
-    cyl_bessel_j_zero(T v,  // Floating-point value for Jv.
-    int m); // start index.
+    cyl_bessel_j_zero(
+           T v,      // Floating-point value for Jv.
+           int m);   // start index.
 
 The result type is controlled by the floating-point type of parameter `v`
 (but subject to the usual __precision_policy and __promotion_policy).
@@ -65,19 +66,21 @@
 The signature of multiple zeros function is:
 
   template <class T, class OutputIterator>
-  inline OutputIterator cyl_bessel_j_zero(T v, // Floating-point value for Jv.
-                                int start_index, // 1-based start index.
-                                unsigned number_of_zeros,
-                                OutputIterator out_it); // iterator into container for zeros.
+  inline OutputIterator cyl_bessel_j_zero(
+                                T v,                      // Floating-point value for Jv.
+                                int start_index,          // 1-based start index.
+                                unsigned number_of_zeros, // How many zeros to generate
+                                OutputIterator out_it);   // Destination for zeros.
 
 There is also a version which allows control of the __policy_section for error handling and precision.
 
   template <class T, class OutputIterator, class Policy>
-  inline OutputIterator cyl_bessel_j_zero(T v, // Floating-point value for Jv.
-                                int start_index, // 1-based start index.
-                                unsigned number_of_zeros,
-                                OutputIterator out_it,
-                                const Policy& pol); // iterator into container for zeros.
+  inline OutputIterator cyl_bessel_j_zero(
+                                T v,                      // Floating-point value for Jv.
+                                int start_index,          // 1-based start index.
+                                unsigned number_of_zeros, // How many zeros to generate
+                                OutputIterator out_it,    // Destination for zeros.
+                                const Policy& pol);       // Policy to use.
 
 */
 //] [/bessel_zeros_example_1]