Skip to content
Draft
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
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ The returned iterator protocol-compliant object has the following properties:

The function supports the following `options`:

- **iter**: number of iterations. Default: `18014398509481984`.
- **iter**: number of iterations. Default: `18014398509481982`.

By default, the function returns a finite iterator to avoid exceeding the maximum safe double-precision floating-point integer. To adjust the number of iterations, set the `iter` option.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
Function options.

options.iter: integer (optional)
Number of iterations. Default: 18014398509481984.
Number of iterations. Default: 18014398509481982.

Returns
-------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ interface Options {
* - If an environment supports `Symbol.iterator`, the returned iterator is iterable.
*
* @param options - function options
* @param options.iter - number of iterations (default: 18014398509481984)
* @param options.iter - number of iterations (default: 18014398509481982)
* @throws `iter` option must be a nonnegative integer
* @returns iterator
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ var MAX_ITER = FLOAT64_MAX_SAFE_INTEGER * 2;
* - If an environment supports `Symbol.iterator`, the returned iterator is iterable.
*
* @param {Options} [options] - function options
* @param {NonNegativeInteger} [options.iter=18014398509481984] - number of iterations
* @param {NonNegativeInteger} [options.iter=18014398509481982] - number of iterations
* @throws {TypeError} options argument must be an object
* @throws {TypeError} must provide valid options
* @returns {Iterator} iterator
Expand Down
4 changes: 2 additions & 2 deletions lib/node_modules/@stdlib/math/iter/special/pow/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ limitations under the License.

# iterPow

> Create an [iterator][mdn-iterator-protocol] which iteratively evaluates the [exponential function][@stdlib/math/base/special/pow].
> Create an [iterator][mdn-iterator-protocol] which iteratively evaluates the [power function][@stdlib/math/base/special/pow] (i.e., `base` raised to the power `exponent`).

<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->

Expand All @@ -42,7 +42,7 @@ var iterPow = require( '@stdlib/math/iter/special/pow' );

#### iterPow( base, exponent )

Returns an [iterator][mdn-iterator-protocol] which iteratively evaluates the [exponential function][@stdlib/math/base/special/pow].
Returns an [iterator][mdn-iterator-protocol] which iteratively evaluates the [power function][@stdlib/math/base/special/pow] (i.e., `base` raised to the power `exponent`).

```javascript
var array2iterator = require( '@stdlib/array/to-iterator' );
Expand Down
3 changes: 2 additions & 1 deletion lib/node_modules/@stdlib/math/iter/special/pow/docs/repl.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@

{{alias}}( base, exponent )
Returns an iterator which iteratively evaluates the exponential function.
Returns an iterator which iteratively evaluates the power function (i.e.,
`base` raised to the power `exponent`).

The length of the returned iterator is equal to the length of the shortest
provided iterator. In other words, the returned iterator ends once *one* of
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ import { Iterator as Iter, IterableIterator } from '@stdlib/types/iter';
type Iterator = Iter | IterableIterator;

/**
* Returns an iterator which iteratively evaluates the exponential function.
* Returns an iterator which iteratively evaluates the power function (i.e., `base` raised to the power `exponent`).
*
* ## Notes
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
'use strict';

/**
* Create an iterator which iteratively evaluates the exponential function.
* Create an iterator which iteratively evaluates the power function (i.e., `base` raised to the power `exponent`).
*
* @module @stdlib/math/iter/special/pow
*
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/math/iter/special/pow/lib/main.js
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ var pow = require( '@stdlib/math/base/special/pow' );
// MAIN //

/**
* Returns an iterator which iteratively evaluates the exponential function.
* Returns an iterator which iteratively evaluates the power function (i.e., `base` raised to the power `exponent`).
*
* ## Notes
*
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@stdlib/math/iter/special/pow",
"version": "0.0.0",
"description": "Create an iterator which evaluates the exponential function.",
"description": "Create an iterator which evaluates the power function (i.e., `base` raised to the power `exponent`).",
"license": "Apache-2.0",
"author": {
"name": "The Stdlib Authors",
Expand Down