[Boost-commit] svn:boost r82904 - trunk/libs/math/doc/sf_and_dist

Subject: [Boost-commit] svn:boost r82904 - trunk/libs/math/doc/sf_and_dist
From: pbristow_at_[hidden]
Date: 2013-02-15 12:04:31

Author: pbristow
Date: 2013-02-15 12:04:30 EST (Fri, 15 Feb 2013)
New Revision: 82904
URL: http://svn.boost.org/trac/boost/changeset/82904

Log:
Many docs changes for unsigned to int for parameter m.
Text files modified: 
   trunk/libs/math/doc/sf_and_dist/bessel_jy.qbk |    30 ++++++++++++++++++------------          
   1 files changed, 18 insertions(+), 12 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-02-15 12:04:30 EST (Fri, 15 Feb 2013)
@@ -290,21 +290,21 @@
 
   template <class T>
   T cyl_bessel_j_zero(T v,  // Floating-point value for Jv.
-    unsigned m); // index of zero
+    int m); // 1-based index of zero.
   template <class T>
   T cyl_neumann_zero(T v,  // Floating-point value for Jv.
-    unsigned m); // index of zero
+    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.
-                                unsigned start_index,
+                                int start_index, // 1-based index of zero.
                                 unsigned number_of_zeros,
                                 OutputIterator out_it); //
  template <class T, class OutputIterator>
  OutputIterator cyl_neumann_zero(T v, // Floating-point value for Jv.
-                                unsigned start_index,
+                                int start_index, // 1-based index of zero.
                                 unsigned number_of_zeros,
                                 OutputIterator out_it); //
 
@@ -313,22 +313,22 @@
 
   template <class T>
   T cyl_bessel_j_zero(T v,  // Floating-point value for Jv.
-    unsigned m,  // start index.
+    int m,  // 1-based start index.
     const Policy& pol); // Policy
   template <class T>
   T cyl_neumann_zero(T v,  // Floating-point value for Jv.
-    unsigned m,  // start index.
+    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.
-                                unsigned start_index,
+                                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.
-                                unsigned start_index,
+                                int start_index, // 1-based start index.
                                 unsigned number_of_zeros,
                                 OutputIterator out_it,
                                 const Policy& pol);
@@ -337,7 +337,7 @@
 
 The zeros or roots (values of x where the function crosses the y = 0 axis)
 of the Bessel and Neumann functions are computed by two functions,
-`cyl_bessel_j_zero` and `cyl_neumann_zero`.  
+`cyl_bessel_j_zero` and `cyl_neumann_zero`.
 
 In each case the index of the zero
 returned is 1-based, which is to say:
@@ -350,6 +350,8 @@
 
 results in a __domain_error being raised.
 
+[graph bessel_zeros]
+
 [h4 Examples of finding Bessel and Neumann zeros]
 
 [import ../../example/bessel_zeros_example.cpp]
@@ -362,23 +364,27 @@
 
 [bessel_zero_example_iterator_2]
 
-The full code for this example for Bessel `cyl_bessel_j_zeros` is at
+[bessel_zero_example_iterator_3]
+
+The full code (and output) for this example for Bessel `cyl_bessel_j_zeros` is at
 [@../../../example/bessel_zeros_example.cpp Bessel, Neumann and Airy zeros].
 
 
-[h4 Implementation and testing]
+[h4 Implementation]
 
 The method uses Newton-Raphson method starting with McMahon's approximation.
 See "Handbook of Mathematical Functions", M. Abramowitz and I. A. Stegan, section 9.5.
 Also: NIST Digital Library of Mathematical Functions, [@http://dlmf.nist.gov/10.21#vi Bessel Function Zeros].
 
+[h4 Testing]
+
 The precision of evaluation of zeros was tested at 50 decimal digits using `cpp_dec_float_50`
 and found identical with spot values computed by __WolframAlpha.
 
 [endsect]  [/section:bessel Finding Zeros of Bessel Functions of the First and Second Kinds]
 
 [/
-  Copyright 2006, 2013 John Maddock, Paul A. Bristow, Xiaogang Zhang and Christor Kormanyos.
+  Copyright 2006, 2013 John Maddock, Paul A. Bristow, Xiaogang Zhang and Christopher Kormanyos.
 
   Distributed under the Boost Software License, Version 1.0.
   (See accompanying file LICENSE_1_0.txt or copy at