Skip to content
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
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
204 changes: 204 additions & 0 deletions lib/node_modules/@stdlib/math/base/special/sincosd/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,204 @@
<!--

@license Apache-2.0

Copyright (c) 2025 The Stdlib Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

-->

# sincosd

> Simultaneously compute the [sine][@stdlib/math/base/special/sind] and [cosine][@stdlib/math/base/special/cosd] an angle measured in degrees.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
> Simultaneously compute the [sine][@stdlib/math/base/special/sind] and [cosine][@stdlib/math/base/special/cosd] an angle measured in degrees.
> Simultaneously compute the [sine][@stdlib/math/base/special/sind] and [cosine][@stdlib/math/base/special/cosd] of an angle measured in degrees.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh sorry, that's my fault. I will change it in all the files.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!


<section class="usage">

## Usage

```javascript
var sincosd = require( '@stdlib/math/base/special/sincosd' );
```

#### sincosd( x )

Simultaneously computes the [sine][@stdlib/math/base/special/sind] and [cosine][@stdlib/math/base/special/cosd] of a `number` (in degrees).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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


```javascript
var v = sincosd( 0.0 );
// returns [ ~0.0, ~1.0 ]

v = sincosd( 90.0 );
// returns [ ~1.0, ~0.0 ]

v = sincosd( -30.0 );
// returns [ ~-0.5, ~0.866 ]
```

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

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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.
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.


```javascript
var Float64Array = require( '@stdlib/array/float64' );

var out = new Float64Array( 2 );

var v = sincosd.assign( 0.0, out, 1, 0 );
// returns <Float64Array>[ ~0.0, ~1.0 ]

var bool = ( v === out );
// returns true
```

</section>

<!-- /.usage -->

<section class="examples">

## Examples

<!-- eslint no-undef: "error" -->

```javascript
var linspace = require( '@stdlib/array/base/linspace' );
var sincosd = require( '@stdlib/math/base/special/sincosd' );

var x = linspace( 0.0, 180.0, 100 );

var y;
var i;
for ( i = 0; i < x.length; i++ ) {
y = sincosd( x[ i ] );
console.log( 'sincosd(%d) = [ %d, %d ]', x[ i ], y[ 0 ], y[ 1 ] );
}
```

</section>

<!-- /.examples -->

<!-- C interface documentation. -->

* * *

<section class="c">

## C APIs

<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->

<section class="intro">

</section>

<!-- /.intro -->

<!-- C usage documentation. -->

<section class="usage">

### Usage

```c
#include "stdlib/math/base/special/sincosd.h"
```

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

Simultaneously computes the [sine][@stdlib/math/base/special/sind] and [cosine][@stdlib/math/base/special/cosd] of a `number` (in degrees).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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


```c
double cosine;
double sine;

stdlib_base_sincosd( 4.0, &sine, &cosine );
```

The function accepts the following arguments:

- **x**: `[in] double` input value.
- **sine**: `[out] double*` destination for the sine.
- **cosine**: `[out] double*` destination for the cosine.

```c
void stdlib_base_sincosd( const double x, double *sine, double *cosine );
```

</section>

<!-- /.usage -->

<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="notes">

</section>

<!-- /.notes -->

<!-- C API usage examples. -->

<section class="examples">

### Examples

```c
#include "stdlib/math/base/special/sincosd.h"
#include <stdio.h>

int main( void ) {
const double x[] = { 0.0, 90.0, 180.0, 360.0 };

double cosine;
double sine;
int i;
for ( i = 0; i < 4; i++ ) {
stdlib_base_sincosd( x[ i ], &sine, &cosine );
printf( "x: %lf => sine: %lf, cosine: %lf\n", x[ i ], sine, cosine );
}
}
```

</section>

<!-- /.examples -->

</section>

<!-- /.c -->

<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->

<section class="related">

</section>

<!-- /.related -->

<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="links">

<!-- <related-links> -->

