Spec-Zone.ru › C++

std::from_chars

Определено в заголовке <charconv>
std::from_chars_result
    from_chars( const char* first, const char* last,
                /* integer-type */& value, int base = 10 );
(1) (с C++17)
(constexpr с C++23)
(2)
std::from_chars_result
    from_chars( const char* first, const char* last, float& value,
                std::chars_format fmt = std::chars_format::general );
std::from_chars_result
    from_chars( const char* first, const char* last, double& value,
                std::chars_format fmt = std::chars_format::general );
std::from_chars_result
    from_chars( const char* first, const char* last, long double& value,
                std::chars_format fmt = std::chars_format::general );
(с C++17)
(до C++23)
std::from_chars_result
    from_chars( const char* first, const char* last,
                /* floating-point-type */& value,
                std::chars_format fmt = std::chars_format::general );
(с C++23)

Анализирует последовательность символов [first, last) по шаблону, описанному ниже. Если символы не соответствуют шаблону или значение, полученное при разборе, не может быть представлено в типе value, value не изменяется, в противном случае символы, соответствующие шаблону, интерпретируются как текстовое представление арифметического значения, которое сохраняется в value.

1) Парсеры целых чисел: Ожидает шаблон, идентичный тому, который используется std::strtol в стандартной ("C") локали и заданном ненулевом числовом основании, за исключением того, что
  • префиксы "0x" или "0X" не распознаются, если base равно 16
  • распознаётся только знак минус (не плюс), и только для целых типов со знаком value
  • начальные пробелы не игнорируются.
Библиотека предоставляет перегрузки для всех cv-неквалифицированных(с C++23) целых типов со знаком и без знака, а также char в качестве типа параметра value. 2) Парсеры чисел с плавающей точкой: Ожидает шаблон, идентичный тому, который используется std::strtod в стандартной ("C") локали, за исключением того, что
  • знак плюс не распознаётся вне экспоненты (разрешен только знак минус в начале)
  • если fmt имеет std::chars_format::scientific установленным, но не std::chars_format::fixed, часть экспоненты обязательна (иначе она необязательна)
  • если fmt имеет std::chars_format::fixed установленным, но не std::chars_format::scientific, необязательная часть экспоненты запрещена
  • если fmt равно std::chars_format::hex, префиксы "0x" или "0X" запрещены (строка "0x123" разбирается как значение "0" с необработанным остатком "x123")
  • начальные пробелы не игнорируются.
В любом случае, полученное значение является одним из двух чисел с плавающей точкой, наиболее близких к значению строки, соответствующей шаблону, после округления в соответствии с std::round_to_nearest.
Библиотека предоставляет перегрузки для всех cv-неквалифицированных типов чисел с плавающей точкой в качестве типа параметра value. (с C++23)

Параметры

first, last - диапазон допустимых символов для разбора
value - параметр для хранения результата разбора, если разбор успешен
base - основание для целых чисел: значение между 2 и 36 (включительно).
fmt - формат чисел с плавающей точкой для использования, битовая маска типа std::chars_format

Возвращаемое значение

При успехе возвращает значение типа std::from_chars_result, такое что ptr указывает на первый символ, не соответствующий шаблону, или имеет значение, равное last , если все символы соответствуют шаблону, и ec инициализировано значением по умолчанию.

Если шаблон не соответствует ни одному символу, возвращает значение типа std::from_chars_result, такое что ptr равно first и ec равно std::errc::invalid_argument. value не изменяется.

Если шаблон соответствует, но полученное значение не входит в диапазон, представимый типом value, возвращает значение типа std::from_chars_result, такое что ec равно std::errc::result_out_of_range и ptr указывает на первый символ, не соответствующий шаблону. value не изменяется.

Исключения

Ничего не выбрасывает.

Примечания

В отличие от других функций разбора в C++ и C, std::from_chars независима от локали, не выделяет память и не вызывает исключения. Предоставлен только небольшой подмножество политик разбора, используемых другими библиотеками (например, std::sscanf). Это предназначено для максимально быстрой реализации, полезной в общих высокопроизводительных контекстах, таких как текстовый обмен (JSON или XML).

