Skip to content
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

Added documentation to all the affected functions of Issue #1073

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Added documentation to all the affected functions of Issue #1073

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ac7f187
Added documentation to all the affected functions of Issue https://gi…
CSDUMMI Dec 16, 2019
b53eaf3
Consistent attention seeking.
CSDUMMI Dec 16, 2019
55fc7ba
Changed fdiv function, to use Maybe
CSDUMMI Jan 17, 2020
07a9a29
idiv function uses Maybe and returns
CSDUMMI Jan 17, 2020
e6c6609
modby function uses Maybe and returns Nothing if divisor = 0.
CSDUMMI Jan 17, 2020
3b1967a
remainderBy uses Maybe and returns Nothing if divisor = 0.
CSDUMMI Jan 17, 2020
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
59 changes: 47 additions & 12 deletions src/Basics.elm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,10 +199,19 @@ mul =
-1 / 4 == -0.25
-5 / 4 == -1.25

**Be careful:**

4 / 0 == Infinity : Float
3 / 0 == Infinity : Float

This is a bug and Infinity is not a legitimate value
in Elm, thus you can't match for it.
You'll have to check beforehand wheter the divisor is 0
-}
fdiv : Float -> Float -> Float
fdiv =
Elm.Kernel.Basics.fdiv
fdiv : Float -> Float -> Maybe Float
fdiv x divisor = case divisor of
0 -> Nothing
y -> Just <| Elm.Kernel.Basics.fdiv x y


{-| Integer division:
Expand All @@ -221,10 +230,18 @@ similar to `truncate (3 / 4)`.

It may sometimes be useful to pair this with the [`remainderBy`](#remainderBy)
function.

**Be careful:**

4 // 0 == 0

This is a bug and you'll have to check before computing the result,
if your divisor is 0.
-}
idiv : Int -> Int -> Int
idiv =
Elm.Kernel.Basics.idiv
idiv : Int -> Int -> Maybe Int
idiv x divisor = case divisor of
0 -> Nothing
y -> Just <| Elm.Kernel.Basics.idiv x y


{-| Exponentiation
Expand Down Expand Up @@ -535,10 +552,20 @@ or read Daan Leijen’s [Division and Modulus for Computer Scientists][dm] for m
information.

[dm]: https://www.microsoft.com/en-us/research/wp-content/uploads/2016/02/divmodnote-letter.pdf

**Be careful:**

modBy 0 5

results in a crash, a **runtime exception** of the sort:
"Error: Cannot perform mod 0. Division by zero error."
You'll have to check, that the first argument isn't 0.
Needless to say, this is a bug!
-}
modBy : Int -> Int -> Int
modBy =
Elm.Kernel.Basics.modBy
modBy : Int -> Int -> Maybe Int
modBy x divisor = case divisor of
0 -> Nothing
y -> Just <| Elm.Kernel.Basics.modBy x y


{-| Get the remainder after division. Here are bunch of examples of dividing by four:
Expand All @@ -551,10 +578,18 @@ or read Daan Leijen’s [Division and Modulus for Computer Scientists][dm] for m
information.

[dm]: https://www.microsoft.com/en-us/research/wp-content/uploads/2016/02/divmodnote-letter.pdf

**Be careful:**

remainderBy 0 5 == NaN : Int

This is a bug in Elm and `NaN` isn't a legitimate value.
You'll have to check beforehand, that the first argument isn't 0.
-}
remainderBy : Int -> Int -> Int
remainderBy =
Elm.Kernel.Basics.remainderBy
remainderBy : Int -> Int -> Maybe Int
remainderBy x divisor = case divisor of
0 -> Nothing
y -> Just <| Elm.Kernel.Basics.remainderBy x y


{-| Negate a number.
Expand Down