recurrence.html 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
  4. <title>Tools For 3-Term Recurrence Relations</title>
  5. <link rel="stylesheet" href="../../math.css" type="text/css">
  6. <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
  7. <link rel="home" href="../../index.html" title="Math Toolkit 2.11.0">
  8. <link rel="up" href="../internals.html" title="Internal tools">
  9. <link rel="prev" href="cf.html" title="Continued Fraction Evaluation">
  10. <link rel="next" href="tuples.html" title="Tuples">
  11. </head>
  12. <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13. <table cellpadding="2" width="100%"><tr>
  14. <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
  15. <td align="center"><a href="../../../../../../index.html">Home</a></td>
  16. <td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
  17. <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18. <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19. <td align="center"><a href="../../../../../../more/index.htm">More</a></td>
  20. </tr></table>
  21. <hr>
  22. <div class="spirit-nav">
  23. <a accesskey="p" href="cf.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../internals.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="tuples.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24. </div>
  25. <div class="section">
  26. <div class="titlepage"><div><div><h3 class="title">
  27. <a name="math_toolkit.internals.recurrence"></a><a class="link" href="recurrence.html" title="Tools For 3-Term Recurrence Relations">Tools For 3-Term Recurrence
  28. Relations</a>
  29. </h3></div></div></div>
  30. <h5>
  31. <a name="math_toolkit.internals.recurrence.h0"></a>
  32. <span class="phrase"><a name="math_toolkit.internals.recurrence.synopsis"></a></span><a class="link" href="recurrence.html#math_toolkit.internals.recurrence.synopsis">Synopsis</a>
  33. </h5>
  34. <pre class="programlisting"><span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">math</span><span class="special">/</span><span class="identifier">tools</span><span class="special">/</span><span class="identifier">recurrence</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
  35. </pre>
  36. <pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">{</span> <span class="keyword">namespace</span> <span class="identifier">math</span><span class="special">{</span> <span class="keyword">namespace</span> <span class="identifier">tools</span><span class="special">{</span>
  37. <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">Recurrence</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">T</span><span class="special">&gt;</span>
  38. <span class="identifier">T</span> <span class="identifier">function_ratio_from_backwards_recurrence</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Recurrence</span><span class="special">&amp;</span> <span class="identifier">r</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">T</span><span class="special">&amp;</span> <span class="identifier">factor</span><span class="special">,</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">uintmax_t</span><span class="special">&amp;</span> <span class="identifier">max_iter</span><span class="special">);</span>
  39. <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">Recurrence</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">T</span><span class="special">&gt;</span>
  40. <span class="identifier">T</span> <span class="identifier">function_ratio_from_forwards_recurrence</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Recurrence</span><span class="special">&amp;</span> <span class="identifier">r</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">T</span><span class="special">&amp;</span> <span class="identifier">factor</span><span class="special">,</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">uintmax_t</span><span class="special">&amp;</span> <span class="identifier">max_iter</span><span class="special">);</span>
  41. <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">NextCoefs</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">T</span><span class="special">&gt;</span>
  42. <span class="identifier">T</span> <span class="identifier">apply_recurrence_relation_forward</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">NextCoefs</span><span class="special">&amp;</span> <span class="identifier">get_coefs</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="identifier">number_of_steps</span><span class="special">,</span> <span class="identifier">T</span> <span class="identifier">first</span><span class="special">,</span> <span class="identifier">T</span> <span class="identifier">second</span><span class="special">,</span> <span class="keyword">int</span><span class="special">*</span> <span class="identifier">log_scaling</span> <span class="special">=</span> <span class="number">0</span><span class="special">,</span> <span class="identifier">T</span><span class="special">*</span> <span class="identifier">previous</span> <span class="special">=</span> <span class="number">0</span><span class="special">);</span>
  43. <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">T</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">NextCoefs</span><span class="special">&gt;</span>
  44. <span class="identifier">T</span> <span class="identifier">apply_recurrence_relation_backward</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">NextCoefs</span><span class="special">&amp;</span> <span class="identifier">get_coefs</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="identifier">number_of_steps</span><span class="special">,</span> <span class="identifier">T</span> <span class="identifier">first</span><span class="special">,</span> <span class="identifier">T</span> <span class="identifier">second</span><span class="special">,</span> <span class="keyword">int</span><span class="special">*</span> <span class="identifier">log_scaling</span> <span class="special">=</span> <span class="number">0</span><span class="special">,</span> <span class="identifier">T</span><span class="special">*</span> <span class="identifier">previous</span> <span class="special">=</span> <span class="number">0</span><span class="special">);</span>
  45. <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">Recurrence</span><span class="special">&gt;</span>
  46. <span class="keyword">struct</span> <span class="identifier">forward_recurrence_iterator</span><span class="special">;</span>
  47. <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">Recurrence</span><span class="special">&gt;</span>
  48. <span class="keyword">struct</span> <span class="identifier">backward_recurrence_iterator</span><span class="special">;</span>
  49. <span class="special">}}}</span> <span class="comment">// namespaces</span>
  50. </pre>
  51. <h5>
  52. <a name="math_toolkit.internals.recurrence.h1"></a>
  53. <span class="phrase"><a name="math_toolkit.internals.recurrence.description"></a></span><a class="link" href="recurrence.html#math_toolkit.internals.recurrence.description">Description</a>
  54. </h5>
  55. <p>
  56. All of the tools in this header require a description of the recurrence relation:
  57. this takes the form of a functor that returns a tuple containing the 3 coefficients,
  58. specifically, given a recurrence relation:
  59. </p>
  60. <div class="blockquote"><blockquote class="blockquote"><p>
  61. <span class="inlinemediaobject"><img src="../../../equations/three_term_recurrence.svg"></span>
  62. </p></blockquote></div>
  63. <p>
  64. And a functor <code class="computeroutput"><span class="identifier">F</span></code> then the
  65. expression:
  66. </p>
  67. <div class="blockquote"><blockquote class="blockquote"><p>
  68. <span class="serif_italic">F(n);</span>
  69. </p></blockquote></div>
  70. <p>
  71. Returns a tuple containing <span class="serif_italic">{ a<sub>n</sub>, b<sub>n</sub>, c<sub>n</sub> }</span>.
  72. </p>
  73. <p>
  74. For example, the recurrence relation for the Bessel J and Y functions when
  75. written in this form is:
  76. </p>
  77. <p>
  78. <span class="inlinemediaobject"><object type="image/svg+xml" data="../../../equations/three_term_recurrence_bessel_jy.svg" width="250" height="38"></object></span>
  79. </p>
  80. <p>
  81. Therefore, given local variables <span class="emphasis"><em>x</em></span> and <span class="emphasis"><em>v</em></span>
  82. of type <code class="computeroutput"><span class="keyword">double</span></code> the recurrence
  83. relation for Bessel J and Y can be encoded in a lambda expression like this:
  84. </p>
  85. <pre class="programlisting"><span class="keyword">auto</span> <span class="identifier">recurrence_functor_jy</span> <span class="special">=</span> <span class="special">[&amp;](</span><span class="keyword">int</span> <span class="identifier">n</span><span class="special">)</span> <span class="special">{</span> <span class="keyword">return</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">make_tuple</span><span class="special">(</span><span class="number">1.0</span><span class="special">,</span> <span class="special">-</span><span class="number">2</span> <span class="special">*</span> <span class="special">(</span><span class="identifier">v</span> <span class="special">+</span> <span class="identifier">n</span><span class="special">)</span> <span class="special">/</span> <span class="identifier">x</span><span class="special">,</span> <span class="number">1.0</span><span class="special">);</span> <span class="special">};</span>
  86. </pre>
  87. <p>
  88. Similarly, the Bessel I and K recurrence relation differs just by the sign
  89. of the final term:
  90. </p>
  91. <p>
  92. <span class="inlinemediaobject"><object type="image/svg+xml" data="../../../equations/three_term_recurrence_bessel_ik.svg" width="244" height="38"></object></span>
  93. </p>
  94. <p>
  95. And this could be encoded as:
  96. </p>
  97. <pre class="programlisting"><span class="keyword">auto</span> <span class="identifier">recurrence_functor_ik</span> <span class="special">=</span> <span class="special">[&amp;](</span><span class="keyword">int</span> <span class="identifier">n</span><span class="special">)</span> <span class="special">{</span> <span class="keyword">return</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">make_tuple</span><span class="special">(</span><span class="number">1.0</span><span class="special">,</span> <span class="special">-</span><span class="number">2</span> <span class="special">*</span> <span class="special">(</span><span class="identifier">v</span> <span class="special">+</span> <span class="identifier">n</span><span class="special">)</span> <span class="special">/</span> <span class="identifier">x</span><span class="special">,</span> <span class="special">-</span><span class="number">1.0</span><span class="special">);</span> <span class="special">};</span>
  98. </pre>
  99. <p>
  100. The tools are then as follows:
  101. </p>
  102. <pre class="programlisting"><span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">Recurrence</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">T</span><span class="special">&gt;</span>
  103. <span class="identifier">T</span> <span class="identifier">function_ratio_from_backwards_recurrence</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Recurrence</span><span class="special">&amp;</span> <span class="identifier">r</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">T</span><span class="special">&amp;</span> <span class="identifier">factor</span><span class="special">,</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">uintmax_t</span><span class="special">&amp;</span> <span class="identifier">max_iter</span><span class="special">);</span>
  104. </pre>
  105. <p>
  106. Given a functor <code class="computeroutput"><span class="identifier">r</span></code> which encodes
  107. the recurrence relation for function <code class="computeroutput"><span class="identifier">F</span></code>
  108. at some location <span class="emphasis"><em>n</em></span>, then returns the ratio:
  109. </p>
  110. <p>
  111. <span class="inlinemediaobject"><object type="image/svg+xml" data="../../../equations/three_term_recurrence_backwards_ratio.svg" width="63" height="20"></object></span>
  112. </p>
  113. <p>
  114. This calculation is stable only if recurrence is stable in the backwards
  115. direction. Further the ratio calculated is for the dominant solution (in
  116. the backwards direction) of the recurrence relation, if there are multiple
  117. solutions, then there is no guarantee that this will find the one you want
  118. or expect.
  119. </p>
  120. <p>
  121. Argument <span class="emphasis"><em>factor</em></span> is the tolerance required for convergence
  122. of the continued fraction associated with the recurrence relation, and should
  123. be no smaller than machine epsilon. Argument <span class="emphasis"><em>max_iter</em></span>
  124. sets the maximum number of permitted iterations in the associated continued
  125. fraction.
  126. </p>
  127. <pre class="programlisting"><span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">Recurrence</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">T</span><span class="special">&gt;</span>
  128. <span class="identifier">T</span> <span class="identifier">function_ratio_from_forwards_recurrence</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Recurrence</span><span class="special">&amp;</span> <span class="identifier">r</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">T</span><span class="special">&amp;</span> <span class="identifier">factor</span><span class="special">,</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">uintmax_t</span><span class="special">&amp;</span> <span class="identifier">max_iter</span><span class="special">);</span>
  129. </pre>
  130. <p>
  131. Given a functor <code class="computeroutput"><span class="identifier">r</span></code> which encodes
  132. the recurrence relation for function F at some location <span class="emphasis"><em>n</em></span>,
  133. then returns the ratio:
  134. </p>
  135. <p>
  136. <span class="inlinemediaobject"><object type="image/svg+xml" data="../../../equations/three_term_recurrence_forwards_ratio.svg" width="63" height="20"></object></span>
  137. </p>
  138. <p>
  139. This calculation is stable only if recurrence is stable in the forwards direction.
  140. Further the ratio calculated is for the dominant solution (in the forwards
  141. direction) of the recurrence relation, if there are multiple solutions, then
  142. there is no guarantee that this will find the one you want or expect.
  143. </p>
  144. <p>
  145. Argument <span class="emphasis"><em>factor</em></span> is the tolerance required for convergence
  146. of the continued fraction associated with the recurrence relation, and should
  147. be no smaller than machine epsilon. Argument <span class="emphasis"><em>max_iter</em></span>
  148. sets the maximum number of permitted iterations in the associated continued
  149. fraction.
  150. </p>
  151. <pre class="programlisting"><span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">NextCoefs</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">T</span><span class="special">&gt;</span>
  152. <span class="identifier">T</span> <span class="identifier">apply_recurrence_relation_forward</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">NextCoefs</span><span class="special">&amp;</span> <span class="identifier">get_coefs</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="identifier">number_of_steps</span><span class="special">,</span> <span class="identifier">T</span> <span class="identifier">first</span><span class="special">,</span> <span class="identifier">T</span> <span class="identifier">second</span><span class="special">,</span> <span class="keyword">int</span><span class="special">*</span> <span class="identifier">log_scaling</span> <span class="special">=</span> <span class="number">0</span><span class="special">,</span> <span class="identifier">T</span><span class="special">*</span> <span class="identifier">previous</span> <span class="special">=</span> <span class="number">0</span><span class="special">);</span>
  153. </pre>
  154. <p>
  155. Applies a recurrence relation in a stable forward direction, starting with
  156. the values F<sub>n-1</sub> and F<sub>n</sub>.
  157. </p>
  158. <div class="variablelist">
  159. <p class="title"><b></b></p>
  160. <dl class="variablelist">
  161. <dt><span class="term">get_coefs</span></dt>
  162. <dd><p>
  163. Functor that returns the corefficients of the recurrence relation.
  164. The coefficients should be centered on position <span class="emphasis"><em>second</em></span>.
  165. </p></dd>
  166. <dt><span class="term">number_of_steps</span></dt>
  167. <dd><p>
  168. The number of steps to apply the recurrence relation onwards from
  169. <span class="emphasis"><em>second</em></span>.
  170. </p></dd>
  171. <dt><span class="term">first</span></dt>
  172. <dd><p>
  173. The value of F<sub>n-1</sub>
  174. </p></dd>
  175. <dt><span class="term">second</span></dt>
  176. <dd><p>
  177. The value of F<sub>n</sub>
  178. </p></dd>
  179. <dt><span class="term">log_scaling</span></dt>
  180. <dd><p>
  181. When provided, the recurrence relations may be rescaled internally
  182. to avoid over/underflow issues. The result should be multiplied by
  183. <code class="computeroutput"><span class="identifier">exp</span><span class="special">(*</span><span class="identifier">log_scaling</span><span class="special">)</span></code>
  184. to get the true value of the result.
  185. </p></dd>
  186. <dt><span class="term">previous</span></dt>
  187. <dd><p>
  188. When provided, is set to the value of F<sub>n + number_of_steps - 1</sub>
  189. </p></dd>
  190. </dl>
  191. </div>
  192. <p>
  193. Returns F<sub>n + number_of_steps</sub>.
  194. </p>
  195. <pre class="programlisting"><span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">NextCoefs</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">T</span><span class="special">&gt;</span>
  196. <span class="identifier">T</span> <span class="identifier">apply_recurrence_relation_backward</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">NextCoefs</span><span class="special">&amp;</span> <span class="identifier">get_coefs</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="identifier">number_of_steps</span><span class="special">,</span> <span class="identifier">T</span> <span class="identifier">first</span><span class="special">,</span> <span class="identifier">T</span> <span class="identifier">second</span><span class="special">,</span> <span class="keyword">int</span><span class="special">*</span> <span class="identifier">log_scaling</span> <span class="special">=</span> <span class="number">0</span><span class="special">,</span> <span class="identifier">T</span><span class="special">*</span> <span class="identifier">previous</span> <span class="special">=</span> <span class="number">0</span><span class="special">);</span>
  197. </pre>
  198. <p>
  199. Applies a recurrence relation in a stable backward direction, starting with
  200. the values F<sub>n+1</sub> and F<sub>n</sub>.
  201. </p>
  202. <div class="variablelist">
  203. <p class="title"><b></b></p>
  204. <dl class="variablelist">
  205. <dt><span class="term">get_coefs</span></dt>
  206. <dd><p>
  207. Functor that returns the corefficients of the recurrence relation.
  208. The coefficients should be centered on position <span class="emphasis"><em>second</em></span>.
  209. </p></dd>
  210. <dt><span class="term">number_of_steps</span></dt>
  211. <dd><p>
  212. The number of steps to apply the recurrence relation backwards from
  213. <span class="emphasis"><em>second</em></span>.
  214. </p></dd>
  215. <dt><span class="term">first</span></dt>
  216. <dd><p>
  217. The value of F<sub>n+1</sub>
  218. </p></dd>
  219. <dt><span class="term">second</span></dt>
  220. <dd><p>
  221. The value of F<sub>n</sub>
  222. </p></dd>
  223. <dt><span class="term">log_scaling</span></dt>
  224. <dd><p>
  225. When provided, the recurrence relations may be rescaled internally
  226. to avoid over/underflow issues. The result should be multiplied by
  227. <code class="computeroutput"><span class="identifier">exp</span><span class="special">(*</span><span class="identifier">log_scaling</span><span class="special">)</span></code>
  228. to get the true value of the result.
  229. </p></dd>
  230. <dt><span class="term">previous</span></dt>
  231. <dd><p>
  232. When provided, is set to the value of F<sub>n - number_of_steps + 1</sub>
  233. </p></dd>
  234. </dl>
  235. </div>
  236. <p>
  237. Returns F<sub>n - number_of_steps</sub>.
  238. </p>
  239. <pre class="programlisting"><span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">Recurrence</span><span class="special">&gt;</span>
  240. <span class="keyword">struct</span> <span class="identifier">forward_recurrence_iterator</span>
  241. <span class="special">{</span>
  242. <span class="keyword">typedef</span> <span class="keyword">typename</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">remove_reference</span><span class="special">&lt;</span><span class="keyword">decltype</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">get</span><span class="special">&lt;</span><span class="number">0</span><span class="special">&gt;(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">declval</span><span class="special">&lt;</span><span class="identifier">Recurrence</span><span class="special">&amp;&gt;()(</span><span class="number">0</span><span class="special">)))&gt;::</span><span class="identifier">type</span> <span class="identifier">value_type</span><span class="special">;</span>
  243. <span class="identifier">forward_recurrence_iterator</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Recurrence</span><span class="special">&amp;</span> <span class="identifier">r</span><span class="special">,</span> <span class="identifier">value_type</span> <span class="identifier">f_n_minus_1</span><span class="special">,</span> <span class="identifier">value_type</span> <span class="identifier">f_n</span><span class="special">);</span>
  244. <span class="identifier">forward_recurrence_iterator</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Recurrence</span><span class="special">&amp;</span> <span class="identifier">r</span><span class="special">,</span> <span class="identifier">value_type</span> <span class="identifier">f_n</span><span class="special">);</span>
  245. <span class="comment">/* Operators omitted for clarity */</span>
  246. <span class="special">};</span>
  247. </pre>
  248. <p>
  249. Type <code class="computeroutput"><span class="identifier">forward_recurrence_iterator</span></code>
  250. defines a forward-iterator for a recurrence relation stable in the forward
  251. direction. The constructors take the recurrence relation, plus either one
  252. or two values: if only one value is provided, then the second is computed
  253. by using the recurrence relation to calculate the function ratio.
  254. </p>
  255. <pre class="programlisting"><span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">Recurrence</span><span class="special">&gt;</span>
  256. <span class="keyword">struct</span> <span class="identifier">backward_recurrence_iterator</span>
  257. <span class="special">{</span>
  258. <span class="keyword">typedef</span> <span class="keyword">typename</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">remove_reference</span><span class="special">&lt;</span><span class="keyword">decltype</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">get</span><span class="special">&lt;</span><span class="number">0</span><span class="special">&gt;(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">declval</span><span class="special">&lt;</span><span class="identifier">Recurrence</span><span class="special">&amp;&gt;()(</span><span class="number">0</span><span class="special">)))&gt;::</span><span class="identifier">type</span> <span class="identifier">value_type</span><span class="special">;</span>
  259. <span class="identifier">backward_recurrence_iterator</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Recurrence</span><span class="special">&amp;</span> <span class="identifier">r</span><span class="special">,</span> <span class="identifier">value_type</span> <span class="identifier">f_n_plus_1</span><span class="special">,</span> <span class="identifier">value_type</span> <span class="identifier">f_n</span><span class="special">);</span>
  260. <span class="identifier">backward_recurrence_iterator</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Recurrence</span><span class="special">&amp;</span> <span class="identifier">r</span><span class="special">,</span> <span class="identifier">value_type</span> <span class="identifier">f_n</span><span class="special">);</span>
  261. <span class="comment">/* Operators omitted for clarity */</span>
  262. <span class="special">};</span>
  263. </pre>
  264. <p>
  265. Type <code class="computeroutput"><span class="identifier">backward_recurrence_iterator</span></code>
  266. defines a forward-iterator for a recurrence relation stable in the backward
  267. direction. The constructors take the recurrence relation, plus either one
  268. or two values: if only one value is provided, then the second is computed
  269. by using the recurrence relation to calculate the function ratio.
  270. </p>
  271. <p>
  272. Note that <span class="emphasis"><em>incrementing</em></span> this iterator moves the value
  273. returned successively to F<sub>n-1</sub>, F<sub>n-2</sub> etc.
  274. </p>
  275. </div>
  276. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  277. <td align="left"></td>
  278. <td align="right"><div class="copyright-footer">Copyright &#169; 2006-2019 Nikhar
  279. Agrawal, Anton Bikineev, Paul A. Bristow, Marco Guazzone, Christopher Kormanyos,
  280. Hubert Holin, Bruno Lalande, John Maddock, Jeremy Murphy, Matthew Pulver, Johan
  281. R&#229;de, Gautam Sewani, Benjamin Sobotta, Nicholas Thompson, Thijs van den Berg,
  282. Daryle Walker and Xiaogang Zhang<p>
  283. Distributed under the Boost Software License, Version 1.0. (See accompanying
  284. file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
  285. </p>
  286. </div></td>
  287. </tr></table>
  288. <hr>
  289. <div class="spirit-nav">
  290. <a accesskey="p" href="cf.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../internals.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="tuples.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  291. </div>
  292. </body>
  293. </html>