IntStream
IntStream:
object
Defined in: src/stream/Streams.ts:37
Factories for IntStream: of, ofArray, empty, iterate, generate, concat, builder, range, rangeClosed.
Type Declaration
Section titled “Type Declaration”builder
Section titled “builder”builder: () =>
NumberStreamBuilder<IntStream>
Returns a builder that collects numbers one at a time and then builds a stream of them.
Returns
Section titled “Returns”NumberStreamBuilder<IntStream>
concat
Section titled “concat”concat: (
a,b) =>IntStream
Returns a lazy stream of all elements of a followed by all of b. Both inputs count as used; the result
is parallel if either input is, and closing it closes both.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Throws
Section titled “Throws”NullPointerException if a or b is null
empty: () =>
IntStream
Returns an empty stream.
Returns
Section titled “Returns”generate
Section titled “generate”generate: (
s) =>IntStream
Returns an infinite, unordered stream of the values s() returns, called once per element pulled.
Parameters
Section titled “Parameters”() => number
Returns
Section titled “Returns”Throws
Section titled “Throws”NullPointerException if s is null
iterate
Section titled “iterate”iterate: {(
seed,f):IntStream; (seed,hasNext,next):IntStream; }
iterate(seed, f): returns the infinite ordered stream seed, f(seed), f(f(seed)), ….
iterate(seed, hasNext, next): returns the ordered stream a for (n = seed; hasNext(n); n = next(n)) loop
would visit.
Call Signature
Section titled “Call Signature”(
seed,f):IntStream
Parameters
Section titled “Parameters”number
(n) => number
Returns
Section titled “Returns”Call Signature
Section titled “Call Signature”(
seed,hasNext,next):IntStream
Parameters
Section titled “Parameters”number
hasNext
Section titled “hasNext”(n) => boolean
(n) => number
Returns
Section titled “Returns”Throws
Section titled “Throws”NullPointerException if a function argument is null
of: (…
values) =>IntStream
Returns an ordered, sized stream of the given numbers.
Parameters
Section titled “Parameters”values
Section titled “values”…number[]
Returns
Section titled “Returns”ofArray
Section titled “ofArray”ofArray: (
array) =>IntStream
Returns an ordered, sized stream over the array itself, without copying (an addition to the reference API). The range is fixed at creation; values are read when the terminal operation runs.
Parameters
Section titled “Parameters”ArrayLike<number>
Returns
Section titled “Returns”Throws
Section titled “Throws”NullPointerException if array is null
range: (
start,end) =>IntStream
Returns the ordered stream start, start + 1, …, end - 1: start inclusive, end exclusive; empty when start >= end.
Parameters
Section titled “Parameters”number
number
Returns
Section titled “Returns”rangeClosed
Section titled “rangeClosed”rangeClosed: (
start,end) =>IntStream
Returns the ordered stream start, start + 1, …, end: both bounds inclusive; empty when start > end.
Parameters
Section titled “Parameters”number
number