[doc-core:math] Documentation for core:math package. (partials)
#4961
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…procedure groups
… procedure groups
flysand7
reviewed
Mar 23, 2025
| /* | ||
| Return square root of given input. | ||
|
|
||
| **Only accept floats** |
There was a problem hiding this comment.
I would probably also document the behavior for when the input is an inf, nan, a negative zero and possibly subnormal.
There was a problem hiding this comment.
yeah, that is a good point! I added more examples for the special cases according to Float_Class enum
gingerBill
reviewed
Mar 24, 2025
core/math/math.odin
Outdated
Comment on lines
66
to
75
| x_float : = 4.0 ; sqrt_x_float := math.sqrt(x_float) // using default type of f16 | ||
| x_f16 :f16 = 30.90 ; sqrt_x_f16 := math.sqrt(x_f16) | ||
| x_f16le :f16le = 50.0 ; sqrt_x_f16le := math.sqrt(x_f16le) | ||
| x_f16be :f16be = 100 ; sqrt_x_f16be := math.sqrt(x_f16be) | ||
| x_f32 :f32 = 4.89 ; sqrt_x_f32 := math.sqrt(x_f32) | ||
| x_f32le :f32le = 3.14 ; sqrt_x_f32le := math.sqrt(x_f32le) | ||
| x_f32be :f32be = 2.0 ; sqrt_x_f32be := math.sqrt(x_f32be) | ||
| x_f64 :f64 = 0.0578 ; sqrt_x_f64 := math.sqrt(x_f64) | ||
| x_f64le :f64le = 1000.6 ; sqrt_x_f64le := math.sqrt(x_f64le) | ||
| x_f64be :f64be = 89.98 ; sqrt_x_f64be := math.sqrt(x_f64be) |
There was a problem hiding this comment.
Use the standard style convention here too please.
x_float: f64 = 4.0; sqrt_x_float := math.sqrt(x_float) // using default type of f64
x_f16: f16 = 30.90; sqrt_x_f16 := math.sqrt(x_f16)
x_f16le: f16le = 50.0; sqrt_x_f16le := math.sqrt(x_f16le)
x_f16be: f16be = 100; sqrt_x_f16be := math.sqrt(x_f16be)
x_f32: f32 = 4.89; sqrt_x_f32 := math.sqrt(x_f32)
x_f32le: f32le = 3.14; sqrt_x_f32le := math.sqrt(x_f32le)
x_f32be: f32be = 2.0; sqrt_x_f32be := math.sqrt(x_f32be)
x_f64: f64 = 0.0; sqrt_x_f64 := math.sqrt(x_f64)
x_f64le: f64le = 1000.0; sqrt_x_f64le := math.sqrt(x_f64le)
x_f64be: f64be = 89.98; sqrt_x_f64be := math.sqrt(x_f64be)There was a problem hiding this comment.
Thank you! fixed it and added more examples for special cases according to Float_Class
kelreeeeey
added a commit
to kelreeeeey/sandbox-to-contrib-odin-doc
that referenced
this pull request
Mar 24, 2025
…e conventions according to comment odin-lang/Odin#4961 (comment) and odin-lang/Odin#4961 (comment)
… types. added doc for `RAD_PER_DEG` and `DEG_PER_RAD` constant
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Documented: (all of this will be gradually updated)
math.Float_Classenummath.sqrtproc groupmath.sinproc groupmath.cosproc groupmath.tanproc groupmath.to_radiansproc groupmath.to_degreesproc groupDEG_PER_RADconstantRAD_PER_DEGconstantmath.asinproc groupmath.acosproc groupmath.atanproc groupMore detail underlying explanation/issue in #2358 (comment)