Skip to content

Commit 0db104d

Browse files
kgrytekgryte
committed
Add iterator to compute the coversed cosine
1 parent d08f227 commit 0db104d

File tree

10 files changed

+917
-0
lines changed

10 files changed

+917
-0
lines changed

‎lib/node_modules/@stdlib/math/iter/special/coversin/README.md

+138
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2020 The Stdlib Authors.
6+
7+
Licensed under the Apache License, Version 2.0 (the "License");
8+
you may not use this file except in compliance with the License.
9+
You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing, software
14+
distributed under the License is distributed on an "AS IS" BASIS,
15+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16+
See the License for the specific language governing permissions and
17+
limitations under the License.
18+
19+
-->
20+
21+
# iterCoversin
22+
23+
> Create an [iterator][mdn-iterator-protocol] which computes the [coversed sine][@stdlib/math/base/special/coversin] for each iterated value.
24+
25+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
26+
27+
<section class="intro">
28+
29+
</section>
30+
31+
<!-- /.intro -->
32+
33+
<!-- Package usage documentation. -->
34+
35+
<section class="usage">
36+
37+
## Usage
38+
39+
```javascript
40+
var iterCoversin = require( '@stdlib/math/iter/special/coversin' );
41+
```
42+
43+
#### iterCoversin( iterator )
44+
45+
Returns an [iterator][mdn-iterator-protocol] which iteratively computes the [coversed sine][@stdlib/math/base/special/coversin].
46+
47+
```javascript
48+
var array2iterator = require( '@stdlib/array/to-iterator' );
49+
50+
var it = iterCoversin( array2iterator( [ 0.0, 1.57 ] ) );
51+
// returns <Object>
52+
53+
var v = it.next().value;
54+
// returns 1.0
55+
56+
v = it.next().value;
57+
// returns ~0.0
58+
59+
// ...
60+
```
61+
62+
The returned [iterator][mdn-iterator-protocol] protocol-compliant object has the following properties:
63+
64+
- **next**: function which returns an [iterator][mdn-iterator-protocol] protocol-compliant object containing the next iterated value (if one exists) assigned to a `value` property and a `done` property having a `boolean` value indicating whether the iterator is finished.
65+
- **return**: function which closes an [iterator][mdn-iterator-protocol] and returns a single (optional) argument in an [iterator][mdn-iterator-protocol] protocol-compliant object.
66+
67+
</section>
68+
69+
<!-- /.usage -->
70+
71+
<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
72+
73+
<section class="notes">
74+
75+
## Notes
76+
77+
- If an iterated value is non-numeric (including `NaN`), the returned [iterator][mdn-iterator-protocol] returns `NaN`. If non-numeric iterated values are possible, you are advised to provide an [`iterator`][mdn-iterator-protocol] which type checks and handles non-numeric values accordingly.
78+
- If an environment supports `Symbol.iterator` **and** a provided [iterator][mdn-iterator-protocol] is iterable, the returned [iterator][mdn-iterator-protocol] is iterable.
79+
80+
</section>
81+
82+
<!-- /.notes -->
83+
84+
<!-- Package usage examples. -->
85+
86+
<section class="examples">
87+
88+
## Examples
89+
90+
<!-- eslint no-undef: "error" -->
91+
92+
```javascript
93+
var uniform = require( '@stdlib/random/iter/uniform' );
94+
var iterCoversin = require( '@stdlib/math/iter/special/coversin' );
95+
96+
// Create a seeded iterator for generating pseudorandom numbers:
97+
var rand = uniform( 0.0, 6.28, {
98+
'seed': 1234,
99+
'iter': 10
100+
});
101+
102+
// Create an iterator which consumes the pseudorandom number iterator:
103+
var it = iterCoversin( rand );
104+
105+
// Perform manual iteration...
106+
var v;
107+
while ( true ) {
108+
v = it.next();
109+
if ( v.done ) {
110+
break;
111+
}
112+
console.log( v.value );
113+
}
114+
```
115+
116+
</section>
117+
118+
<!-- /.examples -->
119+
120+
<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
121+
122+
<section class="references">
123+
124+
</section>
125+
126+
<!-- /.references -->
127+
128+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
129+
130+
<section class="links">
131+
132+
[mdn-iterator-protocol]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#The_iterator_protocol
133+
134+
[@stdlib/math/base/special/coversin]: https://github.com/stdlib-js/stdlib
135+
136+
</section>
137+
138+
<!-- /.links -->

‎lib/node_modules/@stdlib/math/iter/special/coversin/benchmark/benchmark.js

