Add ieee_float.square_root()

richard-viney · Jun 16, 2024 · 3e3beea · 3e3beea
1 parent 1aca621
commit 3e3beea
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 0 deletions.
diff --git a/src/ieee_float.gleam b/src/ieee_float.gleam
@@ -549,6 +549,13 @@ pub fn round(f: IEEEFloat) -> Result(Int, Nil) {
   }
 }
 
+/// Returns the square root of an `IEEEFloat`.
+///
+@external(javascript, "./ieee_float_js.mjs", "square_root")
+pub fn square_root(f: IEEEFloat) -> IEEEFloat {
+  power(f, Finite(0.5))
+}
+
 /// Subtracts one `IEEEFloat` from another.
 ///
 @external(javascript, "./ieee_float_js.mjs", "subtract")

diff --git a/src/ieee_float_js.mjs b/src/ieee_float_js.mjs
@@ -206,4 +206,8 @@ export function subtract(a, b) {
   return a - b;
 }
 
+export function square_root(f) {
+  return Math.sqrt(f)
+}
+
 export function rescue_bad_arith() {}
diff --git a/test/ieee_float_test.gleam b/test/ieee_float_test.gleam
@@ -493,6 +493,18 @@ pub fn round_test() {
   })
 }
 
+pub fn square_root_test() {
+  let test_square_root = build_test_function1(ieee_float.square_root)
+
+  test_square_root(finite(0.0), finite(0.0))
+  test_square_root(finite(1.0), finite(1.0))
+  test_square_root(finite(16.0), finite(4.0))
+  test_square_root(finite(-1.0), nan())
+  test_square_root(positive_infinity(), positive_infinity())
+  test_square_root(negative_infinity(), positive_infinity())
+  test_square_root(nan(), nan())
+}
+
 pub fn subtract_test() {
   let test_subtract = build_test_function2(ieee_float.subtract)