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

> Simultaneously compute the [sine][@stdlib/math/base/special/sin] and [cosine][@stdlib/math/base/special/cos] of a number.


<section class="usage">

## Usage

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

#### sincos( \[out,\] x )

Simultaneously computes the [sine][@stdlib/math/base/special/sin] and [cosine][@stdlib/math/base/special/cos] of a `number` (in radians).

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

v = sincos( Math.PI/2.0 );
// returns [ ~0.0, ~1.0 ]

v = sincos( -Math.PI/6.0 );
// returns [ ~-0.5, ~0.866 ]
```

By default, the function returns the sine and cosine as a two-element `array`. To avoid extra memory allocation, the function supports providing an output (destination) object.

``` javascript
var out = new Float64Array( 2 );

var v = sincos( out, 0.0 );
// return <Float64Array>[ ~0.0, ~1.0 ]

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


</section>

<!-- /.usage -->


<section class="examples">

## Examples

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

var x = linspace( 0.0, 2.0*Math.PI, 100 );
var i;

for ( i = 0; i < x.length; i++ ) {
console.log( sincos( x[ i ] ) );
}
```

</section>

<!-- /.examples -->


<section class="links">

[@stdlib/math/base/special/sin]: https://github.com/stdlib-js/stdlib
[@stdlib/math/base/special/cos]: https://github.com/stdlib-js/stdlib

</section>

<!-- /.links -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,146 @@
'use strict';

// MODULES //

var bench = require( '@stdlib/bench' );
var randu = require( '@stdlib/math/base/random/randu' );
var isnan = require( '@stdlib/math/base/assert/is-nan' );
var sin = require( '@stdlib/math/base/special/sin' );
var cos = require( '@stdlib/math/base/special/cos' );
var pkg = require( './../package.json' ).name;
var sincos = require( './../lib' );


// MAIN //

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

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
x = ( randu()*20.0 ) - 10.0;
y = sincos( x );
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;

y = [ 0.0, 0.0 ];
b.tic();
for ( i = 0; i < b.iterations; i++ ) {
x = ( randu()*20.0 ) - 10.0;
y = [ sin( x ), cos( x ) ];
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+'::in-place', function benchmark( b ) {
var x;
var y;
var i;

y = [ 0.0, 0.0 ];
b.tic();
for ( i = 0; i < b.iterations; i++ ) {
x = ( randu()*20.0 ) - 10.0;
sincos( y, x );
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;

y = [ 0.0, 0.0 ];
b.tic();
for ( i = 0; i < b.iterations; i++ ) {
x = ( randu()*20.0 ) - 10.0;
y[0] = sin( x );
y[1] = cos( x );
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+'::built-in', function benchmark( b ) {
var x;
var y;
var i;

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
x = ( randu()*20.0 ) - 10.0;
y = [ Math.sin( x ), Math.cos( x ) ];
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+'::built-in,in-place', function benchmark( b ) {
var x;
var y;
var i;

y = [ 0.0, 0.0 ];
b.tic();
for ( i = 0; i < b.iterations; i++ ) {
x = ( randu()*20.0 ) - 10.0;
y[0] = Math.sin( x );
y[1] = Math.cos( x );
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,89 @@

# VARIABLES #

ifndef VERBOSE
QUIET := @
endif

# Determine the OS:
#
# [1]: https://en.wikipedia.org/wiki/Uname#Examples
# [2]: http://stackoverflow.com/a/27776822/2225624
OS ?= $(shell uname)
ifneq (, $(findstring MINGW,$(OS)))
OS := WINNT
else
ifneq (, $(findstring MSYS,$(OS)))
OS := WINNT
else
ifneq (, $(findstring CYGWIN,$(OS)))
OS := WINNT
endif
endif
endif

# Define the program used for compiling C source files:
ifdef C_COMPILER
CC := $(C_COMPILER)
else
CC := gcc
endif

# Define the command-line options when compiling C files:
CFLAGS ?= \
-std=c99 \
-O3 \
-Wall \
-pedantic

# Determine whether to generate [position independent code][1]:
#
# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options
# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option
ifeq ($(OS), WINNT)
fPIC ?=
else
fPIC ?= -fPIC
endif

# List of C targets:
c_targets := benchmark.out


# TARGETS #

# Default target.
#
# This target is the default target.

all: $(c_targets)

.PHONY: all


# Compile C source.
#
# This target compiles C source files.

$(c_targets): %.out: %.c
$(QUIET) $(CC) $(CFLAGS) $(fPIC) -o $@ $< -lm


# Run a benchmark.
#
# This target runs a benchmark.

run: $(c_targets)
$(QUIET) ./$<

.PHONY: run


# Perform clean-up.
#
# This target removes generated files.

clean:
$(QUIET) -rm -f *.o *.out

.PHONY: clean
Loading