Skip to content

Latest commit

 

History

History
281 lines (175 loc) · 9.6 KB

README.md

File metadata and controls

281 lines (175 loc) · 9.6 KB
Raw
About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

iterCospi

NPM version Build Status Coverage Status

Create an iterator which computes the cosine of each iterated value times π.

Usage

To use in Observable,

iterCospi = require( 'https://cdn.jsdelivr.net/gh/stdlib-js/math-iter-special-cospi@umd/browser.js' )

To vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:

var iterCospi = require( 'path/to/vendor/umd/math-iter-special-cospi/index.js' )

To include the bundle in a webpage,

<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/math-iter-special-cospi@umd/browser.js"></script>

If no recognized module system is present, access bundle contents via the global scope:

<script type="text/javascript">
(function () {
    window.iterCospi;
})();
</script>

iterCospi( iterator )

Returns an iterator which computes the cosine of each iterated value times π.

var array2iterator = require( '@stdlib/array-to-iterator' );

var src = [ 0.0, 0.5, 0.1 ];
var it = iterCospi( array2iterator( src ) );
// returns <Object>

var r = it.next().value;
// returns 1.0

r = it.next().value;
// returns 0.0

r = it.next().value;
// returns ~0.951

// ...

The returned iterator protocol-compliant object has the following properties:

  • next: function which returns an iterator 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.
  • return: function which closes an iterator and returns a single (optional) argument in an iterator protocol-compliant object.

Notes

  • Computes cos(πx) more accurately than cos(pi*x), especially for large x.
  • If an iterated value is non-numeric (including NaN), the returned iterator returns NaN. If non-numeric iterated values are possible, you are advised to provide an iterator which type checks and handles non-numeric values accordingly.
  • If an environment supports Symbol.iterator and a provided iterator is iterable, the returned iterator is iterable.

Examples

<!DOCTYPE html>
<html lang="en">
<body>
<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/random-iter-randu@umd/browser.js"></script>
<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/math-iter-special-cospi@umd/browser.js"></script>
<script type="text/javascript">
(function () {

// Create a seeded iterator for generating pseudorandom numbers:
var rand = randu({
    'seed': 1234,
    'iter': 10
});

// Create an iterator which consumes the pseudorandom number iterator:
var it = iterCospi( rand );

// Perform manual iteration...
var r;
while ( true ) {
    r = it.next();
    if ( r.done ) {
        break;
    }
    console.log( r.value );
}

})();
</script>
</body>
</html>

See Also

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

Chat

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.