Skip to content

docs: clarify Float.toInt truncates toward zero, not rounds #747

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mitnick2012 wants to merge 1 commit into
base: master
Choose a base branch
from
+5 −1
Open

docs: clarify Float.toInt truncates toward zero, not rounds #747

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion src/Float.mo
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -471,14 +471,18 @@ module {
/// ```
public let fromInt64 : Int64 -> Float = Prim.int64ToFloat;

/// Conversion to `Int`.
/// Conversion to `Int` by truncating the decimal places of the float,
/// equivalent to `Float.toInt(Float.trunc(f))`.
/// Truncation rounds toward zero: the fractional part is dropped regardless of sign.
///
/// Traps for `inf`, `-inf`, and `NaN`.
///
/// Example:
/// ```motoko
/// import Float "mo:base/Float";
///
/// Float.toInt(1.9) // => +1 (truncates, does not round up)
/// Float.toInt(-1.9) // => -1 (truncates toward zero, not toward -inf)
/// Float.toInt(1.2e6) // => +1_200_000
/// ```
public let toInt : Float -> Int = Prim.floatToInt;
Expand Down