feat(stdlib): Add `asin`, `acos`, `atan`, `isClose` to Number module #1699

spotandjake · 2023-02-23T00:50:11Z

This pr adds Number.asin, Number.acos and Number.isClose to the Number stdlib. I was just going to add asin and acos but given that the methods being used to calculate asin and acos are approximations I decided to also add isClose to make the testing more concise.

isClose is taken from https://peps.python.org/pep-0485/#proposed-implementation,
The license on it just says its in the public domain I think that means we can use it but I honestly dont know happy to find an alternative approach though if that isnt allowed.

The asin and acos functions are from:
https://git.musl-libc.org/cgit/musl/tree/src/math/asin.c
Just like pow.

This is a draft because isClose is blocked on optional Arguments for a nice api, once that gets merged I will go back and refactor the function to not use Options.

Blocked: #388

Work for: #1017

Note: if you guys are fine with merging in with a worse api based on options I am happy todo that too.

stdlib/number.gr

spotandjake · 2023-02-23T01:21:09Z

Note: refactor any tests that use <> to arround floating points to use isClose after we are unblocked.

stdlib/number.gr

ospencer · 2023-04-08T13:47:44Z

stdlib/number.gr

+ * @param relativeTolerance: The relative tolerance to use
+ * @param absoluteTolerance: The absolute tolerance to use


These should probably be more descriptive because it's not clear what they do.

I tried to improve these and got them a bit better but i dont know if they are good enough yet,

https://docs.python.org/3/library/math.html I was looking at python's docs for the description.

spotandjake · 2023-06-14T14:01:36Z

I think this might also close: #303 if we are deciding to with oscar's approach anyway.

spotandjake · 2023-08-31T16:12:02Z

This is blocked by #1776

spotandjake · 2024-01-26T17:29:38Z

This has been unblocked and the docs have been regenerated

ospencer

I love the new descriptions! I think they make a lot of sense now. Just one tiny change and this looks good from me.

stdlib/number.gr

ospencer

Stamp of approval from me! I'll let the stdlib expert @phated take a look and hit the merge button if he's happy with the docs.

phated · 2024-01-27T00:47:53Z

@spotandjake I only see a copyright notice, but not a license. What's the license on the code you referred to?

spotandjake · 2024-01-27T00:53:14Z

@spotandjake I only see a copyright notice, but not a license. What's the license on the code you referred to?

From my understanding as it's in the Public domain it doesn't need a license to be used. It seems to be unlicensed though.

I'm happy to use a different implementation if we need to though.

phated

Comment about docs. I still need to double check the musl libc license

phated · 2024-01-27T22:18:40Z

stdlib/number.gr

+ * Computes the inverse tangent of the given angle
+ *
+ * @param angle: A number between -1 and 1, representing the angle's tangent value.
+ * @returns The inverse tangent (angle in radians between `-pi/2` and `pi/2`) of x. If x is less than `-1` or greater than `1`, returns NaN


This is for all the returns in the file.

What is "x"? We usually say something like "of the given angle."

Also, the "if x is less" sentence needs to be something like "The result will be NaN if the given angle is not between -1 and 1." Or something similar

I made that change

phated

More docs changes

phated · 2024-01-31T04:49:38Z

stdlib/number.gr

+ * @param b: The second value
+ * @param relativeTolerance: The maximum tolerance to use relative to the larger absolute value `a` or `b`
+ * @param absoluteTolerance: The absolute tolerance to use, regardless of the values of `a` or `b`
+ *


Suggested change

*

phated · 2024-01-31T04:50:37Z

stdlib/number.gr

