Skip to content

Commit 0c994ee

Browse files
gunjjoshikgryte
gunjjoshi
and
kgryte
authored
docs: update descriptions and add structured package data
PR-URL: #2914 Ref: #1147 Co-authored-by: Athan Reines <kgryte@gmail.com> Reviewed-by: Athan Reines <kgryte@gmail.com> Signed-off-by: Athan Reines <kgryte@gmail.com>
1 parent 08f39b4 commit 0c994ee

File tree

8 files changed

+147
-23
lines changed

8 files changed

+147
-23
lines changed

‎lib/node_modules/@stdlib/math/base/special/gcd/docs/repl.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@
1010
Parameters
1111
----------
1212
a: integer
13-
First integer.
13+
First number.
1414

1515
b: integer
16-
Second integer.
16+
Second number.
1717

1818
Returns
1919
-------

‎lib/node_modules/@stdlib/math/base/special/gcd/docs/types/index.d.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@
2626
* - If both `a` and `b` are `0`, the function returns `0`.
2727
* - Both `a` and `b` must have integer values; otherwise, the function returns `NaN`.
2828
*
29-
* @param a - integer
30-
* @param b - integer
29+
* @param a - first number
30+
* @param b - second number
3131
* @returns greatest common divisor
3232
*
3333
* @example

‎lib/node_modules/@stdlib/math/base/special/gcd/lib/binary_gcd.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@
2828
* [@stein:1967]: https://doi.org/10.1016/0021-9991(67)90047-2
2929
*
3030
* @private
31-
* @param {integer} a - integer
32-
* @param {integer} b - integer
31+
* @param {integer} a - first number
32+
* @param {integer} b - second number
3333
* @returns {integer} greatest common divisor
3434
*
3535
* @example

‎lib/node_modules/@stdlib/math/base/special/gcd/lib/bitwise_binary_gcd.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@
2828
* [@stein:1967]: https://doi.org/10.1016/0021-9991(67)90047-2
2929
*
3030
* @private
31-
* @param {integer32} a - integer
32-
* @param {integer32} b - integer
31+
* @param {integer32} a - first number
32+
* @param {integer32} b - second number
3333
* @returns {integer32} greatest common divisor
3434
*
3535
* @example

