Skip to content

Commit 11df5f0

Browse files
authored
Update README.md
1 parent 0f8eb32 commit 11df5f0

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

Diff for: README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ target_link_libraries(my_target dragonbox::dragonbox) # or dragonbox::dragonbox_
5858
```
5959

6060
# Language Standard
61-
The library is targeting C++17 and actively using its features (e.g., `if constexpr`).
61+
The library requires C++11 or higher. Since C++20, every function provided is `constexpr`.
6262

6363
# Usage Examples
6464
(Simple string generation from `float/double`)
@@ -98,6 +98,9 @@ By default, `jkj::dragonbox::to_decimal` returns a struct with three members (`s
9898

9999
***Important.*** `jkj::dragonbox::to_decimal` is designed to ***work only with finite nonzero*** inputs. The behavior of it when given with infinities/NaN's/`+0`/`-0` is undefined. `jkj::dragonbox::to_chars` and `jkj::dragonbox::to_chars_n` work fine for any inputs.
100100

101+
# To people wanting to port the algorithm
102+
Those who want to port the algorithm into other languages or re-implement it from scratch are recommended to look at the [simpler implementation](https://github.com/jk-jeon/dragonbox/tree/master/subproject/simple) first rather than the main implementation, since the main implementation is riddled with template indirections obscuring the core logic of the algorithm. The simpler implementation offers less flexibility and somewhat slower performance, but is much more straightforward so it should be easier to understand.
103+
101104
# Policies
102105
Dragonbox provides several policies that the user can select. Most of the time the default policies will be sufficient, but for some situation this customizability might be useful. There are currently five different kinds of policies that you can specify: sign policy, trailing zero policy, decimal-to-binary (parsing) rounding policy, binary-to-decimal (formatting) rounding policy, and cache policy. Those policies live in the namespace `jkj::dragonbox::policy`. You can provide the policies as additional parameters to `jkj::dragonbox::to_decimal` or `jkj::dragonbox::to_chars` or `jkj::dragonbox::to_chars_n`. Here is an example usage:
103106
```cpp

0 commit comments

Comments
 (0)