Skip to content

Commit 0cb4fa2

Browse files
committed
feat: update math/iter/sequences TypeScript declarations
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent beb375b commit 0cb4fa2

File tree

1 file changed

+34
-0
lines changed
  • lib/node_modules/@stdlib/math/iter/sequences/docs/types

1 file changed

+34
-0
lines changed

lib/node_modules/@stdlib/math/iter/sequences/docs/types/index.d.ts

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ import iterPrimesSeq = require( '@stdlib/math/iter/sequences/primes' );
4949
import iterSquaredTriangularSeq = require( '@stdlib/math/iter/sequences/squared-triangular' );
5050
import iterSquaresSeq = require( '@stdlib/math/iter/sequences/squares' );
5151
import iterTriangularSeq = require( '@stdlib/math/iter/sequences/triangular' );
52+
import iterTribonacciSeq = require( '@stdlib/math/iter/sequences/tribonacci' );
5253

5354
/**
5455
* Interface describing the `sequences` namespace.
@@ -881,6 +882,39 @@ interface Namespace {
881882
* // ...
882883
*/
883884
iterTriangularSeq: typeof iterTriangularSeq;
885+
886+
/**
887+
* Returns an iterator which generates a Tribonacci sequence.
888+
*
889+
* ## Notes
890+
*
891+
* - The returned iterator can only generate the first `64` Tribonacci numbers, as larger Tribonacci numbers cannot be safely represented in double-precision floating-point format.
892+
* - If an environment supports `Symbol.iterator`, the returned iterator is iterable.
893+
*
894+
* @param options - function options
895+
* @param options.iter - number of iterations (default: 64)
896+
* @throws `iter` option must be a nonnegative integer
897+
* @throws `iter` option must be less than or equal to 64
898+
* @returns iterator
899+
*
900+
* @example
901+
* var iter = ns.iterTribonacciSeq();
902+
*
903+
* var v = iter.next().value;
904+
* // returns 0
905+
*
906+
* v = iter.next().value;
907+
* // returns 0
908+
*
909+
* v = iter.next().value;
910+
* // returns 1
911+
*
912+
* v = iter.next().value;
913+
* // returns 2
914+
*
915+
* // ...
916+
*/
917+
iterTribonacciSeq: typeof iterTribonacciSeq;
884918
}
885919

886920
/**

0 commit comments

Comments
 (0)