+  p / q
+}
+/**
+ * Computes the inverse sine of the given angle


Suggested change

* Computes the inverse sine of the given angle

* Computes the inverse sine of the given angle.

Period on top level descriptions, no period on arg descriptions

phated · 2024-01-31T04:51:13Z

stdlib/number.gr

+/**
+ * Computes the inverse sine of the given angle
+ *
+ * @param angle: A number between -1 and 1, representing the angle's sine value.


Suggested change

* @param angle: A number between -1 and 1, representing the angle's sine value.

* @param angle: A number between -1 and 1, representing the angle's sine value

phated · 2024-01-31T04:52:34Z

stdlib/number.gr

+ * Computes the inverse sine of the given angle
+ *
+ * @param angle: A number between -1 and 1, representing the angle's sine value.
+ * @returns The inverse sine (angle in radians between `-pi/2` and `pi/2`) of the given `angle`. The result will be `NaN` if the given `angle` is less than `-1` or greater than `1`


Suggested change

* @returns The inverse sine (angle in radians between `-pi/2` and `pi/2`) of the given `angle`. The result will be `NaN` if the given `angle` is less than `-1` or greater than `1`

* @returns The inverse sine (angle in radians between `-pi/2` and `pi/2`) of the given `angle` or `NaN` if the given `angle` is not between `-1` and `1`

How about this?

phated · 2024-01-31T04:53:05Z

stdlib/number.gr

+}
+
+/**
+ * Computes the inverse cosine of the given angle


Suggested change

* Computes the inverse cosine of the given angle

* Computes the inverse cosine of the given angle.

phated · 2024-01-31T04:53:55Z

stdlib/number.gr

+/**
+ * Computes the inverse cosine of the given angle
+ *
+ * @param angle: A number between -1 and 1, representing the angle's cosine value.


Suggested change

* @param angle: A number between -1 and 1, representing the angle's cosine value.

* @param angle: A number between -1 and 1, representing the angle's cosine value

phated · 2024-01-31T04:54:28Z

stdlib/number.gr

+ * Computes the inverse cosine of the given angle
+ *
+ * @param angle: A number between -1 and 1, representing the angle's cosine value.
+ * @returnsThe inverse cosine (angle in radians between `-pi/2` and `pi/2`) of the given `angle`. The result will be `NaN` if the given `angle` is less than `-1` or greater than `1`


Suggested change

* @returnsThe inverse cosine (angle in radians between `-pi/2` and `pi/2`) of the given `angle`. The result will be `NaN` if the given `angle` is less than `-1` or greater than `1`

* @returns The inverse cosine (angle in radians between `-pi/2` and `pi/2`) of the given `angle` or `NaN` if the given `angle` is not between `-1` and `1`

phated · 2024-01-31T04:54:58Z

stdlib/number.gr

+}
+
+/**
+ * Computes the inverse tangent of the given angle


Suggested change

* Computes the inverse tangent of the given angle

* Computes the inverse tangent of the given angle.

phated · 2024-01-31T04:55:05Z

stdlib/number.gr

+/**
+ * Computes the inverse tangent of the given angle
+ *
+ * @param angle: A number between -1 and 1, representing the angle's tangent value.


Suggested change

* @param angle: A number between -1 and 1, representing the angle's tangent value.

* @param angle: A number between -1 and 1, representing the angle's tangent value

phated · 2024-01-31T04:55:33Z

stdlib/number.gr

+ * Computes the inverse tangent of the given angle
+ *
+ * @param angle: A number between -1 and 1, representing the angle's tangent value.
+ * @returns The inverse tangent (angle in radians between `-pi/2` and `pi/2`) of the given `angle`. The result will be `NaN` if the given `angle` is less than `-1` or greater than `1`


Suggested change

* @returns The inverse tangent (angle in radians between `-pi/2` and `pi/2`) of the given `angle`. The result will be `NaN` if the given `angle` is less than `-1` or greater than `1`

* @returns The inverse tangent (angle in radians between `-pi/2` and `pi/2`) of the given `angle` or `NaN` if the given `angle` is not between `-1` and `1`

spotandjake · 2024-01-31T19:58:51Z

Made those changes

ospencer reviewed Feb 23, 2023

View reviewed changes

stdlib/number.gr Outdated Show resolved Hide resolved

spotandjake force-pushed the spotandjake-trig-funcs-isClose branch 2 times, most recently from afa10b4 to 251e4ed Compare February 28, 2023 23:50

spotandjake changed the title ~~feat: Add asin, acos, isClose to Number stdlib~~ feat: Add asin, acos, atan, isClose to Number stdlib Mar 1, 2023

spotandjake added stdlib blocked labels Mar 1, 2023

spotandjake self-assigned this Mar 1, 2023

spotandjake force-pushed the spotandjake-trig-funcs-isClose branch from 251e4ed to ea44db1 Compare March 15, 2023 19:51

spotandjake marked this pull request as ready for review March 15, 2023 20:02

spotandjake requested review from phated, peblair, marcusroberts and jozanza as code owners March 15, 2023 20:02

spotandjake requested a review from ospencer March 15, 2023 20:02

spotandjake removed the blocked label Mar 15, 2023

spotandjake changed the title ~~feat: Add asin, acos, atan, isClose to Number stdlib~~ feat(stdlib): Add asin, acos, atan, isClose to Number stdlib Mar 18, 2023

ospencer reviewed Mar 28, 2023

View reviewed changes

stdlib/number.gr Outdated Show resolved Hide resolved

stdlib/number.gr Outdated Show resolved Hide resolved

stdlib/number.gr Outdated Show resolved Hide resolved

stdlib/number.gr Outdated Show resolved Hide resolved

spotandjake force-pushed the spotandjake-trig-funcs-isClose branch from b69cdcc to b0a21f2 Compare March 28, 2023 13:24

spotandjake requested a review from ospencer March 28, 2023 13:24

ospencer reviewed Apr 8, 2023

View reviewed changes

spotandjake requested a review from ospencer June 12, 2023 16:41

spotandjake added the blocked label Aug 31, 2023

spotandjake force-pushed the spotandjake-trig-funcs-isClose branch 2 times, most recently from 12872af to 323e276 Compare December 29, 2023 20:36

spotandjake force-pushed the spotandjake-trig-funcs-isClose branch from 323e276 to 791c663 Compare January 26, 2024 17:29

spotandjake removed the blocked label Jan 26, 2024

ospencer reviewed Jan 26, 2024

View reviewed changes

stdlib/number.gr Outdated Show resolved Hide resolved

ospencer approved these changes Jan 26, 2024

View reviewed changes

phated requested changes Jan 27, 2024

View reviewed changes

spotandjake added 13 commits January 29, 2024 12:18

feat: Add asin, acos, isClose

f94d1c9

chore: Add test for -Infinity

b2f8892

feat: Add atan

9395de3

chore: Update For Optional Arguments

29625fc

chore: Apply suggestions from code review

40f0a48

chore: Run Formatter

78893af

chore: Format Tests

8308082

chore: Try to make isClose descrption better

82306c3

feat: Rebase on main

d6510ac

chore: regen grain doc

98a0f6a

chore: Regen docs

2a63a8d

chore: Fix spelling mistake in documentation

09dfac4

chore: Apply suggestion from code review

30a5d04

spotandjake force-pushed the spotandjake-trig-funcs-isClose branch from 7ba639c to 30a5d04 Compare January 29, 2024 17:27

phated requested changes Jan 31, 2024

View reviewed changes

chore: Apply suggestions from code review

ae25222

phated approved these changes Feb 1, 2024

View reviewed changes

phated changed the title ~~feat(stdlib): Add asin, acos, atan, isClose to Number stdlib~~ feat(stdlib): Add asin, acos, atan, isClose to Number module Feb 1, 2024

phated added this pull request to the merge queue Feb 1, 2024

Merged via the queue into grain-lang:main with commit 353b544 Feb 1, 2024
12 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(stdlib): Add `asin`, `acos`, `atan`, `isClose` to Number module #1699

feat(stdlib): Add `asin`, `acos`, `atan`, `isClose` to Number module #1699

spotandjake commented Feb 23, 2023 •

edited

Loading

spotandjake commented Feb 23, 2023

ospencer Apr 8, 2023

spotandjake Apr 16, 2023

spotandjake commented Jun 14, 2023

spotandjake commented Aug 31, 2023

spotandjake commented Jan 26, 2024

ospencer left a comment

ospencer left a comment

phated commented Jan 27, 2024

spotandjake commented Jan 27, 2024

phated left a comment

phated Jan 27, 2024

spotandjake Jan 29, 2024

phated left a comment

phated Jan 31, 2024

phated Jan 31, 2024

phated Jan 31, 2024

phated Jan 31, 2024

spotandjake Jan 31, 2024

phated Jan 31, 2024

phated Jan 31, 2024

phated Jan 31, 2024

phated Jan 31, 2024

phated Jan 31, 2024

phated Jan 31, 2024

spotandjake commented Jan 31, 2024

		* @param relativeTolerance: The relative tolerance to use
		* @param absoluteTolerance: The absolute tolerance to use

	* Computes the inverse sine of the given angle
	* Computes the inverse sine of the given angle.

	* @param angle: A number between -1 and 1, representing the angle's sine value.
	* @param angle: A number between -1 and 1, representing the angle's sine value

	* @returns The inverse sine (angle in radians between `-pi/2` and `pi/2`) of the given `angle`. The result will be `NaN` if the given `angle` is less than `-1` or greater than `1`
	* @returns The inverse sine (angle in radians between `-pi/2` and `pi/2`) of the given `angle` or `NaN` if the given `angle` is not between `-1` and `1`

	* Computes the inverse cosine of the given angle
	* Computes the inverse cosine of the given angle.

	* @returnsThe inverse cosine (angle in radians between `-pi/2` and `pi/2`) of the given `angle`. The result will be `NaN` if the given `angle` is less than `-1` or greater than `1`
	* @returns The inverse cosine (angle in radians between `-pi/2` and `pi/2`) of the given `angle` or `NaN` if the given `angle` is not between `-1` and `1`

	* Computes the inverse tangent of the given angle
	* Computes the inverse tangent of the given angle.

	* @returns The inverse tangent (angle in radians between `-pi/2` and `pi/2`) of the given `angle`. The result will be `NaN` if the given `angle` is less than `-1` or greater than `1`
	* @returns The inverse tangent (angle in radians between `-pi/2` and `pi/2`) of the given `angle` or `NaN` if the given `angle` is not between `-1` and `1`

feat(stdlib): Add asin, acos, atan, isClose to Number module #1699

feat(stdlib): Add asin, acos, atan, isClose to Number module #1699

Conversation

spotandjake commented Feb 23, 2023 • edited Loading

spotandjake commented Feb 23, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

spotandjake commented Jun 14, 2023

spotandjake commented Aug 31, 2023

spotandjake commented Jan 26, 2024

ospencer left a comment

Choose a reason for hiding this comment

ospencer left a comment

Choose a reason for hiding this comment

phated commented Jan 27, 2024

spotandjake commented Jan 27, 2024

phated left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

phated left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

spotandjake commented Jan 31, 2024

feat(stdlib): Add `asin`, `acos`, `atan`, `isClose` to Number module #1699

feat(stdlib): Add `asin`, `acos`, `atan`, `isClose` to Number module #1699

spotandjake commented Feb 23, 2023 •

edited

Loading