File: config.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 (107 lines) | stat: -rw-r--r-- 5,744 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
<!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>User configuration</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>
<div class="header">
  <div class="headertitle">
<div class="title">User configuration </div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>A number of macros is provided for user configuration. Defining or undefining such macros triggers variations in some library functionality.</p>
<p>Under a Linux/Unix system, they are (un)set by <code>configure</code>; run </p>
<div class="fragment"><pre class="fragment">    ./configure --help
</pre></div><p> for a list of corresponding command-line options.</p>
<p>Under a Windows system, they must be (un)defined by editing the file &lt;ql/userconfig.hpp&gt; and commenting or uncommenting the relevant lines.</p>
<p>Such macros include:</p>
<div class="fragment"><pre class="fragment"><span class="preprocessor">    #define QL_ERROR_FUNCTIONS</span>
</pre></div><p>If defined, function information is added to the error messages thrown by the library. Undefined by default.</p>
<div class="fragment"><pre class="fragment"><span class="preprocessor">    #define QL_ERROR_LINES</span>
</pre></div><p> If defined, file and line information is added to the error messages thrown by the library. Undefined by default.</p>
<div class="fragment"><pre class="fragment"><span class="preprocessor">    #define QL_ENABLE_TRACING</span>
</pre></div><p>If enabled, tracing messages might be emitted by the library depending on run-time settings. Enabling this option can degrade performance. Undefined by default.</p>
<div class="fragment"><pre class="fragment"><span class="preprocessor">    #define QL_NEGATIVE_RATES</span>
</pre></div><p> If defined, negative yield rates are allowed in a few places where they are currently forbidden. It is still not clear whether this is safe. Undefined by default.</p>
<div class="fragment"><pre class="fragment"><span class="preprocessor">    #define QL_EXTRA_SAFETY_CHECKS</span>
</pre></div><p> If defined, extra run-time checks are added to a few functions. This can prevent their inlining and degrade performance. Undefined by default.</p>
<div class="fragment"><pre class="fragment"><span class="preprocessor">    #define QL_TODAYS_PAYMENTS</span>
</pre></div><p> If undefined (the default,) payments are considered to be settled at the beginning of the day. Therefore, payments occurring at today's date are not included in the NPV of an instrument.</p>
<div class="fragment"><pre class="fragment"><span class="preprocessor">    #define QL_DISABLE_DEPRECATED</span>
</pre></div><p> If defined, deprecated code will not be included in the library. Undefined by default.</p>
<div class="fragment"><pre class="fragment"><span class="preprocessor">    #define QL_USE_INDEXED_COUPON</span>
</pre></div><p> If defined, indexed coupons (see the documentation) are used in floating legs. If undefined (the default), par coupons are used.</p>
<div class="fragment"><pre class="fragment"><span class="preprocessor">    #define QL_ENABLE_SESSIONS</span>
</pre></div><p> If defined, singletons will return different instances for different sessions. You will have to provide and link with the library a sessionId() function in namespace QuantLib, returning a different session id for each session. </p>
</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>