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
|
<!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>QuantLib: step_iterator 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="212" height="47" 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 0.9.0</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="overview.html">Project overview</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="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.5.4 -->
<div class="nav">
<a class="el" href="namespace_quant_lib.html">QuantLib</a>::<a class="el" href="class_quant_lib_1_1step__iterator.html">step_iterator</a></div>
<h1>step_iterator Class Template Reference</h1><!-- doxytag: class="QuantLib::step_iterator" --><!-- doxytag: inherits="boost::iterator_adaptor" --><code>#include <ql/utilities/steppingiterator.hpp></code>
<p>
Inherits boost::iterator_adaptor.
<p>
<p>
<a href="class_quant_lib_1_1step__iterator-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template<class Iterator><br>
class QuantLib::step_iterator< Iterator ></h3>
Iterator advancing in constant steps.
<p>
This iterator advances an underlying random-access iterator in steps of <img class="formulaInl" alt="$ n $" src="form_113.png"> positions, where <img class="formulaInl" alt="$ n $" src="form_113.png"> is a positive integer given upon construction. <table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d6865502e9db99c049546d38c526c2a7"></a><!-- doxytag: member="QuantLib::step_iterator::step_iterator" ref="d6865502e9db99c049546d38c526c2a7" args="(const Iterator &base, Size step)" -->
</td><td class="memItemRight" valign="bottom"><b>step_iterator</b> (const Iterator &base, <a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> step)</td></tr>
<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="c66a7424c0c35ac71ff18c81a7a9f1bb"></a><!-- doxytag: member="QuantLib::step_iterator::step_iterator" ref="c66a7424c0c35ac71ff18c81a7a9f1bb" args="(const step_iterator< OtherIterator > &i, typename boost::enable_if_convertible< OtherIterator, Iterator >::type *=0)" -->
template<class OtherIterator> </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top"> </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>< OtherIterator > &i, typename boost::enable_if_convertible< OtherIterator, Iterator >::type *=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="58d1ae9413b93d3ede0e31a5ee67aa9f"></a><!-- doxytag: member="QuantLib::step_iterator::step" ref="58d1ae9413b93d3ede0e31a5ee67aa9f" args="() const " -->
<a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> </td><td class="memItemRight" valign="bottom"><b>step</b> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="eb2624c7a86b765725fd80cd426e147d"></a><!-- doxytag: member="QuantLib::step_iterator::increment" ref="eb2624c7a86b765725fd80cd426e147d" args="()" -->
void </td><td class="memItemRight" valign="bottom"><b>increment</b> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f998f1201f6ff5160003144e5818b8ba"></a><!-- doxytag: member="QuantLib::step_iterator::decrement" ref="f998f1201f6ff5160003144e5818b8ba" args="()" -->
void </td><td class="memItemRight" valign="bottom"><b>decrement</b> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1d2f600398caeeeef15fe7a2f2fec928"></a><!-- doxytag: member="QuantLib::step_iterator::advance" ref="1d2f600398caeeeef15fe7a2f2fec928" args="(typename super_t::difference_type n)" -->
void </td><td class="memItemRight" valign="bottom"><b>advance</b> (typename super_t::difference_type n)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="710f62c0eeded5e13c19559da6c2977d"></a><!-- doxytag: member="QuantLib::step_iterator::distance_to" ref="710f62c0eeded5e13c19559da6c2977d" args="(const step_iterator &i) const " -->
super_t::difference_type </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> &i) const </td></tr>
<tr><td colspan="2"><br><h2>Related Functions</h2></td></tr>
<tr><td colspan="2">(Note that these are not member functions.) <br><br></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2">template<class Iterator> </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top"><a class="el" href="class_quant_lib_1_1step__iterator.html">step_iterator</a>< Iterator > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1step__iterator.html#9b0b9db91bddfb09301c4ec629ca87ca">make_step_iterator</a> (Iterator it, <a class="el" href="group__types.html#gf38bdb4c54463b1f456655efa95b5c77">Size</a> step)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">helper function to create step iterators <a href="#9b0b9db91bddfb09301c4ec629ca87ca"></a><br></td></tr>
</table>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="9b0b9db91bddfb09301c4ec629ca87ca"></a><!-- doxytag: member="QuantLib::step_iterator::make_step_iterator" ref="9b0b9db91bddfb09301c4ec629ca87ca" 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>< Iterator > make_step_iterator </td>
<td>(</td>
<td class="paramtype">Iterator </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#gf38bdb4c54463b1f456655efa95b5c77">Size</a> </td>
<td class="paramname"> <em>step</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
helper function to create step iterators
<p>
</div>
</div><p>
</div>
<div class="footer">
<div class="endmatter">
Documentation generated by
<a href="http://www.doxygen.org">Doxygen</a> 1.5.4
</div>
</div>
</div>
</body>
</html>
|