Гарантия, что std::from_chars может восстановить каждое значение с плавающей точкой, отформатированное функцией std::to_chars, точно предоставляется только если обе функции из одной реализации.

Шаблон, состоящий из знака без последующих цифр, обрабатывается как шаблон, который ничего не соответствует.

Макрокоманда проверки наличия функции Значение Стандарт Функция
__cpp_lib_to_chars 201611L (C++17) Элементарные преобразования строк (std::from_chars, std::to_chars)
202306L (C++26) Проверка успешности или неудачи функций <charconv>
__cpp_lib_constexpr_charconv 202207L (C++23) Добавление модификаторов constexpr к перегрузкам std::from_chars и std::to_chars для целочисленных типов

Пример

#include <cassert>
#include <charconv>
#include <iomanip>
#include <iostream>
#include <optional>
#include <string_view>
#include <system_error>
 
int main()
{
    for (std::string_view const str : {"1234", "15 foo", "bar", " 42", "5000000000"})
    {
        std::cout << "String: " << std::quoted(str) << ". ";
        int result{};
        auto [ptr, ec] = std::from_chars(str.data(), str.data() + str.size(), result);
 
        if (ec == std::errc())
            std::cout << "Result: " << result << ", ptr -> " << std::quoted(ptr) << '\n';
        else if (ec == std::errc::invalid_argument)
            std::cout << "This is not a number.\n";
        else if (ec == std::errc::result_out_of_range)
            std::cout << "This number is larger than an int.\n";
    }
 
    // C++23's constexpr from_char demo / C++26's operator bool() demo:
    auto to_int = [](std::string_view s) -> std::optional<int>
    {
        int value{};
#if __cpp_lib_to_chars >= 202306L
        if (std::from_chars(s.data(), s.data() + s.size(), value))
#else
        if (std::from_chars(s.data(), s.data() + s.size(), value).ec == std::errc{})
#endif
            return value;
        else
            return std::nullopt;
    };
 
    assert(to_int("42") == 42);
    assert(to_int("foo") == std::nullopt);
#if __cpp_lib_constexpr_charconv and __cpp_lib_optional >= 202106
    static_assert(to_int("42") == 42);
    static_assert(to_int("foo") == std::nullopt);
#endif
}

Вывод:

String: "1234". Result: 1234, ptr -> ""
String: "15 foo". Result: 15, ptr -> " foo"
String: "bar". This is not a number.
String: " 42". This is not a number.
String: "5000000000". This number is larger than an int.

Отчёты об ошибках

Следующие отчёты об ошибках, меняющие поведение, были применены ретроактивно к ранее опубликованным стандартам C++.

DR Применено к Поведение, опубликованное в исходном виде Корректное поведение
LWG 2955 C++17 Эта функция находилась в <utility> и использовала std::error_code Перемещена в <charconv> и использует std::errc
LWG 3373 C++17 std::from_chars_result могла иметь дополнительные члены Дополнительные члены запрещены

См. также

from_chars_result
(C++17)
тип возвращаемого значения для std::from_chars
(класс)
to_chars
(C++17)
преобразует целое или число с плавающей точкой в последовательность символов
(функция)
stoistolstoll
(C++11)(C++11)(C++11)
преобразует строку в целое число со знаком
(функция)
stofstodstold
(C++11)(C++11)(C++11)
преобразует строку в значение с плавающей точкой
(функция)
strtolstrtoll
(C++11)
преобразует строку байтов в целое значение
(функция)
strtofstrtodstrtold
преобразует строку байтов в значение с плавающей точкой
(функция)
scanffscanfsscanf
считывает форматированный ввод из stdin, потока файла или буфера
(функция)
operator>>
извлекает форматированные данные
(публичный член-функция std::basic_istream<CharT,Traits>)

© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://en.cppreference.com/w/cpp/utility/from_chars

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API