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

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.

variterFactorial=require('@stdlib/math-iter-special-factorial');

Returns aniterator which iteratively evaluates thefactorial function.

vararray2iterator=require('@stdlib/array-to-iterator');varit=iterFactorial(array2iterator([3.0,-1.5,-0.5]));// returns <Object>varr=it.next().value;// returns 6.0r=it.next().value;// returns ~-3.545r=it.next().value;// returns ~1.772// ...

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 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.
• If an environment supportsSymbol.iteratorand a providediterator is iterable, the returnediterator is iterable.

• @stdlib/math-base/special/factorial:evaluate a factorial.
• @stdlib/math-iter/special/factorialln:create an iterator which evaluates the natural logarithm of the factorial function for each iterated value.

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.

SeeLICENSE.

Copyright © 2016-2025. The StdlibAuthors.