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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
|
/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
Copyright (C) 2004 Decillion Pty(Ltd)
Copyright (C) 2004, 2005, 2006, 2007 StatPro Italia srl
This file is part of QuantLib, a free-software/open-source library
for financial quantitative analysts and developers - http://quantlib.org/
QuantLib is free software: you can redistribute it and/or modify it
under the terms of the QuantLib license. You should have received a
copy of the license along with this program; if not, please email
<quantlib-dev@lists.sf.net>. The license is also available online at
<https://www.quantlib.org/license.shtml>.
This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the license for more details.
*/
/*! \file currency.hpp
\brief Currency specification
*/
#ifndef quantlib_currency_hpp
#define quantlib_currency_hpp
#include <ql/math/rounding.hpp>
#include <ql/errors.hpp>
#include <iosfwd>
#include <set>
namespace QuantLib {
//! %Currency specification
class Currency {
public:
//! \name Constructors
//@{
//! default constructor
/*! Instances built via this constructor have undefined
behavior. Such instances can only act as placeholders
and must be reassigned to a valid currency before being
used.
*/
Currency() = default;
Currency(const std::string& name,
const std::string& code,
Integer numericCode,
const std::string& symbol,
const std::string& fractionSymbol,
Integer fractionsPerUnit,
const Rounding& rounding,
const Currency& triangulationCurrency = Currency(),
const std::set<std::string>& minorUnitCodes = {});
//@}
//! \name Inspectors
//@{
//! currency name, e.g, "U.S. Dollar"
const std::string& name() const;
//! ISO 4217 three-letter code, e.g, "USD"
const std::string& code() const;
//! ISO 4217 numeric code, e.g, "840"
Integer numericCode() const;
//! symbol, e.g, "$"
const std::string& symbol() const;
//! fraction symbol, e.g, "ยข"
const std::string& fractionSymbol() const;
//! number of fractionary parts in a unit, e.g, 100
Integer fractionsPerUnit() const;
//! rounding convention
const Rounding& rounding() const;
//@}
//! \name Other information
//@{
//! is this a usable instance?
bool empty() const;
//! currency used for triangulated exchange when required
const Currency& triangulationCurrency() const;
//! minor unit codes, e.g. GBp, GBX for GBP
const std::set<std::string>& minorUnitCodes() const;
//@}
protected:
struct Data;
ext::shared_ptr<Data> data_;
private:
void checkNonEmpty() const;
};
struct Currency::Data {
std::string name, code;
Integer numeric;
std::string symbol, fractionSymbol;
Integer fractionsPerUnit;
Rounding rounding;
Currency triangulated;
std::set<std::string> minorUnitCodes;
Data(std::string name,
std::string code,
Integer numericCode,
std::string symbol,
std::string fractionSymbol,
Integer fractionsPerUnit,
const Rounding& rounding,
Currency triangulationCurrency = Currency(),
std::set<std::string> minorUnitCodes = {});
};
/*! \relates Currency */
bool operator==(const Currency&,
const Currency&);
/*! \relates Currency */
bool operator!=(const Currency&,
const Currency&);
/*! \relates Currency */
std::ostream& operator<<(std::ostream&,
const Currency&);
// inline definitions
inline void Currency::checkNonEmpty() const {
QL_REQUIRE(data_, "no currency data provided");
}
inline const std::string& Currency::name() const {
checkNonEmpty();
return data_->name;
}
inline const std::string& Currency::code() const {
checkNonEmpty();
return data_->code;
}
inline Integer Currency::numericCode() const {
checkNonEmpty();
return data_->numeric;
}
inline const std::string& Currency::symbol() const {
checkNonEmpty();
return data_->symbol;
}
inline const std::string& Currency::fractionSymbol() const {
checkNonEmpty();
return data_->fractionSymbol;
}
inline Integer Currency::fractionsPerUnit() const {
checkNonEmpty();
return data_->fractionsPerUnit;
}
inline const Rounding& Currency::rounding() const {
checkNonEmpty();
return data_->rounding;
}
inline bool Currency::empty() const {
return !data_;
}
inline const Currency& Currency::triangulationCurrency() const {
checkNonEmpty();
return data_->triangulated;
}
inline const std::set<std::string>& Currency::minorUnitCodes() const {
checkNonEmpty();
return data_->minorUnitCodes;
}
inline bool operator==(const Currency& c1, const Currency& c2) {
return (c1.empty() && c2.empty()) ||
(!c1.empty() && !c2.empty() && c1.name() == c2.name());
}
inline bool operator!=(const Currency& c1, const Currency& c2) {
return !(c1 == c2);
}
}
#endif
|
