Skip to content

docs: update descriptions and add structured package data for math/base/special/gcd #2914

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 17, 2024
Merged

docs: update descriptions and add structured package data for math/base/special/gcd #2914

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
740c4a4
chore: add structured package data for math/base/special/gcd
gunjjoshi Sep 17, 2024
e58224e
Apply suggestions from code review
kgryte Sep 17, 2024
6e3b8ef
docs: update parameter descriptions
gunjjoshi Sep 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
126 changes: 125 additions & 1 deletion lib/node_modules/@stdlib/math/base/special/gcd/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,5 +71,129 @@
"gcm",
"arithmetic",
"integer"
]
],
"__stdlib__": {
"scaffold": {
"$schema": "math/[email protected]",
"base_alias": "gcd",
"alias": "gcd",
"pkg_desc": "compute the greatest common divisor (gcd)",
"desc": "computes greatest common divisor (gcd)",
"short_desc": "greatest common divisor (gcd)",
"parameters": [
{
"name": "a",
"desc": "integer",
"type": {
"javascript": "integer",
"jsdoc": "integer",
"c": "double",
"dtype": "float64"
},
"domain": [
{
"min": "-infinity",
"max": "infinity"
}
],
"rand": {
"prng": "random/base/discrete-uniform",
"parameters": [
0.0,
50.0
]
},
"example_values": [
1.0,
2.0,
4.0,
5.0,
9.0,
10.0,
15.0,
20.0,
21.0,
25.0,
28.0,
30.0,
33.0,
35.0,
39.0,
40.0,
42.0,
45.0,
48.0,
50.0
]
},
{
"name": "b",
"desc": "integer",
"type": {
"javascript": "integer",
"jsdoc": "integer",
"c": "double",
"dtype": "float64"
},
"domain": [
{
"min": "-infinity",
"max": "infinity"
}
],
"rand": {
"prng": "random/base/discrete-uniform",
"parameters": [
0.0,
50.0
]
},
"example_values": [
1.0,
2.0,
4.0,
5.0,
9.0,
10.0,
15.0,
20.0,
21.0,
25.0,
28.0,
30.0,
33.0,
35.0,
39.0,
40.0,
42.0,
45.0,
48.0,
50.0
]
}
],
"returns": {
"desc": "greatest common divisor",
"type": {
"javascript": "number",
"jsdoc": "number",
"c": "double",
"dtype": "float64"
}
},
"keywords": [
"binary gcd",
"greatest common divisor",
"greatest common factor",
"highest common factor",
"greatest common measure",
"highest common divisor",
"gcd",
"gcf",
"hcf",
"gcm"
],
"extra_keywords": []
}
}
}
Loading