Add notes

Author: kgryte

lib/node_modules/@stdlib/math/iter/sequences/cubes/lib/main.js

@@ -35,6 +35,10 @@ var MAX_ITER = 208063; // floor(cbrt(FLOAT64_MAX_SAFE_INTEGER))
 /**
 * Returns an iterator which generates a sequence of cubes.
 *
+* ## Notes
+*
+* -   If an environment supports `Symbol.iterator`, the returned iterator is iterable.
+*
 * @param {Options} [options] - function options
 * @param {NonNegativeInteger} [options.iter=208063] - number of iterations
 * @throws {TypeError} options argument must be an object

lib/node_modules/@stdlib/math/iter/sequences/factorials/lib/main.js

@@ -36,6 +36,10 @@ var MAX_ITER = 1e308;
 /**
 * Returns an iterator which generates a sequence of factorials.
 *
+* ## Notes
+*
+* -   If an environment supports `Symbol.iterator`, the returned iterator is iterable.
+*
 * @param {Options} [options] - function options
 * @param {NonNegativeInteger} [options.iter=1e308] - number of iterations
 * @throws {TypeError} options argument must be an object

lib/node_modules/@stdlib/math/iter/sequences/fibonacci/lib/main.js

@@ -36,6 +36,11 @@ var F1 = 1;
 /**
 * Returns an iterator which generates a Fibonacci sequence.
 *
+* ## Notes
+*
+* -   The returned iterator can only generate the first `79` Fibonacci numbers, as larger Fibonacci numbers cannot be safely represented in double-precision floating-point format.
+* -   If an environment supports `Symbol.iterator`, the returned iterator is iterable.
+*
 * @param {Options} [options] - function options
 * @param {NonNegativeInteger} [options.iter=79] - number of iterations
 * @throws {TypeError} options argument must be an object

lib/node_modules/@stdlib/math/iter/sequences/integers/lib/main.js

@@ -36,6 +36,10 @@ var MAX_ITER = FLOAT64_MAX_SAFE_INTEGER * 2;
 /**
 * Returns an iterator which generates an interleaved integer sequence.
 *
+* ## Notes
+*
+* -   If an environment supports `Symbol.iterator`, the returned iterator is iterable.
+*
 * @param {Options} [options] - function options
 * @param {NonNegativeInteger} [options.iter=18014398509481984] - number of iterations
 * @throws {TypeError} options argument must be an object

lib/node_modules/@stdlib/math/iter/sequences/lucas/lib/main.js

@@ -36,6 +36,11 @@ var L1 = 1;
 /**
 * Returns an iterator which generates a Lucas sequence.
 *
+* ## Notes
+*
+* -   The returned iterator can only generate the first `77` Lucas numbers, as larger Lucas numbers cannot be safely represented in double-precision floating-point format.
+* -   If an environment supports `Symbol.iterator`, the returned iterator is iterable.
+*
 * @param {Options} [options] - function options
 * @param {NonNegativeInteger} [options.iter=77] - number of iterations
 * @throws {TypeError} options argument must be an object

lib/node_modules/@stdlib/math/iter/sequences/negafibonacci/lib/main.js

@@ -36,6 +36,11 @@ var F1 = 1;
 /**
 * Returns an iterator which generates a negaFibonacci sequence.
 *
+* ## Notes
+*
+* -   The returned iterator can only generate the first `79` negaFibonacci numbers, as larger negaFibonacci numbers cannot be safely represented in double-precision floating-point format.
+* -   If an environment supports `Symbol.iterator`, the returned iterator is iterable.
+*
 * @param {Options} [options] - function options
 * @param {NonNegativeInteger} [options.iter=79] - number of iterations
 * @throws {TypeError} options argument must be an object

lib/node_modules/@stdlib/math/iter/sequences/negalucas/lib/main.js

@@ -36,6 +36,11 @@ var L1 = -1;
 /**
 * Returns an iterator which generates a negaLucas sequence.
 *
+* ## Notes
+*
+* -   The returned iterator can only generate the first `77` negaLucas numbers, as larger negaLucas numbers cannot be safely represented in double-precision floating-point format.
+* -   If an environment supports `Symbol.iterator`, the returned iterator is iterable.
+*
 * @param {Options} [options] - function options
 * @param {NonNegativeInteger} [options.iter=77] - number of iterations
 * @throws {TypeError} options argument must be an object

lib/node_modules/@stdlib/math/iter/sequences/negative-integers/lib/main.js

@@ -31,6 +31,10 @@ var validate = require( './validate.js' );
 /**
 * Returns an iterator which generates a negative integer sequence.
 *
+* ## Notes
+*
+* -   If an environment supports `Symbol.iterator`, the returned iterator is iterable.
+*
 * @param {Options} [options] - function options
 * @param {NonNegativeInteger} [options.iter=9007199254740991] - number of iterations
 * @throws {TypeError} options argument must be an object

lib/node_modules/@stdlib/math/iter/sequences/nonfibonacci/lib/main.js

@@ -31,6 +31,10 @@ var validate = require( './validate.js' );
 /**
 * Returns an iterator which generates a non-Fibonacci integer sequence.
 *
+* ## Notes
+*
+* -   If an environment supports `Symbol.iterator`, the returned iterator is iterable.
+*
 * @param {Options} [options] - function options
 * @param {NonNegativeInteger} [options.iter=1e308] - number of iterations
 * @throws {TypeError} options argument must be an object

lib/node_modules/@stdlib/math/iter/sequences/nonnegative-integers/lib/main.js

@@ -36,6 +36,10 @@ var MAX_ITER = FLOAT64_MAX_SAFE_INTEGER + 1;
 /**
 * Returns an iterator which generates a nonnegative integer sequence.
 *
+* ## Notes
+*
+* -   If an environment supports `Symbol.iterator`, the returned iterator is iterable.
+*
 * @param {Options} [options] - function options
 * @param {NonNegativeInteger} [options.iter=9007199254740992] - number of iterations
 * @throws {TypeError} options argument must be an object

lib/node_modules/@stdlib/math/iter/sequences/nonpositive-integers/lib/main.js

@@ -36,6 +36,10 @@ var MAX_ITER = FLOAT64_MAX_SAFE_INTEGER + 1;
 /**
 * Returns an iterator which generates a nonpositive integer sequence.
 *
+* ## Notes
+*
+* -   If an environment supports `Symbol.iterator`, the returned iterator is iterable.
+*
 * @param {Options} [options] - function options
 * @param {NonNegativeInteger} [options.iter=9007199254740992] - number of iterations
 * @throws {TypeError} options argument must be an object

lib/node_modules/@stdlib/math/iter/sequences/nonsquares/lib/main.js

@@ -37,6 +37,10 @@ var MAX_ITER = 9007199349647256; // FLOAT64_MAX_SAFE_INTEGER + floor(sqrt(FLOAT6
 /**
 * Returns an iterator which generates a sequence of nonsquares.
 *
+* ## Notes
+*
+* -   If an environment supports `Symbol.iterator`, the returned iterator is iterable.
+*
 * @param {Options} [options] - function options
 * @param {NonNegativeInteger} [options.iter=9007199349647256] - number of iterations
 * @throws {TypeError} options argument must be an object

lib/node_modules/@stdlib/math/iter/sequences/positive-integers/lib/main.js

@@ -31,6 +31,10 @@ var validate = require( './validate.js' );
 /**
 * Returns an iterator which generates a positive integer sequence.
 *
+* ## Notes
+*
+* -   If an environment supports `Symbol.iterator`, the returned iterator is iterable.
+*
 * @param {Options} [options] - function options
 * @param {NonNegativeInteger} [options.iter=9007199254740991] - number of iterations
 * @throws {TypeError} options argument must be an object

lib/node_modules/@stdlib/math/iter/sequences/squares/lib/main.js

@@ -35,6 +35,10 @@ var MAX_ITER = 94906265; // floor(sqrt(FLOAT64_MAX_SAFE_INTEGER))
 /**
 * Returns an iterator which generates a sequence of squares.
 *
+* ## Notes
+*
+* -   If an environment supports `Symbol.iterator`, the returned iterator is iterable.
+*
 * @param {Options} [options] - function options
 * @param {NonNegativeInteger} [options.iter=94906265] - number of iterations
 * @throws {TypeError} options argument must be an object