@stdlib/math-iter-sequences-triangular
v0.2.3TypeScript
Create an iterator which generates a sequence of triangular numbers.
0/weekUpdated 2 days agoApache-2.0Unpacked: 55.6 KB
Published by The Stdlib Authors
npm install @stdlib/math-iter-sequences-triangularWe 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 consider financially supporting stdlib. We greatly appreciate your continued support!
About stdlib...
iterTriangularSeq
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Create an iterator which generates a sequence of [triangular numbers][oeis-a000217].
The [triangular numbers][triangular-number] are the integer sequence
starting at the 0th [triangular number][triangular-number].
[Triangular numbers][triangular-number] are given by the following explicit formulas
where the last formula corresponds to a [binomial coefficient][@stdlib/math/base/special/binomcoef], representing the number of distinct pairs that can be selected from n+1 items.
Installation
``bash`
npm install @stdlib/math-iter-sequences-triangular
Usage
`javascript`
var iterTriangularSeq = require( '@stdlib/math-iter-sequences-triangular' );
#### iterTriangularSeq( \[options] )
Returns an iterator which generates a sequence of [triangular numbers][triangular-number].
`javascript
var it = iterTriangularSeq();
// returns
var v = it.next().value;
// returns 0
v = it.next().value;
// returns 1
v = it.next().value;
// returns 3
v = it.next().value;
// returns 6
v = it.next().value;
// returns 10
// ...
`
The returned iterator protocol-compliant object has the following properties:
- next: function which returns an iterator protocol-compliant object containing the next iterated value (if one exists) assigned to a value property and a done property having a boolean value indicating whether the iterator is finished.
- return: function which closes an iterator and returns a single (optional) argument in an iterator protocol-compliant object.
The function supports the following options:
- iter: number of iterations. Default: 134217727.
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.
`javascript
var opts = {
'iter': 2
};
var it = iterTriangularSeq( opts );
// returns
var v = it.next().value;
// returns 0
v = it.next().value;
// returns 1
var bool = it.next().done;
// returns true
`
Notes
- If an environment supports Symbol.iterator, the returned iterator is iterable.
Examples
`javascript
var iterTriangularSeq = require( '@stdlib/math-iter-sequences-triangular' );
// Create an iterator:
var opts = {
'iter': 100
};
var it = iterTriangularSeq( opts );
// Perform manual iteration...
var v;
while ( true ) {
v = it.next();
if ( v.done ) {
break;
}
console.log( v.value );
}
`
*
See Also
- [@stdlib/math-iter/sequences/squared-triangular][@stdlib/math/iter/sequences/squared-triangular]: create an iterator which generates a sequence of squared triangular numbers.
*
Notice
This package is part of [stdlib][stdlib], 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 develop [stdlib][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
License
See [LICENSE][stdlib-license].
Copyright
Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/math-iter-sequences-triangular.svg
[npm-url]: https://npmjs.org/package/@stdlib/math-iter-sequences-triangular
[test-image]: https://github.com/stdlib-js/math-iter-sequences-triangular/actions/workflows/test.yml/badge.svg?branch=v0.2.3
[test-url]: https://github.com/stdlib-js/math-iter-sequences-triangular/actions/workflows/test.yml?query=branch:v0.2.3
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-iter-sequences-triangular/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/math-iter-sequences-triangular?branch=main
[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
[chat-url]: https://stdlib.zulipchat.com
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/math-iter-sequences-triangular/tree/deno
[deno-readme]: https://github.com/stdlib-js/math-iter-sequences-triangular/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/math-iter-sequences-triangular/tree/umd
[umd-readme]: https://github.com/stdlib-js/math-iter-sequences-triangular/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/math-iter-sequences-triangular/tree/esm
[esm-readme]: https://github.com/stdlib-js/math-iter-sequences-triangular/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/math-iter-sequences-triangular/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/math-iter-sequences-triangular/main/LICENSE
[oeis-a000217]: https://oeis.org/A000217
[triangular-number]: https://en.wikipedia.org/wiki/Triangular_number
[@stdlib/math/base/special/binomcoef]: https://www.npmjs.com/package/@stdlib/math-base-special-binomcoef
[@stdlib/math/iter/sequences/squared-triangular]: https://www.npmjs.com/package/@stdlib/math-iter-sequences-squared-triangular