+77
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2020 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
'use strict';
20+
21+
// MODULES //
22+
23+
var bench = require( '@stdlib/bench' );
24+
var uniform = require( '@stdlib/random/iter/uniform' );
25+
var isnan = require( '@stdlib/math/base/assert/is-nan' );
26+
var isIteratorLike = require( '@stdlib/assert/is-iterator-like' );
27+
var pkg = require( './../package.json' ).name;
28+
var iterCoversin = require( './../lib' );
29+
30+
31+
// MAIN //
32+
33+
bench( pkg, function benchmark( b ) {
34+
var rand;
35+
var iter;
36+
var i;
37+
38+
rand = uniform( 0.0, 6.28 );
39+
40+
b.tic();
41+
for ( i = 0; i < b.iterations; i++ ) {
42+
iter = iterCoversin( rand );
43+
if ( typeof iter !== 'object' ) {
44+
b.fail( 'should return an object' );
45+
}
46+
}
47+
b.toc();
48+
if ( !isIteratorLike( iter ) ) {
49+
b.fail( 'should return an iterator protocol-compliant object' );
50+
}
51+
b.pass( 'benchmark finished' );
52+
b.end();
53+
});
54+
55+
bench( pkg+'::iteration', function benchmark( b ) {
56+
var rand;
57+
var iter;
58+
var z;
59+
var i;
60+
61+
rand = uniform( 0.0, 6.28 );
62+
iter = iterCoversin( rand );
63+
64+
b.tic();
65+
for ( i = 0; i < b.iterations; i++ ) {
66+
z = iter.next().value;
67+
if ( isnan( z ) ) {
68+
b.fail( 'should not return NaN' );
69+
}
70+
}
71+
b.toc();
72+
if ( isnan( z ) ) {
73+
b.fail( 'should not return NaN' );
74+
}
75+
b.pass( 'benchmark finished' );
76+
b.end();
77+
});

‎lib/node_modules/@stdlib/math/iter/special/coversin/docs/repl.txt

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
2+
{{alias}}( iterator )
3+
Returns an iterator which iteratively computes the coversed sine.
4+
5+
If an environment supports Symbol.iterator and a provided iterator is
6+
iterable, the returned iterator is iterable.
7+
8+
Parameters
9+
----------
10+
iterator: Object
11+
Input iterator.
12+
13+
Returns
14+
-------
15+
iterator: Object
16+
Iterator.
17+
18+
iterator.next(): Function
19+
Returns an iterator protocol-compliant object containing the next
20+
iterated value (if one exists) and a boolean flag indicating whether the
21+
iterator is finished.
22+
23+
iterator.return( [value] ): Function
24+
Finishes an iterator and returns a provided value.
25+
26+
Examples
27+
--------
28+
> var r = {{alias:@stdlib/random/iter/uniform}}( 0.0, 6.28 );
29+
> var it = {{alias}}( r );
30+
> var v = it.next().value
31+
<number>
32+
> v = it.next().value
33+
<number>
34+
35+
See Also
36+
--------
37+

‎lib/node_modules/@stdlib/math/iter/special/coversin/docs/types/index.d.ts

+59
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
/*
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2020 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
// TypeScript Version: 2.0
20+
21+
/// <reference types="@stdlib/types"/>
22+
23+
import { Iterator as Iter, IterableIterator } from '@stdlib/types/iter';
24+
25+
// Define a union type representing both iterable and non-iterable iterators:
26+
type Iterator = Iter | IterableIterator;
27+
28+
/**
29+
* Returns an iterator which iteratively computes the coversed sine.
30+
*
31+
* ## Notes
32+
*
33+
* - If an environment supports `Symbol.iterator` **and** a provided iterator is iterable, the returned iterator is iterable.
34+
*
35+
* @param iterator - input iterator
36+
* @returns iterator
37+
*
38+
* @example
39+
* var uniform = require( `@stdlib/random/iter/uniform` );
40+
*
41+
* var iter = iterCoversin( uniform( 0.0, 6.28 ) );
42+
*
43+
* var v = iter.next().value;
44+
* // returns <number>
45+
*
46+
* v = iter.next().value;
47+
* // returns <number>
48+
*
49+
* v = iter.next().value;
50+
* // returns <number>
51+
*
52+
* // ...
53+
*/
54+
declare function iterCoversin( iterator: Iterator ): Iterator;
55+
56+
57+
// EXPORTS //
58+
59+
export = iterCoversin;

‎lib/node_modules/@stdlib/math/iter/special/coversin/docs/types/test.ts

+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
/*
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2020 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
import iterCoversin = require( './index' );
20+
21+
/**
22+
* Returns an iterator protocol-compliant object.
23+
*
24+
* @returns iterator protocol-compliant object
25+
*/
26+
function iterator() {
27+
return {
28+
'next': next
29+
};
30+
}
31+
32+
/**
33+
* Implements the iterator protocol `next` method.
34+
*
35+
* @returns iterator protocol-compliant object
36+
*/
37+
function next() {
38+
return {
39+
'value': true,
40+
'done': false
41+
};
42+
}
43+
44+
45+
// TESTS //
46+
47+
// The function returns an iterator...
48+
{
49+
iterCoversin( iterator() ); // $ExpectType Iterator
50+
}
51+
52+
// The compiler throws an error if the function is provided a first argument which is not an iterator protocol-compliant object...
53+
{
54+
iterCoversin( '5' ); // $ExpectError
55+
iterCoversin( 5 ); // $ExpectError
56+
iterCoversin( true ); // $ExpectError
57+
iterCoversin( false ); // $ExpectError
58+
iterCoversin( null ); // $ExpectError
59+
iterCoversin( undefined ); // $ExpectError
60+
iterCoversin( [] ); // $ExpectError
61+
iterCoversin( {} ); // $ExpectError
62+
iterCoversin( ( x: number ): number => x ); // $ExpectError
63+
}
64+
65+
// The compiler throws an error if the function is provided insufficient arguments...
66+
{
67+
iterCoversin(); // $ExpectError
68+
}

0 commit comments

Comments
 (0)