Difference between revisions of "cpp/locale/num get"
m (Text replace - "{{cpp|" to "{{c|") |
(Added LWG issue #2392 DR (part 3).) |
||
(22 intermediate revisions by 9 users not shown) | |||
Line 1: | Line 1: | ||
{{cpp/title|num_get}} | {{cpp/title|num_get}} | ||
− | {{cpp/locale/num_get/ | + | {{cpp/locale/num_get/navbar}} |
− | {{ | + | {{dcl begin}} |
− | {{ | + | {{dcl header|locale}} |
− | {{ | + | {{dcl|1= |
− | template< class | + | template< |
− | + | class CharT, | |
− | > class num_get | + | class InputIt = std::istreambuf_iterator<CharT> |
+ | > class num_get; | ||
}} | }} | ||
− | {{ | + | {{dcl end}} |
− | Class {{tt|std::num_get}} encapsulates the rules for parsing string representations of values | + | Class {{tt|std::num_get}} encapsulates the rules for parsing string representations of numeric values. Specifically, types {{c/core|bool}}, {{c/core|unsigned short}}, {{c/core|unsigned int}}, {{c/core|long}}, {{c/core|unsigned long}}{{rev inl|since=c++11|, {{c/core|long long}}, {{c/core|unsigned long long}}}}, {{c/core|float}}, {{c/core|double}}, {{c/core|long double}}, and {{c/core|void*}} are supported. The standard formatting input operators (such as {{c|cin >> n;}}) use the {{tt|std::num_get}} facet of the I/O stream's locale to parse the text representations of the numbers. |
− | + | {{inheritance diagram/std-num_get}} | |
− | {{ | + | If a {{tt|std::num_get}} specialization is not guaranteed to be provided by the standard library (see below), the behaviors of its {{lc|get()}} and {{lc|do_get()}} are not guaranteed as specified. |
− | + | ||
− | + | ||
− | {{ | + | |
− | {{ | + | |
− | + | ||
− | + | ||
− | === | + | ===Specializations=== |
− | {{ | + | The standard library is guaranteed to provide the following specializations (they are {{rlp|locale|required to be implemented by any locale object}}): |
− | {{ | + | {{dsc begin}} |
− | {{ | + | {{dsc header|locale}} |
− | {{ | + | {{dsc|{{c/core|std::num_get<char>}}|creates narrow string parsing of numbers}} |
− | {{ | + | {{dsc|{{c/core|std::num_get<wchar_t>}}|creates wide string parsing of numbers}} |
+ | {{dsc end}} | ||
− | ===Member | + | In addition, the standard library is also guaranteed to provide every specialization that satisfies the following type requirements: |
− | {{ | + | * {{tt|CharT}} is one of |
− | {{ | + | ** {{c/core|char}}, |
− | {{ | + | ** {{c/core|wchar_t}}, and |
− | {{ | + | ** any other implementation-defined [[cpp/string|character container type]] that meets the requirements for a character on which any of the [[cpp/io|iostream components]] can be instantiated; and |
+ | * {{tt|InputIt}} must meet the requirements of {{named req|InputIterator}}. | ||
+ | |||
+ | ===Member types=== | ||
+ | {{dsc begin}} | ||
+ | {{dsc hitem|Member type|Definition}} | ||
+ | {{dsc|{{tt|char_type}}|{{tt|CharT}}}} | ||
+ | {{dsc|{{tt|iter_type}}|{{tt|InputIt}}}} | ||
+ | {{dsc end}} | ||
===Member functions=== | ===Member functions=== | ||
− | {{ | + | {{dsc begin}} |
− | {{ | + | {{dsc mem ctor|cpp/locale/num_get/num_get|constructs a new {{tt|num_get}} facet}} |
− | {{ | + | {{dsc mem fun|cpp/locale/num_get/get|invokes {{tt|do_get}}}} |
− | {{ | + | {{dsc end}} |
− | {{ | + | |
+ | ===Member objects=== | ||
+ | {{dsc begin}} | ||
+ | {{dsc mem obj|nolink=true|{{dsc small|static std::locale::id}} id|''id'' of the locale}} | ||
+ | {{dsc end}} | ||
===Protected member functions=== | ===Protected member functions=== | ||
− | {{ | + | {{dsc begin}} |
− | {{ | + | {{dsc prot mem dtor|cpp/locale/num_get/~num_get|destructs a {{tt|num_get}} facet}} |
− | {{ | + | {{dsc prot mem vfun|cpp/locale/num_get/get|title=do_get|parses a number from an input stream}} |
+ | {{dsc end}} | ||
===Example=== | ===Example=== | ||
− | |||
{{example | {{example | ||
− | + | |code= | |
− | + | ||
#include <iostream> | #include <iostream> | ||
+ | #include <iterator> | ||
#include <locale> | #include <locale> | ||
− | |||
#include <sstream> | #include <sstream> | ||
− | #include < | + | #include <string> |
+ | |||
int main() | int main() | ||
{ | { | ||
std::string de_double = "1.234.567,89"; | std::string de_double = "1.234.567,89"; | ||
std::string us_double = "1,234,567.89"; | std::string us_double = "1,234,567.89"; | ||
− | + | ||
// parse using streams | // parse using streams | ||
std::istringstream de_in(de_double); | std::istringstream de_in(de_double); | ||
− | de_in.imbue(std::locale("de_DE")); | + | de_in.imbue(std::locale("de_DE.UTF-8")); |
double f1; | double f1; | ||
de_in >> f1; | de_in >> f1; | ||
− | + | ||
std::istringstream us_in(de_double); | std::istringstream us_in(de_double); | ||
us_in.imbue(std::locale("en_US.UTF-8")); | us_in.imbue(std::locale("en_US.UTF-8")); | ||
double f2; | double f2; | ||
us_in >> f2; | us_in >> f2; | ||
− | + | ||
std::cout << "Parsing " << de_double << " as double gives " << std::fixed | std::cout << "Parsing " << de_double << " as double gives " << std::fixed | ||
<< f1 << " in de_DE locale and " << f2 << " in en_US\n"; | << f1 << " in de_DE locale and " << f2 << " in en_US\n"; | ||
− | + | ||
// use the facet directly | // use the facet directly | ||
std::istringstream s3(us_double); | std::istringstream s3(us_double); | ||
s3.imbue(std::locale("en_US.UTF-8")); | s3.imbue(std::locale("en_US.UTF-8")); | ||
+ | |||
auto& f = std::use_facet<std::num_get<char>>(s3.getloc()); | auto& f = std::use_facet<std::num_get<char>>(s3.getloc()); | ||
std::istreambuf_iterator<char> beg(s3), end; | std::istreambuf_iterator<char> beg(s3), end; | ||
Line 84: | Line 93: | ||
std::ios::iostate err; | std::ios::iostate err; | ||
f.get(beg, end, s3, err, f3); | f.get(beg, end, s3, err, f3); | ||
+ | |||
std::cout << "parsing " << us_double | std::cout << "parsing " << us_double | ||
<< " as double using raw en_US facet gives " << f3 << '\n'; | << " as double using raw en_US facet gives " << f3 << '\n'; | ||
} | } | ||
− | + | |output= | |
Parsing 1.234.567,89 as double gives 1234567.890000 in de_DE locale and 1.234000 in en_US | Parsing 1.234.567,89 as double gives 1234567.890000 in de_DE locale and 1.234000 in en_US | ||
parsing 1,234,567.89 as double using raw en_US facet gives 1234567.890000 | parsing 1,234,567.89 as double using raw en_US facet gives 1234567.890000 | ||
}} | }} | ||
+ | |||
+ | ===Defect reports=== | ||
+ | {{dr list begin}} | ||
+ | {{dr list item|wg=lwg|dr=427|std=C++98|before={{tt|num_get}} was guaranteed to accept any {{tt|CharT}} that<br>meets the requirements for a character on which<br>any of the iostream components can be instantiated|after=only guarantees to accept {{c/core|char}},<br>{{c/core|wchar_t}} and other implementation-<br>defined character types}} | ||
+ | {{dr list item|wg=lwg|dr=2392|std=C++98|before=only character type {{tt|CharT}} could be<br>guaranteed to be accepted by {{tt|num_get}}|after=can guarantee to accept implementation-<br>defined character container types}} | ||
+ | {{dr list end}} | ||
===See also=== | ===See also=== | ||
− | {{ | + | {{dsc begin}} |
− | {{ | + | {{dsc inc|cpp/locale/dsc numpunct}} |
− | {{ | + | {{dsc inc|cpp/locale/dsc num_put}} |
− | {{ | + | {{dsc inc|cpp/io/basic_istream/dsc operator_gtgt}} |
− | {{ | + | {{dsc end}} |
+ | |||
+ | {{langlinks|de|es|fr|it|ja|pt|ru|zh}} |
Latest revision as of 22:32, 1 February 2024
Defined in header <locale>
|
||
template< class CharT, |
||
Class std::num_get
encapsulates the rules for parsing string representations of numeric values. Specifically, types bool, unsigned short, unsigned int, long, unsigned long, long long, unsigned long long(since C++11), float, double, long double, and void* are supported. The standard formatting input operators (such as cin >> n;) use the std::num_get
facet of the I/O stream's locale to parse the text representations of the numbers.
Inheritance diagram
If a std::num_get
specialization is not guaranteed to be provided by the standard library (see below), the behaviors of its get() and do_get() are not guaranteed as specified.
Contents |
[edit] Specializations
The standard library is guaranteed to provide the following specializations (they are required to be implemented by any locale object):
Defined in header
<locale> | |
std::num_get<char> | creates narrow string parsing of numbers |
std::num_get<wchar_t> | creates wide string parsing of numbers |
In addition, the standard library is also guaranteed to provide every specialization that satisfies the following type requirements:
-
CharT
is one of- char,
- wchar_t, and
- any other implementation-defined character container type that meets the requirements for a character on which any of the iostream components can be instantiated; and
-
InputIt
must meet the requirements of LegacyInputIterator.
[edit] Member types
Member type | Definition |
char_type
|
CharT
|
iter_type
|
InputIt
|
[edit] Member functions
constructs a new num_get facet (public member function) | |
invokes do_get (public member function) |
[edit] Member objects
static std::locale::id id |
id of the locale (public member object) |
[edit] Protected member functions
destructs a num_get facet (protected member function) | |
[virtual] |
parses a number from an input stream (virtual protected member function) |
[edit] Example
#include <iostream> #include <iterator> #include <locale> #include <sstream> #include <string> int main() { std::string de_double = "1.234.567,89"; std::string us_double = "1,234,567.89"; // parse using streams std::istringstream de_in(de_double); de_in.imbue(std::locale("de_DE.UTF-8")); double f1; de_in >> f1; std::istringstream us_in(de_double); us_in.imbue(std::locale("en_US.UTF-8")); double f2; us_in >> f2; std::cout << "Parsing " << de_double << " as double gives " << std::fixed << f1 << " in de_DE locale and " << f2 << " in en_US\n"; // use the facet directly std::istringstream s3(us_double); s3.imbue(std::locale("en_US.UTF-8")); auto& f = std::use_facet<std::num_get<char>>(s3.getloc()); std::istreambuf_iterator<char> beg(s3), end; double f3; std::ios::iostate err; f.get(beg, end, s3, err, f3); std::cout << "parsing " << us_double << " as double using raw en_US facet gives " << f3 << '\n'; }
Output:
Parsing 1.234.567,89 as double gives 1234567.890000 in de_DE locale and 1.234000 in en_US parsing 1,234,567.89 as double using raw en_US facet gives 1234567.890000
[edit] Defect reports
The following behavior-changing defect reports were applied retroactively to previously published C++ standards.
DR | Applied to | Behavior as published | Correct behavior |
---|---|---|---|
LWG 427 | C++98 | num_get was guaranteed to accept any CharT thatmeets the requirements for a character on which any of the iostream components can be instantiated |
only guarantees to accept char, wchar_t and other implementation- defined character types |
LWG 2392 | C++98 | only character type CharT could beguaranteed to be accepted by num_get
|
can guarantee to accept implementation- defined character container types |
[edit] See also
defines numeric punctuation rules (class template) | |
formats numeric values for output as character sequence (class template) | |
extracts formatted data (public member function of std::basic_istream<CharT,Traits> )
|