Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 62 Commits
.github		.github
benchmark		benchmark
dist		dist
docs		docs
examples		examples
lib		lib
test		test
.editorconfig		.editorconfig
.eslintrc.js		.eslintrc.js
.gitattributes		.gitattributes
.gitignore		.gitignore
.npmignore		.npmignore
.npmrc		.npmrc
CHANGELOG.md		CHANGELOG.md
CITATION.cff		CITATION.cff
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
CONTRIBUTING.md		CONTRIBUTING.md
CONTRIBUTORS		CONTRIBUTORS
LICENSE		LICENSE
Makefile		Makefile
NOTICE		NOTICE
README.md		README.md
SECURITY.md		SECURITY.md
branches.md		branches.md
package.json		package.json

Repository files navigation

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 considerfinancially supporting stdlib. We greatly appreciate your continued support!

iterLog

Create aniterator which iteratively computes the baseblogarithm.

Installation

npm install @stdlib/math-iter-special-log

Alternatively,

To load the package in a website via ascript tag without installation and bundlers, use theES Module available on theesm branch (seeREADME).
If you are using Deno, visit thedeno branch (seeREADME for usage intructions).
For use in Observable, or in browser/node environments, use theUniversal Module Definition (UMD) build available on theumd branch (seeREADME).

Thebranches.md file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

Usage

variterLog=require('@stdlib/math-iter-special-log');

iterLog( x, b )

Returns aniterator which iteratively computes the baseblogarithm ofx.

vararray2iterator=require('@stdlib/array-to-iterator');varx=array2iterator([2.0,2.0,10.0]);vary=array2iterator([2.0,6.0,2.0]);varit=iterLog(x,y);// returns <Object>varr=it.next().value;// returns 1.0r=it.next().value;// returns ~0.3869r=it.next().value;// returns ~3.3219// ...

The returnediterator protocol-compliant object has the following properties:

next: function which returns aniterator protocol-compliant object containing the next iterated value (if one exists) assigned to avalue property and adone property having aboolean value indicating whether the iterator is finished.
return: function which closes aniterator and returns a single (optional) argument in aniterator protocol-compliant object.

If provided a numeric value as aniterator argument, the value is broadcast as aninfiniteiterator whichalways returns the provided value.

vararray2iterator=require('@stdlib/array-to-iterator');varx=array2iterator([2.0,6.0]);varit=iterLog(x,2.0);// returns <Object>varv=it.next().value;// returns 1.0v=it.next().value;// returns ~2.58496varbool=it.next().done;// returns true

Notes

For negativeb orx iterated values, the returnediterator returnsNaN.
If an iterated value is non-numeric (includingNaN), the returnediterator returnsNaN. If non-numeric iterated values are possible, you are advised to provide aniterator which type checks and handles non-numeric values accordingly.
The length of the returnediterator is equal to the length of the shortest providediterator. In other words, the returnediterator ends onceone of the providediterators ends.
If an environment supportsSymbol.iteratorand a providediterator is iterable, the returnediterator is iterable.

Examples

varuniform=require('@stdlib/random-iter-uniform');variterLog=require('@stdlib/math-iter-special-log');// Create seeded iterators for generating pseudorandom numbers:varx=uniform(0.0,100.0,{'seed':1234,'iter':10});vary=uniform(0.0,10.0,{'seed':4567,'iter':10});// Create an iterator which consumes the pseudorandom number iterators:varit=iterLog(x,y);// Perform manual iteration...varr;while(true){r=it.next();if(r.done){break;}console.log(r.value);}

Notice

This package is part ofstdlib, 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 developstdlib, see the main projectrepository.