File: class_quant_lib_1_1step__iterator.html

package info (click to toggle)
quantlib-refman-html 1.2-1
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd, wheezy
  • size: 84,552 kB
  • ctags: 5,132
  • sloc: makefile: 33
file content (163 lines) | stat: -rw-r--r-- 9,400 bytes parent folder | download 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<meta name="robots" content="none">
<title>step_iterator&lt; Iterator &gt; Class Template Reference</title>
<link rel="stylesheet" href="quantlib.css" type="text/css">
<link rel="stylesheet" href="print.css" type="text/css" media="print">
<link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
<link rel="icon" href="favicon.ico" type="image/x-icon">
</head>
<body>

<div id="container">
<div id="header">
<img class="titleimage"
 src="QL-title.jpg" width="185" height="50" border="0"
 alt="QuantLib">
<br>
<h3 class="subtitle">A free/open-source library for quantitative finance</h3>
</div>
<div id="menu">

<h3 class="navbartitle">Version 1.2</h3>

<hr>

<h3 class="navbartitle">Getting started</h3>
<ul class="navbarlist">
<li class="navlink"><a href="index.html">Introduction</a></li>
<li class="navlink"><a href="where.html">Where to get QuantLib</a></li>
<li class="navlink"><a href="install.html">Installation</a></li>
<li class="navlink"><a href="config.html">Configuration</a></li>
<li class="navlink"><a href="usage.html">Usage</a></li>
<li class="navlink"><a href="history.html">Version history</a></li>
<li class="navlink"><a href="resources.html">Additional resources</a></li>
<li class="navlink"><a href="group.html">The QuantLib group</a></li>
<li class="navlink"><a href="license.html">Copyright and license</a></li>
</ul>

<hr>

<h3 class="navbartitle">Reference manual</h3>
<ul class="navbarlist">
<li class="navlink"><a href="modules.html">Modules</a></li>
<li class="navlink"><a href="hierarchy.html">Class Hierarchy</a></li>
<li class="navlink"><a href="annotated.html">Compound List</a></li>
<li class="navlink"><a href="files.html">File List</a></li>
<li class="navlink"><a href="functions.html">Compound Members</a></li>
<li class="navlink"><a href="globals.html">File Members</a></li>
<li class="navlink"><a href="todo.html">Todo List</a></li>
<li class="navlink"><a href="bug.html">Known Bugs</a></li>
<li class="navlink"><a href="caveats.html">Caveats</a></li>
<li class="navlink"><a href="test.html">Test Suite</a></li>
<li class="navlink"><a href="examples.html">Examples</a></li>
</ul>
</div>

<div id="content">
<!--Doxygen-generated content-->

<!-- Generated by Doxygen 1.7.6.1 -->
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><b>QuantLib</b>      </li>
      <li class="navelem"><a class="el" href="class_quant_lib_1_1step__iterator.html">step_iterator</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#related">Related Functions</a>  </div>
  <div class="headertitle">
<div class="title">step_iterator&lt; Iterator &gt; Class Template Reference</div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::step_iterator" --><!-- doxytag: inherits="boost::iterator_adaptor" -->
<p>Iterator advancing in constant steps.  
 <a href="class_quant_lib_1_1step__iterator.html#details">More...</a></p>

<p><code>#include &lt;ql/utilities/steppingiterator.hpp&gt;</code></p>

<p>Inherits iterator_adaptor&lt; step_iterator&lt; Iterator &gt;, Iterator &gt;.</p>

