stdlib 3b: clarify rounding modes and ++ma arms

This commit is contained in:
Tinnus Napbus 2022-10-21 19:30:11 +13:00
parent 502b0d1e46
commit e1379903c6

View File

@ -4231,8 +4231,10 @@ Double-precision fp
A container core for operations related to double-precision binary floats.
`++rd` has four rounding modes: round to nearest (`$n`), round up (`$u`), round
down (`$d`), and round to zero (`$z`).
`++rd` has four rounding modes: round to nearest (`%n`), round up (`%u`), round
down (`%d`), and round to zero (`%z`). The default rounding mode is `%z`. If
you need a different rounding mode, you'd do something like `=/ rd-n ~(. rd
%n)` and then call the arms of your modified version instead.
#### Source
@ -4250,7 +4252,8 @@ down (`$d`), and round to zero (`$z`).
Initialize `ff`
Instantiates the core `ff`, giving values to its samples based on the
configuration of the `rd` core.
configuration of the `rd` core. **This arm is used internally by `++rd`, you
would not normally call this directly.**
#### Source
@ -4936,8 +4939,10 @@ Single-precision fp
A container core for operations related to single-precision binary floats.
`++rs` has four rounding modes: round to nearest (`$n`), round up (`$u`), round
down (`$d`), and round to zero (`$z`).
`++rs` has four rounding modes: round to nearest (`%n`), round up (`%u`), round
down (`%d`), and round to zero (`%z`). The default rounding mode is `%z`. If
you need a different rounding mode, you'd do something like `=/ rs-n ~(. rs
%n)` and then call the arms of your modified version instead.
#### Source
@ -4955,7 +4960,8 @@ down (`$d`), and round to zero (`$z`).
Initialize `ff`
Instantiates the core `ff`, giving values to its samples based on the
configuration of the `rs` core.
configuration of the `rs` core. **This arm is used internally by `++rs`, you
would not normally call this directly.**
#### Source
@ -5638,7 +5644,9 @@ Quadruple-precision fp
A container core for operations related to quadruple-precision binary floats.
`++rq` has four rounding modes: round to nearest (`%n`), round up (`%u`), round
down (`%d`), and round to zero (`%z`).
down (`%d`), and round to zero (`%z`). The default rounding mode is `%z`. If
you need a different rounding mode, you'd do something like `=/ rq-n ~(. rq
%n)` and then call the arms of your modified version instead.
#### Source
@ -5654,7 +5662,8 @@ down (`%d`), and round to zero (`%z`).
Initialize `ff`
Instantiates the core `ff`, giving values to its samples based on the
configuration of the `rq` core.
configuration of the `rq` core. **This arm is used internally by `++rq`, you
would not normally call this directly.**
#### Source
@ -6344,7 +6353,9 @@ Half-precision fp
A container core for operations related to half-precision binary floats.
`++rh` has four rounding modes: round to nearest (`%n`), round up (`%u`), round
down (`%d`), and round to zero (`%z`).
down (`%d`), and round to zero (`%z`). The default rounding mode is `%z`. If
you need a different rounding mode, you'd do something like `=/ rh-n ~(. rh
%n)` and then call the arms of your modified version instead.
#### Source
@ -6362,7 +6373,8 @@ down (`%d`), and round to zero (`%z`).
Initialize `ff`
Instantiates the core `ff`, giving values to its samples based on the
configuration of the `rh` core.
configuration of the `rh` core. **This arm is used internally by `++rh`, you
would not normally call this directly.**
#### Source