mirror of
https://github.com/ETLCPP/etl.git
synced 2026-06-15 16:36:03 +08:00
4a88884b39
* Add ranges * Initial Hugo setup * Work in progress * Added selection for local or remote site * Updated to 'light' theme * Changed to using Hextra Hugo theme * Changed to using Hextra Hugo theme * Changed to Hextra Hugo theme * Change to Hextra Hugo theme * Updated Hugo setup. * Updated Hugo setup. # Conflicts: # docs/releases/_index.md * Work in progress * Added new fonts Added new documentation * Latest documentation updates * Latest documentation updates # Conflicts: # docs/containers/array.md # docs/containers/array_view.md # docs/containers/array_wrapper.md # docs/containers/bip_buffer_spsc_atomic.md # docs/containers/bitset.md # docs/containers/indirect_vector.md # docs/containers/vector.md # docs/getting-started/compilers.md * Added bloom_filter markdown doc * Added more documentation Updated CSS for light and dark modes * Fixed some menus Added mode documentation files * Updated CSS rules Added badges to home page Added uniqur_ptr + pool tutorial * Fixed formatting on the home page markdown Modified light amd dark code formatting * Updated unique_ptr-with-pool * Added container and shared message tutorials * Updates to documentation * Added const_multimap * Updated source-formatting.md * Added initial raw text files form Web site editor * Innore coverage build directory * Exported raw text documentation files from the web site editor * Hugo updates * Added Hugo intalation and markdown descriptions * More addition to the documentation * Added closure.md and updates to delegate.md * Added format.md * Added documentation for etl::delegate_observable, etl::function, Base64 codec * Added io_port documentation * Added basic_format_spec * Added documentation for string_stream and string utilities. * Added more documentation Updated the documentation CSS * Added documentation for clocks, day, duration * Added more documentation for chrono classes Updated callouts * More chrono documentation * Completed chrono documentation * Maths functions documentation * Completed maths documentation * Completed maths documentation * Completed maths documentation * Completed maths documentation * Added multiple documentation files * Added iterator.md * Added debug_count.md and versions.md * Added debug_count.md and versions.md * Added more documentation * More documentation * Added some design pattern documentation Modified some of the layout files Modified the About documentation * Converted more documentation pages Modified the site CSS * Added more documentation Moced some documentation files to new directories * Added more documentation Tweaks to CSS * Added callback_timer_deferred_locked documentation * Added callback_timer_locked documentation * More documentation updates * More documentation updates * More documentation updates * New documentation files. Harmonised file name format * New documentation files. * Multiple document updates * Multiple document updates * Final conversion of web pages * Updates before PR * Updates before PR * Updates before PR # Conflicts: # docs/blog/_index.md * Final pre PR updates * Updates to message framework documentation * Renamed directory * Fix spelling * Added author and date to blog files Moved documentation files merged from development * Fixed 'Description' typo * Fix typos # Conflicts: # docs/IO/io_port.md # docs/containers/sets/const-multiset.md # docs/containers/sets/const-set.md # docs/maths/correlation.md # docs/maths/gamma.md * Renamed two files to lower case * Minor renaming * Added author and date * Updated callout on bresenham_line.md Added support for showing the ETL version on the documentation first page, by copying the version.txt file as a hugo asset. Updated the Python 'update_release.py' to copy 'version.txt' * Replace space in filename with hyphen. Added more information to hugo-commands.md * Replace space in filename with hyphen. Added more information to hugo-commands.md # Conflicts: # docs/getting-started/view-the-docs-locally/hugo-commands.md * Added a link to pseudo_moving_average.md * Updated title pages for groups * Fixed missing 404 for non-existent pages * Fixed coordinate variable names in the 'Calculating the intersection' example --------- Co-authored-by: Roland Reichwein <Roland.Reichwein@bmw.de> Co-authored-by: John Wellbelove <john.wellbelove@etlcpp.com> Co-authored-by: John Wellbelove <john.wellbelove@etlcpp.co.uk>
381 lines
8.8 KiB
Markdown
381 lines
8.8 KiB
Markdown
---
|
|
title: "to_arithmetic"
|
|
---
|
|
|
|
{{< callout type="info">}}
|
|
Header: `to_arithmetic.h`
|
|
{{< /callout >}}
|
|
|
|
Functions that will convert a text representation of an arithmetic type to a value.
|
|
Converts from binary, octal, decimal and hex integrals, and decimal floating point types.
|
|
Supports conversion from `char`, `wchar_t`, `char8_t`, `char16_t`, and `char32_t` strings.
|
|
The numeric strings must not contain leading or trailing non-numeric characters. It is the responsibility of the user to select the valid character range.
|
|
Integral types may be `constexpr`.
|
|
|
|
## to_arithmetic_status
|
|
An ETL enum type that defines the following enumeration values.
|
|
The are the values that may be set as the error code in to_arithmetic_result.
|
|
|
|
```cpp
|
|
Valid
|
|
Invalid_Radix
|
|
Invalid_Format
|
|
Invalid_Float
|
|
Signed_To_Unsigned
|
|
Overflow
|
|
```
|
|
|
|
## to_arithmetic_result
|
|
The result type returned from `etl::to_arithmetic`.
|
|
|
|
```cpp
|
|
template <typename TValue>
|
|
to_arithmetic_result
|
|
```
|
|
|
|
**Types**
|
|
```cpp
|
|
value_type TValue
|
|
error_type etl::to_arithmetic_status
|
|
unexpected_type etl::unexpected<etl::to_arithmetic_status>
|
|
```
|
|
|
|
---
|
|
|
|
```cpp
|
|
ETL_CONSTEXPR14
|
|
to_arithmetic_result()
|
|
```
|
|
Default constructor.
|
|
|
|
---
|
|
|
|
```cpp
|
|
ETL_CONSTEXPR14
|
|
to_arithmetic_result(const to_arithmetic_result& other)
|
|
```
|
|
Copy constructor.
|
|
|
|
---
|
|
|
|
```cpp
|
|
ETL_NODISCARD
|
|
ETL_CONSTEXPR14
|
|
bool has_value() const
|
|
```
|
|
Returns `true` if the result has a valid value.
|
|
If `false` then the value is undefined.
|
|
|
|
---
|
|
|
|
```cpp
|
|
ETL_NODISCARD
|
|
ETL_CONSTEXPR14
|
|
operator bool() const
|
|
```
|
|
Returns `true` if the result has a valid value.
|
|
If `false` then the value is undefined.
|
|
|
|
---
|
|
|
|
```cpp
|
|
ETL_NODISCARD
|
|
ETL_CONSTEXPR14
|
|
value_type value() const
|
|
```
|
|
Returns the value, if valid.
|
|
Otherwise undefined.
|
|
|
|
---
|
|
|
|
```cpp
|
|
ETL_NODISCARD
|
|
ETL_CONSTEXPR14
|
|
operator value_type() const
|
|
```
|
|
Returns the value, if valid.
|
|
Otherwise undefined.
|
|
|
|
---
|
|
|
|
```cpp
|
|
ETL_NODISCARD
|
|
ETL_CONSTEXPR14
|
|
error_type error() const
|
|
```
|
|
Returns the conversion status.
|
|
One of the following:-
|
|
```cpp
|
|
Valid
|
|
Invalid_Radix
|
|
Invalid_Format
|
|
Invalid_Float
|
|
Signed_To_Unsigned
|
|
Overflow
|
|
```
|
|
|
|
---
|
|
|
|
```cpp
|
|
ETL_CONSTEXPR14
|
|
to_arithmetic_result& operator =(value_type value)
|
|
```
|
|
Assign from a value_type.
|
|
|
|
---
|
|
|
|
```cpp
|
|
ETL_CONSTEXPR14
|
|
to_arithmetic_result& operator =(unexpected_type status)
|
|
```
|
|
Assign from an unexpected_type.
|
|
|
|
---
|
|
|
|
## to_arithmetic
|
|
Convert a string to an integral or floating point value.
|
|
Supports:
|
|
`etl::string_view` (`etl::basic_string_view<TChar>`)
|
|
const pointer (to `char`, `wchar_t`, `char8_t`, `char16_t`, `char32_t`) + length
|
|
`etl::string`, `etl::wstring`, `etl::u8string`, `etl::u16string`, or `etl::u32string`.
|
|
|
|
```cpp
|
|
template <typename TValue, typename TChar>
|
|
ETL_NODISCARD
|
|
ETL_CONSTEXPR14
|
|
etl::to_arithmetic_result<TValue> to_arithmetic(const etl::basic_string_view<TChar>& view)
|
|
```
|
|
Text to integral or floating point from view and default decimal radix.
|
|
|
|
---
|
|
|
|
```cpp
|
|
template <typename TValue, typename TChar>
|
|
ETL_NODISCARD
|
|
ETL_CONSTEXPR14
|
|
etl::to_arithmetic_result<TValue> to_arithmetic(etl::basic_string_view<TChar> view,
|
|
const etl::radix::value_type radix)
|
|
```
|
|
Text to integral from view and radix value type.
|
|
radix may be one of the following:-
|
|
```cpp
|
|
etl::radix::binary
|
|
etl::radix::octal
|
|
etl::radix::decimal
|
|
etl::radix::hex
|
|
```
|
|
|
|
---
|
|
|
|
```cpp
|
|
ETL_NODISCARD
|
|
ETL_CONSTEXPR14
|
|
etl::to_arithmetic_result<TValue> to_arithmetic(const etl::basic_string_view<TChar>& view,
|
|
const etl::private_basic_format_spec::base_spec& spec)
|
|
```
|
|
Text to integral from view and radix format spec.
|
|
spec may be one of the following:-
|
|
```cpp
|
|
etl::bin
|
|
etl::oct
|
|
etl::dec
|
|
etl::hex
|
|
```
|
|
|
|
---
|
|
|
|
```cpp
|
|
template <typename TValue, typename TChar>
|
|
ETL_NODISCARD
|
|
ETL_CONSTEXPR14
|
|
etl::to_arithmetic_result<TValue> to_arithmetic(const TChar* cp,
|
|
size_t length)
|
|
```
|
|
Text to integral or floating point from pointer, length and default decimal radix.
|
|
|
|
---
|
|
|
|
```cpp
|
|
template <typename TValue, typename TChar>
|
|
ETL_NODISCARD
|
|
ETL_CONSTEXPR14
|
|
etl::to_arithmetic_result<TValue> to_arithmetic(const TChar* cp,
|
|
size_t length,
|
|
const etl::radix::value_type radix)
|
|
```
|
|
Text to integral from pointer, length and radix value type.
|
|
radix may be one of the following:-
|
|
```cpp
|
|
etl::radix::binary
|
|
etl::radix::octal
|
|
etl::radix::decimal
|
|
etl::radix::hex
|
|
```
|
|
|
|
---
|
|
|
|
```cpp
|
|
template <typename TValue, typename TChar>
|
|
ETL_NODISCARD
|
|
ETL_CONSTEXPR14
|
|
etl::to_arithmetic_result<TValue> to_arithmetic(const TChar* cp,
|
|
size_t length,
|
|
const etl::private_basic_format_spec::base_spec& spec)
|
|
```
|
|
Text to integral from pointer, length and radix format spec.
|
|
spec may be one of the following:-
|
|
```cpp
|
|
etl::bin
|
|
etl::oct
|
|
etl::dec
|
|
etl::hex
|
|
```
|
|
|
|
---
|
|
|
|
```cpp
|
|
template <typename TValue, typename TChar>
|
|
ETL_NODISCARD
|
|
ETL_CONSTEXPR14
|
|
etl::to_arithmetic_result<TValue> to_arithmetic(const etl::ibasic_string<TChar>& str)
|
|
```
|
|
Text to integral or floating point from string and default decimal radix.
|
|
|
|
---
|
|
|
|
```cpp
|
|
template <typename TValue, typename TChar>
|
|
ETL_NODISCARD
|
|
ETL_CONSTEXPR14
|
|
etl::to_arithmetic_result<TValue> to_arithmetic(const etl::ibasic_string<TChar>& str,
|
|
const etl::radix::value_type radix)
|
|
```
|
|
Text to integral from string and radix value type.
|
|
radix may be one of the following:-
|
|
```cpp
|
|
etl::radix::binary
|
|
etl::radix::octal
|
|
etl::radix::decimal
|
|
etl::radix::hex
|
|
```
|
|
|
|
---
|
|
|
|
```cpp
|
|
template <typename TValue, typename TChar>
|
|
ETL_NODISCARD
|
|
ETL_CONSTEXPR14
|
|
etl::to_arithmetic_result<TValue> to_arithmetic(const etl::ibasic_string<TChar>& str,
|
|
const etl::private_basic_format_spec::base_spec& spec)
|
|
```
|
|
Text to integral from string and radix format spec.
|
|
spec may be one of the following:-
|
|
```cpp
|
|
etl::bin
|
|
etl::oct
|
|
etl::dec
|
|
etl::hex
|
|
```
|
|
|
|
## Non-member functions
|
|
|
|
```cpp
|
|
template <typename T>
|
|
ETL_CONSTEXPR14 bool operator ==(const etl::to_arithmetic_result<T>& lhs,
|
|
const etl::to_arithmetic_result<T>& rhs)
|
|
```
|
|
Equality test for etl::to_arithmetic_result
|
|
|
|
---
|
|
|
|
```cpp
|
|
template <typename T, typename U>
|
|
ETL_CONSTEXPR14 bool operator ==(const etl::to_arithmetic_result<T>& lhs,
|
|
const U& rhs)
|
|
```
|
|
Equality test for etl::to_arithmetic_result
|
|
|
|
---
|
|
|
|
```cpp
|
|
template <typename T, typename U>
|
|
ETL_CONSTEXPR14 bool operator ==(const T& lhs,
|
|
const etl::to_arithmetic_result<U>& rhs)
|
|
```
|
|
Equality test for etl::to_arithmetic_result
|
|
|
|
---
|
|
|
|
```cpp
|
|
template <typename T>
|
|
ETL_CONSTEXPR14 bool operator !=(const etl::to_arithmetic_result<T>& lhs,
|
|
const etl::to_arithmetic_result<T>& rhs)
|
|
```
|
|
Inequality test for etl::to_arithmetic_result
|
|
|
|
---
|
|
|
|
```cpp
|
|
template <typename T, typename U>
|
|
ETL_CONSTEXPR14 bool operator !=(const etl::to_arithmetic_result<T>& lhs,
|
|
const U& rhs)
|
|
```
|
|
Inequality test for etl::to_arithmetic_result
|
|
|
|
---
|
|
|
|
```cpp
|
|
template <typename T, typename U>
|
|
ETL_CONSTEXPR14 bool operator !=(const T& lhs,
|
|
const etl::to_arithmetic_result<T>& rhs)
|
|
```
|
|
Inequality test for etl::to_arithmetic_result
|
|
|
|
## Examples
|
|
|
|
**Valid conversions**
|
|
```cpp
|
|
const char* BinaryText("1010011");
|
|
const etl::string<3> OctalText("123");
|
|
const etl::string<4> DecimalText(" 83 ");
|
|
const etl::string<2> HexText("85");
|
|
const etl::string<2> FloatText("-123e5");
|
|
|
|
// From char pointer to binary text. Format spec radix.
|
|
int v1 = etl::to_arithmetic<int>(BinaryText, strlen(BinaryText), etl::bin);
|
|
|
|
// From char pointer from octal text string. Radix spec value.
|
|
int v2 = etl::to_arithmetic<int>(OctalText.c_str(), OctalText.size(), etl::radix::octal);
|
|
|
|
// From view of decimal text string. Default base 10 radix.
|
|
etl::string_view view(DecimalText.data() + 1, DecimalText.data() + 3);
|
|
int v3 = etl::to_arithmetic<int>(view);
|
|
|
|
// From hex string. Base 16 radix.
|
|
int v4 = etl::to_arithmetic<int>(HexText, 16);
|
|
```
|
|
---
|
|
|
|
**Invalid conversions**
|
|
```cpp
|
|
const etl::string<10> Text1("abcd");
|
|
const etl::string<10> Text2(" 83 ");
|
|
const etl::string<10> Text3("-83");
|
|
const etl::string<10> Text4("4294967296");
|
|
const etl::string<10> Text5("1.23E10000");
|
|
|
|
etl::to_arithmetic_result result;
|
|
|
|
result = etl::to_arithmetic<int32_t>(Text1, 5); // etl::to_arithmetic_status::Invalid_Radix
|
|
|
|
result = etl::to_arithmetic<int32_t>(Text1); // etl::to_arithmetic_status::Invalid_Format
|
|
|
|
result = etl::to_arithmetic<int32_t>(Text2); // etl::to_arithmetic_status::Invalid_Format
|
|
|
|
result = etl::to_arithmetic<uint32_t>(Text3); // etl::to_arithmetic_status::Signed_To_Unsigned
|
|
|
|
result = etl::to_arithmetic<int32_t>(Text4); // etl::to_arithmetic_status::Overflow
|
|
|
|
result = etl::to_arithmetic<float>(Text5); // etl::to_arithmetic_status::Overflow
|
|
```
|