[@stdlib/math/base/special/cosd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/cos

[@stdlib/math/base/special/sind]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/sin

<!-- </related-links> -->

</section>

<!-- /.links -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2025 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

'use strict';

// MODULES //

var bench = require( '@stdlib/bench' );
var uniform = require( '@stdlib/random/array/uniform' );
var isnan = require( '@stdlib/math/base/assert/is-nan' );
var sind = require( '@stdlib/math/base/special/sind' );
var cosd = require( '@stdlib/math/base/special/cosd' );
var pkg = require( './../package.json' ).name;
var sincosd = require( './../lib' );


// MAIN //

bench( pkg, function benchmark( b ) {
var x;
var y;
var i;

x = uniform( 100, -10.0, 10.0 );

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
y = sincosd( x[ i%x.length ] );
if ( isnan( y[0] ) || isnan( y[1] ) ) {
b.fail( 'should not return NaN' );
}
}
b.toc();
if ( isnan( y[0] ) || isnan( y[1] ) ) {
b.fail( 'should not return NaN' );
}
b.pass( 'benchmark finished' );
b.end();
});

bench( pkg+'::separate-evaluation', function benchmark( b ) {
var x;
var y;
var i;

x = uniform( 100, -10.0, 10.0 );
y = [ 0.0, 0.0 ];

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
y = [ sind( x[ i%x.length ] ), cosd( x[ i%x.length ] ) ];
if ( isnan( y[0] ) || isnan( y[1] ) ) {
b.fail( 'should not return NaN' );
}
}
b.toc();
if ( isnan( y[0] ) || isnan( y[1] ) ) {
b.fail( 'should not return NaN' );
}
b.pass( 'benchmark finished' );
b.end();
});

bench( pkg+':assign', function benchmark( b ) {
var x;
var y;
var i;

x = uniform( 100, -10.0, 10.0 );
y = [ 0.0, 0.0 ];

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
sincosd.assign( x[ i%x.length ], y, 1, 0 );
if ( isnan( y[0] ) || isnan( y[1] ) ) {
b.fail( 'should not return NaN' );
}
}
b.toc();
if ( isnan( y[0] ) || isnan( y[1] ) ) {
b.fail( 'should not return NaN' );
}
b.pass( 'benchmark finished' );
b.end();
});

bench( pkg+'::separate-evaluation,in-place', function benchmark( b ) {
var x;
var y;
var i;

x = uniform( 100, -10.0, 10.0 );
y = [ 0.0, 0.0 ];

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
y[0] = sind( x[ i%x.length ] );
y[1] = cosd( x[ i%x.length ] );
if ( isnan( y[0] ) || isnan( y[1] ) ) {
b.fail( 'should not return NaN' );
}
}
b.toc();
if ( isnan( y[0] ) || isnan( y[1] ) ) {
b.fail( 'should not return NaN' );
}
b.pass( 'benchmark finished' );
b.end();
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2025 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

'use strict';

// MODULES //

var resolve = require( 'path' ).resolve;
var bench = require( '@stdlib/bench' );
var uniform = require( '@stdlib/random/array/uniform' );
var isnan = require( '@stdlib/math/base/assert/is-nan' );
var tryRequire = require( '@stdlib/utils/try-require' );
var pkg = require( './../package.json' ).name;


// VARIABLES //

var sincosd = tryRequire( resolve( __dirname, './../lib/native.js' ) );
var opts = {
'skip': ( sincosd instanceof Error )
};


// MAIN //

bench( pkg+'::native', opts, function benchmark( b ) {
var x;
var y;
var i;

x = uniform( 100, -10.0, 10.0 );

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
y = sincosd( x[ i%x.length ] );
if ( isnan( y[ 0 ] ) || isnan( y[ 1 ] ) ) {
b.fail( 'should not return NaN' );
}
}
b.toc();
if ( isnan( y[ 0 ] ) || isnan( y[ 1 ] ) ) {
b.fail( 'should not return NaN' );
}
b.pass( 'benchmark finished' );
b.end();
});
Loading