<p><a href="class_quant_lib_1_1step__iterator-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad6865502e9db99c049546d38c526c2a7"></a><!-- doxytag: member="QuantLib::step_iterator::step_iterator" ref="ad6865502e9db99c049546d38c526c2a7" args="(const Iterator &amp;base, Size step)" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>step_iterator</b> (const Iterator &amp;base, <a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a> step)</td></tr>
<tr><td class="memTemplParams" colspan="2"><a class="anchor" id="a3d71920cff46866a8cb0ce4abd2040dd"></a><!-- doxytag: member="QuantLib::step_iterator::step_iterator" ref="a3d71920cff46866a8cb0ce4abd2040dd" args="(const step_iterator&lt; OtherIterator &gt; &amp;i, typename boost::enable_if_convertible&lt; OtherIterator, Iterator &gt;::type *=0)" -->
template&lt;class OtherIterator &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><b>step_iterator</b> (const <a class="el" href="class_quant_lib_1_1step__iterator.html">step_iterator</a>&lt; OtherIterator &gt; &amp;i, typename boost::enable_if_convertible&lt; OtherIterator, Iterator &gt;::type *=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a58d1ae9413b93d3ede0e31a5ee67aa9f"></a><!-- doxytag: member="QuantLib::step_iterator::step" ref="a58d1ae9413b93d3ede0e31a5ee67aa9f" args="() const " -->
<a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a>&#160;</td><td class="memItemRight" valign="bottom"><b>step</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeb2624c7a86b765725fd80cd426e147d"></a><!-- doxytag: member="QuantLib::step_iterator::increment" ref="aeb2624c7a86b765725fd80cd426e147d" args="()" -->
void&#160;</td><td class="memItemRight" valign="bottom"><b>increment</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af998f1201f6ff5160003144e5818b8ba"></a><!-- doxytag: member="QuantLib::step_iterator::decrement" ref="af998f1201f6ff5160003144e5818b8ba" args="()" -->
void&#160;</td><td class="memItemRight" valign="bottom"><b>decrement</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1d2f600398caeeeef15fe7a2f2fec928"></a><!-- doxytag: member="QuantLib::step_iterator::advance" ref="a1d2f600398caeeeef15fe7a2f2fec928" args="(typename super_t::difference_type n)" -->
void&#160;</td><td class="memItemRight" valign="bottom"><b>advance</b> (typename super_t::difference_type n)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a710f62c0eeded5e13c19559da6c2977d"></a><!-- doxytag: member="QuantLib::step_iterator::distance_to" ref="a710f62c0eeded5e13c19559da6c2977d" args="(const step_iterator &amp;i) const " -->
super_t::difference_type&#160;</td><td class="memItemRight" valign="bottom"><b>distance_to</b> (const <a class="el" href="class_quant_lib_1_1step__iterator.html">step_iterator</a> &amp;i) const </td></tr>
<tr><td colspan="2"><h2><a name="related"></a>
Related Functions</h2></td></tr>
<tr><td class="ititle" colspan="2"><p>(Note that these are not member functions.) </p>
</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;class Iterator &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="class_quant_lib_1_1step__iterator.html">step_iterator</a>&lt; Iterator &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1step__iterator.html#a8827eca53826b1ca424151b01e8bfb37">make_step_iterator</a> (Iterator it, <a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a> step)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">helper function to create step iterators  <a href="#a8827eca53826b1ca424151b01e8bfb37"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><h3>template&lt;class Iterator&gt;<br/>
class QuantLib::step_iterator&lt; Iterator &gt;</h3>

<p>Iterator advancing in constant steps. </p>
<p>This iterator advances an underlying random-access iterator in steps of <img class="formulaInl" alt="$ n $" src="form_181.png"/> positions, where <img class="formulaInl" alt="$ n $" src="form_181.png"/> is a positive integer given upon construction. </p>
</div><hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a8827eca53826b1ca424151b01e8bfb37"></a><!-- doxytag: member="QuantLib::step_iterator::make_step_iterator" ref="a8827eca53826b1ca424151b01e8bfb37" args="(Iterator it, Size step)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_quant_lib_1_1step__iterator.html">step_iterator</a>&lt; Iterator &gt; <a class="el" href="class_quant_lib_1_1step__iterator.html#a8827eca53826b1ca424151b01e8bfb37">make_step_iterator</a> </td>
          <td>(</td>
          <td class="paramtype">Iterator&#160;</td>
          <td class="paramname"><em>it</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a>&#160;</td>
          <td class="paramname"><em>step</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [related]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>helper function to create step iterators </p>

</div>
</div>
</div><!-- contents -->

</div>

<div class="footer">
<div class="endmatter">
Documentation generated by
<a href="http://www.doxygen.org">Doxygen</a> 1.7.6.1
</div>
</div>

</div>

</body>
</html>