diff --git a/src/gleam_community/maths/int.gleam b/src/gleam_community/maths/int.gleam
index 438e04b..05c396e 100644
--- a/src/gleam_community/maths/int.gleam
+++ b/src/gleam_community/maths/int.gleam
@@ -19,8 +19,7 @@
//// .katex { font-size: 1.1em; }
////
////
-//// A module containing several different kinds of mathematical functions
-//// applying to integer numbers.
+//// A module containing mathematical functions applying to integer (int) numbers.
////
//// ---
////
@@ -77,13 +76,13 @@ import gleam_community/maths/float as floatx
///
Example:
///
/// import gleeunit/should
-/// import gleam_stats/math
+/// import gleam_community/maths/int as intx
///
/// pub fn example() {
-/// math.minimum(2.0, 1.5)
+/// intx.minimum(2.0, 1.5)
/// |> should.equal(1.5)
///
-/// math.minimum(1.5, 2.0)
+/// intx.minimum(1.5, 2.0)
/// |> should.equal(1.5)
/// }
///
@@ -113,13 +112,13 @@ pub fn minimum(x: Int, y: Int) -> Int {
///
Example:
///
/// import gleeunit/should
-/// import gleam_stats/math
+/// import gleam_community/maths/int as intx
///
/// pub fn example() {
-/// math.maximum(2.0, 1.5)
+/// intx.maximum(2.0, 1.5)
/// |> should.equal(1.5)
///
-/// math.maximum(1.5, 2.0)
+/// intx.maximum(1.5, 2.0)
/// |> should.equal(1.5)
/// }
///
@@ -149,13 +148,13 @@ pub fn maximum(x: Int, y: Int) -> Int {
///
Example:
///
/// import gleeunit/should
-/// import gleam_stats/math
+/// import gleam_community/maths/int as intx
///
/// pub fn example() {
-/// math.minmax(2.0, 1.5)
+/// intx.minmax(2.0, 1.5)
/// |> should.equal(#(1.5, 2.0))
///
-/// math.minmax(1.5, 2.0)
+/// intx.minmax(1.5, 2.0)
/// |> should.equal(#(1.5, 2.0))
/// }
///
@@ -204,7 +203,7 @@ if erlang {
if javascript {
external fn do_sign(Int) -> Int =
- "../math.mjs" "sign"
+ "../intx.mjs" "sign"
}
///
@@ -224,6 +223,31 @@ pub fn flip_sign(x: Int) -> Int {
-1 * x
}
+///
+///
+/// The function takes two arguments $$x$$ and $$y$$ and returns $$x$$ such that it has the same sign as $$y$$.
+///
+///
+///
+pub fn copy_sign(x: Int, y: Int) -> Int {
+ case sign(x) == sign(y) {
+ // x and y have the same sign, just return x
+ True -> x
+ // x and y have different signs:
+ // - x is positive and y is negative, then flip sign of x
+ // - x is negative and y is positive, then flip sign of x
+ False -> flip_sign(x)
+ }
+}
+
///
///
/// Spot a typo? Open an issue!
@@ -243,22 +267,22 @@ pub fn flip_sign(x: Int) -> Int {
/// Example:
///
/// import gleeunit/should
-/// import gleam_stats/math
+/// import gleam_community/maths/int as intx
///
/// pub fn example() {
/// // Invalid input gives an error
/// // Error on: n = -1 < 0
-/// math.combination(-1, 1)
+/// intx.combination(-1, 1)
/// |> should.be_error()
///
/// // Valid input returns a result
-/// math.combination(4, 0)
+/// intx.combination(4, 0)
/// |> should.equal(Ok(1))
///
-/// math.combination(4, 4)
+/// intx.combination(4, 4)
/// |> should.equal(Ok(1))
///
-/// math.combination(4, 2)
+/// intx.combination(4, 2)
/// |> should.equal(Ok(6))
/// }
///
@@ -314,23 +338,23 @@ pub fn combination(n: Int, k: Int) -> Result(Int, String) {
/// Example:
///
/// import gleeunit/should
-/// import gleam_stats/math
+/// import gleam_community/maths/int as intx
///
/// pub fn example() {
/// // Invalid input gives an error
-/// math.factorial(-1)
+/// intx.factorial(-1)
/// |> should.be_error()
///
/// // Valid input returns a result
-/// math.factorial(0)
+/// intx.factorial(0)
/// |> should.equal(Ok(1))
-/// math.factorial(1)
+/// intx.factorial(1)
/// |> should.equal(Ok(1))
-/// math.factorial(2)
+/// intx.factorial(2)
/// |> should.equal(Ok(2))
-/// math.factorial(3)
+/// intx.factorial(3)
/// |> should.equal(Ok(6))
-/// math.factorial(4)
+/// intx.factorial(4)
/// |> should.equal(Ok(24))
/// }
///
@@ -379,22 +403,22 @@ pub fn factorial(n) -> Result(Int, String) {
/// Example:
///
/// import gleeunit/should
-/// import gleam_stats/math
+/// import gleam_community/maths/int as intx
///
/// pub fn example() {
/// // Invalid input gives an error
/// // Error on: n = -1 < 0
-/// math.permutation(-1, 1)
+/// intx.permutation(-1, 1)
/// |> should.be_error()
///
/// // Valid input returns a result
-/// math.permutation(4, 0)
+/// intx.permutation(4, 0)
/// |> should.equal(Ok(1))
///
-/// math.permutation(4, 4)
+/// intx.permutation(4, 4)
/// |> should.equal(Ok(1))
///
-/// math.permutation(4, 2)
+/// intx.permutation(4, 2)
/// |> should.equal(Ok(12))
/// }
///
@@ -450,13 +474,13 @@ pub fn permutation(n: Int, k: Int) -> Result(Int, String) {
/// Example:
///
/// import gleeunit/should
-/// import gleam_stats/math
+/// import gleam_community/maths/int as intx
///
/// pub fn example() {
-/// math.absolute_difference(-10.0, 10.0)
+/// intx.absolute_difference(-10.0, 10.0)
/// |> should.equal(20.0)
///
-/// math.absolute_difference(0.0, -2.0)
+/// intx.absolute_difference(0.0, -2.0)
/// |> should.equal(2.0)
/// }
///
@@ -482,7 +506,7 @@ pub fn absolute_difference(a: Int, b: Int) -> Int {
/// Example:
///
/// import gleeunit/should
-/// import gleam_stats/math
+/// import gleam_community/maths/int as intx
///
/// pub fn example() {
///
@@ -498,7 +522,7 @@ pub fn absolute_difference(a: Int, b: Int) -> Int {
pub fn is_power(x: Int, y: Int) -> Bool {
assert Ok(value) =
floatx.logarithm(int.to_float(x), option.Some(int.to_float(y)))
- assert Ok(truncated) = floatx.truncate(value, 0)
+ assert Ok(truncated) = floatx.truncate(value, option.Some(0))
let rem = value -. truncated
rem == 0.0
}
diff --git a/src/gleam_community/maths/int_list.gleam b/src/gleam_community/maths/int_list.gleam
index 0b928d0..1033f52 100644
--- a/src/gleam_community/maths/int_list.gleam
+++ b/src/gleam_community/maths/int_list.gleam
@@ -26,11 +26,18 @@
////
//// ---
////
-//// * **Miscellaneous functions**
-//// * [`amax`](#amax)
-//// * [`amin`](#amin)
-//// * [`argmax`](#argmax)
-//// * [`argmin`](#argmin)
+//// * **Distances, sums and products**
+//// * [`sum`](#sum)
+//// * [`product`](#product)
+//// * [`norm`](#norm)
+//// * [`cumulative_sum`](#cumulative_sum)
+//// * [`cumulative_product`](#cumulative_product)
+//// * **Misc. mathematical functions**
+//// * [`maximum`](#maximum)
+//// * [`minimum`](#minimum)
+//// * [`extrema`](#extrema)
+//// * [`arg_maximum`](#arg_maximum)
+//// * [`arg_minimum`](#arg_minimum)
import gleam/list
import gleam/int
@@ -50,17 +57,17 @@ import gleam_community/maths/int as intx
/// Example:
///
/// import gleeunit/should
-/// import gleam_stats/stats
+/// import gleam_community/maths/int_list
///
/// pub fn example () {
/// // An empty lists returns an error
/// []
-/// |> stats.argmin()
+/// |> int_list.arg_minimum()
/// |> should.be_error()
///
/// // Valid input returns a result
-/// [4., 4., 3., 2., 1.]
-/// |> stats.argmin()
+/// [4, 4, 3, 2, 1]
+/// |> stats.arg_minimum()
/// |> should.equal(Ok([4]))
/// }
///
@@ -71,7 +78,7 @@ import gleam_community/maths/int as intx
///
///
///
-pub fn argmin(arr: List(Float)) -> Result(List(Int), String) {
+pub fn arg_minimum(arr: List(Int)) -> Result(List(Int), String) {
case arr {
[] ->
"Invalid input argument: The list is empty."
@@ -79,11 +86,11 @@ pub fn argmin(arr: List(Float)) -> Result(List(Int), String) {
_ -> {
assert Ok(min) =
arr
- |> amin()
+ |> minimum()
arr
- |> list.index_map(fn(index: Int, a: Float) -> Int {
- case a -. min {
- 0. -> index
+ |> list.index_map(fn(index: Int, a: Int) -> Int {
+ case a - min {
+ 0 -> index
_ -> -1
}
})
@@ -110,17 +117,17 @@ pub fn argmin(arr: List(Float)) -> Result(List(Int), String) {
///
Example:
///
/// import gleeunit/should
-/// import gleam_stats/stats
+/// import gleam_community/maths/int_list
///
/// pub fn example () {
/// // An empty lists returns an error
/// []
-/// |> stats.argmax()
+/// |> int_list.arg_maximum()
/// |> should.be_error()
///
/// // Valid input returns a result
-/// [4., 4., 3., 2., 1.]
-/// |> stats.argmax()
+/// [4, 4, 3, 2, 1]
+/// |> int_list.arg_maximum()
/// |> should.equal(Ok([0, 1]))
/// }
///
@@ -131,7 +138,7 @@ pub fn argmin(arr: List(Float)) -> Result(List(Int), String) {
///
///
///
-pub fn argmax(arr: List(Float)) -> Result(List(Int), String) {
+pub fn arg_maximum(arr: List(Int)) -> Result(List(Int), String) {
case arr {
[] ->
"Invalid input argument: The list is empty."
@@ -139,11 +146,11 @@ pub fn argmax(arr: List(Float)) -> Result(List(Int), String) {
_ -> {
assert Ok(max) =
arr
- |> amax()
+ |> maximum()
arr
- |> list.index_map(fn(index: Int, a: Float) -> Int {
- case a -. max {
- 0. -> index
+ |> list.index_map(fn(index: Int, a: Int) -> Int {
+ case a - max {
+ 0 -> index
_ -> -1
}
})
@@ -170,18 +177,18 @@ pub fn argmax(arr: List(Float)) -> Result(List(Int), String) {
///
Example:
///
/// import gleeunit/should
-/// import gleam_stats/stats
+/// import gleam_community/maths/int_list
///
/// pub fn example () {
/// // An empty lists returns an error
/// []
-/// |> stats.amax()
+/// |> int_list.maximum()
/// |> should.be_error()
///
/// // Valid input returns a result
-/// [4., 4., 3., 2., 1.]
-/// |> stats.amax()
-/// |> should.equal(Ok(4.))
+/// [4, 4, 3, 2, 1]
+/// |> int_list.maximum()
+/// |> should.equal(Ok(4))
/// }
///
///
@@ -191,7 +198,7 @@ pub fn argmax(arr: List(Float)) -> Result(List(Int), String) {
///
///