diff options
author | inoas <mail@inoas.com> | 2022-04-13 02:51:22 +0200 |
---|---|---|
committer | Louis Pilfold <louis@lpil.uk> | 2022-04-16 10:23:34 +0100 |
commit | 4e06f94b78b3a47ed5b9745e7f646ed261fbe98c (patch) | |
tree | a5dcf833f431eae2e60970d5b4e0d3a291b4b55c | |
parent | 3402ff3617bcc12365a20e6f24c5e007656836e6 (diff) | |
download | gleam_stdlib-4e06f94b78b3a47ed5b9745e7f646ed261fbe98c.tar.gz gleam_stdlib-4e06f94b78b3a47ed5b9745e7f646ed261fbe98c.zip |
rename {float,int}.distance() to {float,int}.absolute_difference(), remove {float,int}.random_to()
-rw-r--r-- | src/gleam/float.gleam | 18 | ||||
-rw-r--r-- | src/gleam/int.gleam | 12 | ||||
-rw-r--r-- | test/gleam/float_test.gleam | 18 | ||||
-rw-r--r-- | test/gleam/int_test.gleam | 18 |
4 files changed, 27 insertions, 39 deletions
diff --git a/src/gleam/float.gleam b/src/gleam/float.gleam index 42a7b7b..4ff48b2 100644 --- a/src/gleam/float.gleam +++ b/src/gleam/float.gleam @@ -228,17 +228,17 @@ pub fn absolute_value(float: Float) -> Float { } } -/// Returns the absolute distance of the inputs as a positive Float +/// Returns the absolute difference of the inputs as a positive Float /// /// ## Examples /// -/// > distance(-10.0, 10.0) +/// > absolute_difference(-10.0, 10.0) /// 20.0 /// -/// > distance(0.0, -2.0) +/// > absolute_difference(0.0, -2.0) /// 2.0 /// -pub fn distance(a: Float, b: Float) -> Float { +pub fn absolute_difference(a: Float, b: Float) -> Float { a -. b |> absolute_value() } @@ -371,14 +371,6 @@ pub fn random_between(boundary_a: Float, boundary_b: Float) -> Float { } case min, max { min, _max if min == max -> min - min, max -> random_uniform() *. distance(min, max) +. min + min, max -> random_uniform() *. absolute_difference(min, max) +. min } } - -/// If boundary is `0.0` this will yield `0.0`. -/// If negative, this will yield `-x < 0 ` -/// If positive, this will yield `0 < x ` -/// -pub fn random_to(boundary: Float) -> Float { - random_uniform() *. boundary -} diff --git a/src/gleam/int.gleam b/src/gleam/int.gleam index f23f0f9..1f7957a 100644 --- a/src/gleam/int.gleam +++ b/src/gleam/int.gleam @@ -18,17 +18,17 @@ pub fn absolute_value(num: Int) -> Int { } } -/// Returns the absolute distance of the inputs as a positive Int +/// Returns the absolute difference of the inputs as a positive Int /// /// ## Examples /// -/// > distance(-10, 10) +/// > absolute_difference(-10, 10) /// 20 /// -/// > distance(0.0, -2) +/// > absolute_difference(0.0, -2) /// 2 /// -pub fn distance(a: Int, b: Int) -> Int { +pub fn absolute_difference(a: Int, b: Int) -> Int { a - b |> absolute_value() } @@ -415,7 +415,3 @@ pub fn random_between(min: Int, max: Int) -> Int { |> float.floor() |> float.round() } - -pub fn random_to(max: Int) -> Int { - random_between(0, max) -} diff --git a/test/gleam/float_test.gleam b/test/gleam/float_test.gleam index 0cfd994..126f27d 100644 --- a/test/gleam/float_test.gleam +++ b/test/gleam/float_test.gleam @@ -243,29 +243,29 @@ pub fn absolute_value_test() { |> should.equal(25.2) } -pub fn distance_test() { - float.distance(0.0, 0.0) +pub fn absolute_difference_test() { + float.absolute_difference(0.0, 0.0) |> should.equal(0.0) - float.distance(1.0, 2.0) + float.absolute_difference(1.0, 2.0) |> should.equal(1.0) - float.distance(2.0, 1.0) + float.absolute_difference(2.0, 1.0) |> should.equal(1.0) - float.distance(-1.0, 0.0) + float.absolute_difference(-1.0, 0.0) |> should.equal(1.0) - float.distance(0.0, -1.0) + float.absolute_difference(0.0, -1.0) |> should.equal(1.0) - float.distance(10.0, 20.0) + float.absolute_difference(10.0, 20.0) |> should.equal(10.0) - float.distance(-10.0, -20.0) + float.absolute_difference(-10.0, -20.0) |> should.equal(10.0) - float.distance(-10.0, 10.0) + float.absolute_difference(-10.0, 10.0) |> should.equal(20.0) } diff --git a/test/gleam/int_test.gleam b/test/gleam/int_test.gleam index 7f923d9..79c444b 100644 --- a/test/gleam/int_test.gleam +++ b/test/gleam/int_test.gleam @@ -15,29 +15,29 @@ pub fn absolute_value_test() { |> should.equal(123) } -pub fn distance_test() { - int.distance(0, 0) +pub fn absolute_difference_test() { + int.absolute_difference(0, 0) |> should.equal(0) - int.distance(1, 2) + int.absolute_difference(1, 2) |> should.equal(1) - int.distance(2, 1) + int.absolute_difference(2, 1) |> should.equal(1) - int.distance(-1, 0) + int.absolute_difference(-1, 0) |> should.equal(1) - int.distance(0, -1) + int.absolute_difference(0, -1) |> should.equal(1) - int.distance(10, 20) + int.absolute_difference(10, 20) |> should.equal(10) - int.distance(-10, -20) + int.absolute_difference(-10, -20) |> should.equal(10) - int.distance(-10, 10) + int.absolute_difference(-10, 10) |> should.equal(20) } |