‎lib/node_modules/@stdlib/math/base/special/gcd/lib/main.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ var largeIntegers = require( './binary_gcd.js' );
3434
/**
3535
* Computes the greatest common divisor (gcd).
3636
*
37-
* @param {integer} a - integer
38-
* @param {integer} b - integer
37+
* @param {integer} a - first number
38+
* @param {integer} b - second number
3939
* @returns {integer} greatest common divisor
4040
*
4141
* @example

‎lib/node_modules/@stdlib/math/base/special/gcd/lib/native.js

+3-3
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ var addon = require( './../src/addon.node' );
2929
* Computes the greatest common divisor (gcd).
3030
*
3131
* @private
32-
* @param {number} a - input value
33-
* @param {number} b - input value
34-
* @returns {number} function value
32+
* @param {number} a - first number
33+
* @param {number} b - second number
34+
* @returns {number} greatest common divisor
3535
*
3636
* @example
3737
* var v = gcd( 0.0, 0.0 );

‎lib/node_modules/@stdlib/math/base/special/gcd/package.json

+125-1
Original file line numberDiff line numberDiff line change
@@ -71,5 +71,129 @@
7171
"gcm",
7272
"arithmetic",
7373
"integer"
74-
]
74+
],
75+
"__stdlib__": {
76+
"scaffold": {
77+
"$schema": "math/base@v1.0",
78+
"base_alias": "gcd",
79+
"alias": "gcd",
80+
"pkg_desc": "compute the greatest common divisor (gcd)",
81+
"desc": "computes the greatest common divisor (gcd)",
82+
"short_desc": "greatest common divisor (gcd)",
83+
"parameters": [
84+
{
85+
"name": "a",
86+
"desc": "first number",
87+
"type": {
88+
"javascript": "integer",
89+
"jsdoc": "integer",
90+
"c": "double",
91+
"dtype": "float64"
92+
},
93+
"domain": [
94+
{
95+
"min": "-infinity",
96+
"max": "infinity"
97+
}
98+
],
99+
"rand": {
100+
"prng": "random/base/discrete-uniform",
101+
"parameters": [
102+
0.0,
103+
50.0
104+
]
105+
},
106+
"example_values": [
107+
1.0,
108+
2.0,
109+
4.0,
110+
5.0,
111+
9.0,
112+
10.0,
113+
15.0,
114+
20.0,
115+
21.0,
116+
25.0,
117+
28.0,
118+
30.0,
119+
33.0,
120+
35.0,
121+
39.0,
122+
40.0,
123+
42.0,
124+
45.0,
125+
48.0,
126+
50.0
127+
]
128+
},
129+
{
130+
"name": "b",
131+
"desc": "second number",
132+
"type": {
133+
"javascript": "integer",
134+
"jsdoc": "integer",
135+
"c": "double",
136+
"dtype": "float64"
137+
},
138+
"domain": [
139+
{
140+
"min": "-infinity",
141+
"max": "infinity"
142+
}
143+
],
144+
"rand": {
145+
"prng": "random/base/discrete-uniform",
146+
"parameters": [
147+
0.0,
148+
50.0
149+
]
150+
},
151+
"example_values": [
152+
1.0,
153+
2.0,
154+
4.0,
155+
5.0,
156+
9.0,
157+
10.0,
158+
15.0,
159+
20.0,
160+
21.0,
161+
25.0,
162+
28.0,
163+
30.0,
164+
33.0,
165+
35.0,
166+
39.0,
167+
40.0,
168+
42.0,
169+
45.0,
170+
48.0,
171+
50.0
172+
]
173+
}
174+
],
175+
"returns": {
176+
"desc": "greatest common divisor",
177+
"type": {
178+
"javascript": "number",
179+
"jsdoc": "number",
180+
"c": "double",
181+
"dtype": "float64"
182+
}
183+
},
184+
"keywords": [
185+
"binary gcd",
186+
"greatest common divisor",
187+
"greatest common factor",
188+
"highest common factor",
189+
"greatest common measure",
190+
"highest common divisor",
191+
"gcd",
192+
"gcf",
193+
"hcf",
194+
"gcm"
195+
],
196+
"extra_keywords": []
197+
}
198+
}
75199
}

‎lib/node_modules/@stdlib/math/base/special/gcd/src/main.c

+9-9
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,9 @@ static const int64_t STDLIB_CONSTANT_INT64_MAX = 9223372036854775807;
3030
/**
3131
* Computes the greatest common divisor (gcd) using the binary GCD algorithm.
3232
*
33-
* @param a input value
34-
* @param b input value
35-
* @return output value
33+
* @param a first number
34+
* @param b second number
35+
* @return greatest common divisor
3636
*
3737
* @example
3838
* double out = largeIntegers( 1.2676506002282294.0e+30, 9007199254740992.0 );
@@ -86,9 +86,9 @@ static double largeIntegers( const double a, const double b ) {
8686
/**
8787
* Computes the greatest common divisor (gcd) using the binary GCD algorithm and bitwise operations.
8888
*
89-
* @param a input value
90-
* @param b input value
91-
* @return output value
89+
* @param a first number
90+
* @param b second number
91+
* @return greatest common divisor
9292
*
9393
* @example
9494
* double out = bitwise( 48.0, 18.0 );
@@ -142,9 +142,9 @@ static double bitwise( const double a, const double b ) {
142142
/**
143143
* Computes the greatest common divisor (gcd).
144144
*
145-
* @param a input value
146-
* @param b input value
147-
* @return output value
145+
* @param a first number
146+
* @param b second number
147+
* @return greatest common divisor
148148
*
149149
* @example
150150
* double out = stdlib_base_gcd( 48.0, 18.0 );

0 commit comments

Comments
 (0)