1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
1
<!-- HTML header for doxygen 1.8.9.1-->
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
<html xmlns="http://www.w3.org/1999/xhtml">
4
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
5
<meta name="robots" content="none">
6
<title>AmericanCondition Class Reference</title>
7
<link rel="stylesheet" href="quantlib.css" type="text/css">
8
<link rel="stylesheet" href="print.css" type="text/css" media="print">
9
<link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
10
<link rel="icon" href="favicon.ico" type="image/x-icon">
5
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
7
<meta name="generator" content="Doxygen 1.8.9.1"/>
8
<title>QuantLib: AmericanCondition Class Reference</title>
9
<link href='http://fonts.googleapis.com/css?family=Merriweather+Sans:800' rel='stylesheet' type='text/css'>
10
<link href="tabs.css" rel="stylesheet" type="text/css"/>
11
<script type="text/javascript" src="jquery.js"></script>
12
<script type="text/javascript" src="dynsections.js"></script>
13
<link href="search/search.css" rel="stylesheet" type="text/css"/>
14
<script type="text/javascript" src="search/search.js"></script>
15
<script type="text/javascript">
16
$(document).ready(function() {
17
if ($('.searchresults').length > 0) { searchBox.DOMSearchField().focus(); }
20
<link rel="search" href="search_opensearch.php?v=opensearch.xml" type="application/opensearchdescription+xml" title="QuantLib"/>
21
<script type="text/x-mathjax-config">
23
extensions: ["tex2jax.js"],
24
jax: ["input/TeX","output/HTML-CSS"],
26
</script><script src="file://usr/share/javascript/mathjax/MathJax.js"></script>
27
<link href="doxygen.css" rel="stylesheet" type="text/css" />
28
<link href="quantlibextra.css" rel="stylesheet" type="text/css"/>
16
<img class="titleimage"
17
src="QL-title.jpg" width="185" height="50" border="0"
20
<h3 class="subtitle">A free/open-source library for quantitative finance</h3>
24
<h3 class="navbartitle">Version 1.2</h3>
28
<h3 class="navbartitle">Getting started</h3>
29
<ul class="navbarlist">
30
<li class="navlink"><a href="index.html">Introduction</a></li>
31
<li class="navlink"><a href="where.html">Where to get QuantLib</a></li>
32
<li class="navlink"><a href="install.html">Installation</a></li>
33
<li class="navlink"><a href="config.html">Configuration</a></li>
34
<li class="navlink"><a href="usage.html">Usage</a></li>
35
<li class="navlink"><a href="history.html">Version history</a></li>
36
<li class="navlink"><a href="resources.html">Additional resources</a></li>
37
<li class="navlink"><a href="group.html">The QuantLib group</a></li>
38
<li class="navlink"><a href="license.html">Copyright and license</a></li>
43
<h3 class="navbartitle">Reference manual</h3>
44
<ul class="navbarlist">
45
<li class="navlink"><a href="modules.html">Modules</a></li>
46
<li class="navlink"><a href="hierarchy.html">Class Hierarchy</a></li>
47
<li class="navlink"><a href="annotated.html">Compound List</a></li>
48
<li class="navlink"><a href="files.html">File List</a></li>
49
<li class="navlink"><a href="functions.html">Compound Members</a></li>
50
<li class="navlink"><a href="globals.html">File Members</a></li>
51
<li class="navlink"><a href="todo.html">Todo List</a></li>
52
<li class="navlink"><a href="bug.html">Known Bugs</a></li>
53
<li class="navlink"><a href="caveats.html">Caveats</a></li>
54
<li class="navlink"><a href="test.html">Test Suite</a></li>
55
<li class="navlink"><a href="examples.html">Examples</a></li>
60
<!--Doxygen-generated content-->
62
<!-- Generated by Doxygen 1.7.6.1 -->
63
<div id="nav-path" class="navpath">
65
<li class="navelem"><b>QuantLib</b> </li>
66
<li class="navelem"><a class="el" href="class_quant_lib_1_1_american_condition.html">AmericanCondition</a> </li>
31
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
33
<table cellspacing="0" cellpadding="0">
35
<tr style="height: 56px;">
36
<td style="padding-left: 0.5em;">
37
<div id="projectname"><a href="http://quantlib.org">
38
<img alt="QuantLib" src="QL-title.jpg"></a>
39
<div id="projectbrief">A free/open-source library for quantitative finance</div>
40
<div id="projectnumber">Reference manual - version 1.6</div>
47
<!-- end header part -->
48
<!-- Generated by Doxygen 1.8.9.1 -->
49
<script type="text/javascript">
50
var searchBox = new SearchBox("searchBox", "search",false,'Search');
52
<div id="navrow1" class="tabs">
54
<li><a href="index.html"><span>Main Page</span></a></li>
55
<li><a href="pages.html"><span>Related Pages</span></a></li>
56
<li><a href="modules.html"><span>Modules</span></a></li>
57
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
58
<li><a href="examples.html"><span>Examples</span></a></li>
60
<div id="MSearchBox" class="MSearchBoxInactive">
62
<form id="FSearchBox" action="search.php" method="get">
63
<img id="MSearchSelect" src="search/mag.png" alt=""/>
64
<input type="text" id="MSearchField" name="query" value="Search" size="20" accesskey="S"
65
onfocus="searchBox.OnSearchFieldFocus(true)"
66
onblur="searchBox.OnSearchFieldFocus(false)"/>
68
</div><div class="right"></div>
73
<div id="navrow2" class="tabs2">
75
<li><a href="annotated.html"><span>Class List</span></a></li>
76
<li><a href="classes.html"><span>Class Index</span></a></li>
77
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
78
<li><a href="functions.html"><span>Class Members</span></a></li>
81
<div id="nav-path" class="navpath">
83
<li class="navelem"><a class="el" href="namespace_quant_lib.html">QuantLib</a></li><li class="navelem"><a class="el" href="class_quant_lib_1_1_american_condition.html">AmericanCondition</a></li> </ul>
70
86
<div class="header">
71
87
<div class="summary">
72
<a href="#pub-methods">Public Member Functions</a> </div>
88
<a href="#pub-methods">Public Member Functions</a> |
89
<a href="class_quant_lib_1_1_american_condition-members.html">List of all members</a> </div>
73
90
<div class="headertitle">
74
91
<div class="title">AmericanCondition Class Reference</div> </div>
75
92
</div><!--header-->
76
93
<div class="contents">
77
<!-- doxytag: class="QuantLib::AmericanCondition" --><!-- doxytag: inherits="QuantLib::CurveDependentStepCondition" -->
78
95
<p>American exercise condition.
79
96
<a href="class_quant_lib_1_1_american_condition.html#details">More...</a></p>
81
98
<p><code>#include <ql/methods/finitedifferences/americancondition.hpp></code></p>
83
100
<p>Inherits CurveDependentStepCondition< array_type >.</p>
85
<p><a href="class_quant_lib_1_1_american_condition-members.html">List of all members.</a></p>
86
101
<table class="memberdecls">
87
<tr><td colspan="2"><h2><a name="pub-methods"></a>
102
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
88
103
Public Member Functions</h2></td></tr>
89
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aff67f7f6768010452bb295e89923b85a"></a><!-- doxytag: member="QuantLib::AmericanCondition::AmericanCondition" ref="aff67f7f6768010452bb295e89923b85a" args="(Option::Type type, Real strike)" -->
104
<tr class="memitem:aff67f7f6768010452bb295e89923b85a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aff67f7f6768010452bb295e89923b85a"></a>
90
105
 </td><td class="memItemRight" valign="bottom"><b>AmericanCondition</b> (Option::Type type, <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> strike)</td></tr>
91
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aff6af0dd69f21e0c9ab7978eaa3df156"></a><!-- doxytag: member="QuantLib::AmericanCondition::AmericanCondition" ref="aff6af0dd69f21e0c9ab7978eaa3df156" args="(const Array &intrinsicValues)" -->
106
<tr class="separator:aff67f7f6768010452bb295e89923b85a"><td class="memSeparator" colspan="2"> </td></tr>
107
<tr class="memitem:aff6af0dd69f21e0c9ab7978eaa3df156"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aff6af0dd69f21e0c9ab7978eaa3df156"></a>
92
108
 </td><td class="memItemRight" valign="bottom"><b>AmericanCondition</b> (const <a class="el" href="class_quant_lib_1_1_array.html">Array</a> &intrinsicValues)</td></tr>
109
<tr class="separator:aff6af0dd69f21e0c9ab7978eaa3df156"><td class="memSeparator" colspan="2"> </td></tr>
94
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
111
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
95
112
<div class="textblock"><p>American exercise condition. </p>
96
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000041">Possible enhancements:</a></b></dt><dd>unify the intrinsicValues/Payoff thing </dd></dl>
97
113
</div></div><!-- contents -->
102
<div class="endmatter">
103
Documentation generated by
104
<a href="http://www.doxygen.org">Doxygen</a> 1.7.6.1
114
<!-- HTML footer for doxygen 1.8.9.1-->
115
<!-- start footer part -->
116
<hr class="footer"/><address class="footer"><small>
117
Generated by <a href="http://www.doxygen.org/index.html">Doxygen</a>