Skip to content

Commit e5ee213

Browse files
anandkaranubcanandkaranubc
committed
chore: apply suggestions from review
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: passed - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 617f170 commit e5ee213

File tree

11 files changed

+34
-32
lines changed

11 files changed

+34
-32
lines changed

‎lib/node_modules/@stdlib/math/base/special/sincosd/README.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ limitations under the License.
2020

2121
# sincosd
2222

23-
> Simultaneously compute the [sine][@stdlib/math/base/special/sind] and [cosine][@stdlib/math/base/special/cosd] an angle measured in degrees.
23+
> Simultaneously compute the [sine][@stdlib/math/base/special/sind] and [cosine][@stdlib/math/base/special/cosd] of an `angle` measured in degrees.
2424
2525
<section class="usage">
2626

@@ -32,7 +32,7 @@ var sincosd = require( '@stdlib/math/base/special/sincosd' );
3232

3333
#### sincosd( x )
3434

35-
Simultaneously computes the [sine][@stdlib/math/base/special/sind] and [cosine][@stdlib/math/base/special/cosd] of a `number` (in degrees).
35+
Simultaneously computes the [sine][@stdlib/math/base/special/sind] and [cosine][@stdlib/math/base/special/cosd] of an `angle` measured in degrees.
3636

3737
```javascript
3838
var v = sincosd( 0.0 );
@@ -47,7 +47,7 @@ v = sincosd( -30.0 );
4747

4848
#### sincosd.assign( x, out, stride, offset )
4949

50-
Simultaneously computes the [sine][@stdlib/math/base/special/sind] and [cosine][@stdlib/math/base/special/cosd] of a `number` (in degrees) and assigns results to a provided output array.
50+
Simultaneously computes the [sine][@stdlib/math/base/special/sind] and [cosine][@stdlib/math/base/special/cosd] of an `angle` measured in degrees and assigns results to a provided output array.
5151

5252
```javascript
5353
var Float64Array = require( '@stdlib/array/float64' );
@@ -117,7 +117,7 @@ for ( i = 0; i < x.length; i++ ) {
117117

118118
#### stdlib_base_sincosd( x, &sine, &cosine )
119119

120-
Simultaneously computes the [sine][@stdlib/math/base/special/sind] and [cosine][@stdlib/math/base/special/cosd] of a `number` (in degrees).
120+
Simultaneously computes the [sine][@stdlib/math/base/special/sind] and [cosine][@stdlib/math/base/special/cosd] of an `angle` measured in degrees.
121121

122122
```c
123123
double cosine;
@@ -191,11 +191,11 @@ int main( void ) {
191191
192192
<section class="links">
193193
194-
<!-- <related-links> -->
194+
[@stdlib/math/base/special/cosd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/cosd
195195
196-
[@stdlib/math/base/special/cosd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/cos
196+
[@stdlib/math/base/special/sind]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/sind
197197
198-
[@stdlib/math/base/special/sind]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/sin
198+
<!-- <related-links> -->
199199
200200
<!-- </related-links> -->
201201

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11

22
{{alias}}( x )
3-
Simultaneously computes the sine and cosine an angle measured in degrees.
3+
Simultaneously computes the sine and cosine of an angle measured in degrees.
44

55
Parameters
66
----------
@@ -24,8 +24,9 @@
2424
[ NaN, NaN ]
2525

2626

27-
{{alias}}( x, out, stride, offset )
28-
Simultaneously computes the sine and cosine of a number and assigns
27+
{{alias}}.assign( x, out, stride, offset )
28+
Simultaneously computes the sine and cosine of
29+
an angle measured in degrees and assigns the
2930
results to a provided output array.
3031

3132
Parameters

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ import { Collection } from '@stdlib/types/array';
2424

2525
interface sincosd {
2626
/**
27-
* Simultaneously computes the sine and cosine an angle measured in degrees.
27+
* Simultaneously computes the sine and cosine of an angle measured in degrees.
2828
*
2929
* @param x - input value (in degrees)
3030
* @returns sine and cosine
@@ -48,7 +48,7 @@ interface sincosd {
4848
( x: number ): Array<number>;
4949

5050
/**
51-
* Simultaneously computes the sine and cosine an angle measured in degrees.
51+
* Simultaneously computes the sine and cosine of an angle measured in degrees and assigns the results to a provided output array.
5252
*
5353
* @param x - input value (in degrees)
5454
* @param out - output array
@@ -71,7 +71,7 @@ interface sincosd {
7171
}
7272

7373
/**
74-
* Simultaneously computes the sine and cosine an angle measured in degrees.
74+
* Simultaneously computes the sine and cosine of an angle measured in degrees.
7575
*
7676
* @param x - input value (in degrees)
7777
* @returns sine and cosine

‎lib/node_modules/@stdlib/math/base/special/sincosd/include/stdlib/math/base/special/sincosd.h‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ extern "C" {
2727
#endif
2828

2929
/**
30-
* Simultaneously computes the sine and cosine an angle measured in degrees.
30+
* Simultaneously computes the sine and cosine of an angle measured in degrees.
3131
*/
3232
void stdlib_base_sincosd( const double x, double *sine, double *cosine );
3333

‎lib/node_modules/@stdlib/math/base/special/sincosd/lib/index.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
'use strict';
2020

2121
/**
22-
* Simultaneously compute the sine and cosine an angle measured in degrees.
22+
* Simultaneously compute the sine and cosine of an angle measured in degrees.
2323
*
2424
* @module @stdlib/math/base/special/sincosd
2525
*
@@ -43,7 +43,7 @@
4343
*
4444
* var out = new Float64Array( 2 );
4545
*
46-
* var v = sincosd( out, 0.0 );
46+
* var v = sincosd.assign( 0.0, out, 1, 0 );
4747
* // return <Float64Array>[ ~0.0, ~1.0 ]
4848
*
4949
* var bool = ( v === out );

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ var assign = require( './assign.js' );
2626
// MAIN //
2727

2828
/**
29-
* Simultaneously computes the sine and cosine an angle measured in degrees.
29+
* Simultaneously computes the sine and cosine of an angle measured in degrees.
3030
*
3131
* @param {number} x - input value (in degrees)
3232
* @returns {Array<number>} sine and cosine

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ var addon = require( './../src/addon.node' );
2727
// MAIN //
2828

2929
/**
30-
* Simultaneously computes the sine and cosine an angle measured in degrees.
30+
* Simultaneously computes the sine and cosine of an angle measured in degrees.
3131
*
3232
* @private
3333
* @param {number} x - input value (in degrees)

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@stdlib/math/base/special/sincosd",
33
"version": "0.0.0",
4-
"description": "Simultaneously compute the sine and cosine an angle measured in degrees.",
4+
"description": "Simultaneously compute the sine and cosine of an angle measured in degrees.",
55
"license": "Apache-2.0 AND BSL-1.0",
66
"author": {
77
"name": "The Stdlib Authors",

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
#include "stdlib/math/base/special/cosd.h"
2222

2323
/**
24-
* Simultaneously computes the sine and cosine an angle measured in degrees.
24+
* Simultaneously computes the sine and cosine of an angle measured in degrees.
2525
*
2626
* @param x input value (in degrees)
2727
* @param sine destination to store the sine
@@ -37,4 +37,5 @@
3737
void stdlib_base_sincosd( const double x, double* sine, double* cosine ) {
3838
*sine = stdlib_base_sind( x );
3939
*cosine = stdlib_base_cosd( x );
40+
return;
4041
}

‎lib/node_modules/@stdlib/math/base/special/sincosd/test/test.assign.js‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -307,8 +307,8 @@ tape( 'the function returns `NaN` if provided a `NaN`', function test( t ) {
307307
z = [ 0.0, 0.0 ];
308308
v = sincosd( NaN, z, 1, 0 );
309309
t.equal( v, z, 'returns output array' );
310-
t.equal( isnan( v[0] ), true, 'returns NaN' );
311-
t.equal( isnan( v[1] ), true, 'returns NaN' );
310+
t.equal( isnan( v[0] ), true, 'returns expected value' );
311+
t.equal( isnan( v[1] ), true, 'returns expected value' );
312312
t.end();
313313
});
314314

@@ -319,8 +319,8 @@ tape( 'the function returns `NaN` if provided `+infinity`', function test( t ) {
319319
z = [ 0.0, 0.0 ];
320320
v = sincosd( PINF, z, 1, 0 );
321321
t.equal( v, z, 'returns output array' );
322-
t.equal( isnan( v[0] ), true, 'returns NaN' );
323-
t.equal( isnan( v[1] ), true, 'returns NaN' );
322+
t.equal( isnan( v[0] ), true, 'returns expected value' );
323+
t.equal( isnan( v[1] ), true, 'returns expected value' );
324324
t.end();
325325
});
326326

@@ -331,8 +331,8 @@ tape( 'the function returns `NaN` if provided `-infinity`', function test( t ) {
331331
z = [ 0.0, 0.0 ];
332332
v = sincosd( NINF, z, 1, 0 );
333333
t.equal( v, z, 'returns output array' );
334-
t.equal( isnan( v[0] ), true, 'returns NaN' );
335-
t.equal( isnan( v[1] ), true, 'returns NaN' );
334+
t.equal( isnan( v[0] ), true, 'returns expected value' );
335+
t.equal( isnan( v[1] ), true, 'returns expected value' );
336336
t.end();
337337
});
338338

0 commit comments

Comments
 (0)