28319975315

Committed 28 Jun 2026 10:57AM UTC coverage: 78.662% (+0.1%) from 78.53%

Build # 28319975315

Build Type

Pull #1995

github

Committed by

web-flow

Commit Message

Merge 23e573ce5 into c5b34c1fc

Pull Request Pull Request #1995: Operators Fix

Coverage Stats

3173 of 4243 branches covered (74.78%)

Branch coverage included in aggregate %.

102 of 110 new or added lines in 18 files covered. (92.73%)

25 existing lines in 5 files now uncovered.

7079 of 8790 relevant lines covered (80.53%)

175993.71 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

60.98

/src/stdlib/stream.ts

import { GeneralRuntimeError } from '../errors/base';
import { InvalidParameterTypeError } from '../errors/rttcErrors';
import { callWithoutMetadata, wrap } from '../utils/operators';
import { head, is_null, is_pair, type List, type Pair, pair, tail } from './list';
import { arity } from './misc';

type NonEmptyStream<T = unknown> = Pair<T, () => Stream<T>>;
export type Stream<T = unknown> = null | NonEmptyStream<T>;

function createStreamPair<T>(item: T, next: () => Stream<T>): NonEmptyStream<T> {
  const streamTail = wrap(next, undefined, undefined, '() => ...');
  return pair(item, streamTail);
}

/**
 * Makes a Stream out of its arguments\
 * LOW-LEVEL FUNCTION, NOT SOURCE
 */
export function stream(): null;
export function stream<T>(...elements: T[]): NonEmptyStream<T>;
export function stream<T>(...elements: T[]): Stream<T> {
  if (elements.length === 0) return null;

  const [item, ...rest] = elements;
  return createStreamPair(item, () => stream(...rest));
}

// same as list_to_stream in stream.prelude.ts
export function list_to_stream<T>(xs: List<T>): Stream<T> {
  return is_null(xs) ? null : createStreamPair(head(xs), () => list_to_stream(tail(xs)));
}

export function stream_tail<T>(stream: NonEmptyStream<T>): Stream<T>;
export function stream_tail(stream: unknown): Stream<unknown> {
  if (!is_pair(stream)) {
    throw new InvalidParameterTypeError('non-empty stream', stream, stream_tail.name);
  }

  const next = tail(stream);
  if (typeof next !== 'function' || arity(next) !== 0) {
    throw new InvalidParameterTypeError('stream', stream, stream_tail.name);
  }

  return next();
}

/**
 * Returns `true` is the given object is a stream.
 *
 * NOT Lazy: The function must evaluate all the elements of the stream
 */
export function is_stream(obj: unknown): obj is Stream<unknown> {
  if (is_null(obj)) return true;

  if (!is_pair(obj)) return false;
  const next = tail(obj);

  if (typeof next !== 'function') return false;
  if (arity(next) !== 0) return false;

  return is_stream(next());
}

/**
 * Constructs an infinite stream of integers, beginning with n, incrementing 1 at
 * a time.
 *
 * Lazy.
 */
export function integers_from(n: number): Stream<number> {
  return pair(n, () => integers_from(n + 1));
}

/**
 * Builds a stream of n elements by applying the provided function to the
 * numbers [0, n-1].
 *
 * Lazy: f is only called when the resulting stream is forced.
 */
export function build_stream<T>(f: (n: number) => T, n: number): Stream<T> {
  function build(i: number): Stream<T> {
    return i >= n ? null : pair(callWithoutMetadata(f, i), () => build(i + 1));
  }

  return build(0);
}

/**
 * Applies the provided function to elements of the given stream.
 *
 * Lazy: the provided function does not execute until the
 * forced by the resulting stream.
 */
export function stream_map<T, U>(f: (arg: T) => U, s: Stream<T>): Stream<U> {
  return is_null(s)
    ? null
    : pair(callWithoutMetadata(f, head(s)), () => stream_map(f, stream_tail(s)));
}

/**
 * Returns a substream containing the elements that the provided predicate returned `true` for.
 *
 * Partially Lazy: Both the predicate and stream are evaluated as necessary
 */
export function stream_filter<T, U extends T>(f: (arg: T) => arg is U, s: Stream<T>): Stream<U>;
export function stream_filter<T>(f: (arg: T) => boolean, s: Stream<T>): Stream<T>;
export function stream_filter<T>(f: (arg: T) => boolean, s: Stream<T>): Stream<T> {
  if (is_null(s)) return null;

  const should = callWithoutMetadata(f, head(s));

  return should
    ? pair(head(s), () => stream_filter(f, stream_tail(s)))
    : stream_filter(f, stream_tail(s));
}

/**
 * Applies the given function to every single element of the stream.
 *
 * NOT lazy: This function evaluates the entire stream.
 */
export function stream_for_each<T>(f: (arg: T) => void, s: Stream<T>) {
  if (is_null(s)) {
    return true;
  } else {
    callWithoutMetadata(f, head(s));
    return stream_for_each(f, stream_tail(s));
  }
}

/**
 * Accumulate applies given operation op to elements of a stream
 * in a right-to-left order, first apply op to the last element
 * and an initial element, resulting in r1, then to the second-last
 * element and r1, resulting in r2, etc, and finally to the first element
 * and r_n-1, where n is the length of the list. `accumulate(op,zero,list(1,2,3))`
 * results in `op(1, op(2, op(3, zero)))`.
 *
 * NOT lazy: This function evaluates the entire stream when called
 */
export function stream_accumulate<T, U>(
  f: (each: T, result: U) => U,
  initial: U,
  stream: Stream<T>,
): U {
  let res = initial;
  let entry = stream;

  while (!is_null(entry)) {
    const element = head(entry);
    res = callWithoutMetadata(f, element, res);
    entry = stream_tail(entry);
  }

  return res;
}

/**
 * Returns the length of the stream.
 *
 * NOT lazy: The function must evaluate the entire stream
 */
export function stream_length(s: Stream<unknown>): number {
  return stream_accumulate((_, res) => res + 1, 0, s);
}

/**
 * Returns the nth element of the stream.
 *
 * NOT lazy: The stream must be evaluated up to the nth element.
 */
export function stream_ref<T>(s: Stream<T>, n: number): T {
  for (let i = 0; i < n && !is_null(s); i++) {
    s = stream_tail(s);
  }

  if (is_null(s)) {
    throw new GeneralRuntimeError(`${stream_ref.name}: Index ${n} out of bounds!`);
  }

  return head(s);
}

/**
 * Appends a stream to the end of another stream.
 *
 * @param lhs Stream to append to
 * @param rhs Stream to be appending
 *
 * Lazy: `rhs` is only evaluated after `lhs` is fully evaluated. This
 * does mean that if `lhs` is infinite elements from `rhs` will never be evaluated.
 */
export function stream_append<T>(lhs: Stream<T>, rhs: Stream<T>): Stream<T> {
  return is_null(lhs) ? rhs : pair(head(lhs), () => stream_append(stream_tail(lhs), rhs));
}

/**
 * Converts the given stream to a {@link List|list}.
 *
 * NOT Lazy: Function has to evaluate every element of the stream
 * to populate the resulting list
 */
export function stream_to_list<T>(stream: Stream<T>): List<T> {
  return is_null(stream) ? null : pair(head(stream), stream_to_list(stream_tail(stream)));
}

1	import { GeneralRuntimeError } from '../errors/base';
2	import { InvalidParameterTypeError } from '../errors/rttcErrors';
3	import { callWithoutMetadata, wrap } from '../utils/operators';
4	import { head, is_null, is_pair, type List, type Pair, pair, tail } from './list';
5	import { arity } from './misc';
6
7	type NonEmptyStream<T = unknown> = Pair<T, () => Stream<T>>;
8	export type Stream<T = unknown> = null \| NonEmptyStream<T>;
9
10	function createStreamPair<T>(item: T, next: () => Stream<T>): NonEmptyStream<T> {
11	const streamTail = wrap(next, undefined, undefined, '() => ...');	112✔
12	return pair(item, streamTail);	112✔
13	}
14
15	/**
16	* Makes a Stream out of its arguments\
17	* LOW-LEVEL FUNCTION, NOT SOURCE
18	*/
19	export function stream(): null;
20	export function stream<T>(...elements: T[]): NonEmptyStream<T>;
21	export function stream<T>(...elements: T[]): Stream<T> {
22	if (elements.length === 0) return null;	142✔
23
24	const [item, ...rest] = elements;	112✔
25	return createStreamPair(item, () => stream(...rest));	112✔
26	}
27
28	// same as list_to_stream in stream.prelude.ts
29	export function list_to_stream<T>(xs: List<T>): Stream<T> {
30	return is_null(xs) ? null : createStreamPair(head(xs), () => list_to_stream(tail(xs)));	×
31	}
32
33	export function stream_tail<T>(stream: NonEmptyStream<T>): Stream<T>;
34	export function stream_tail(stream: unknown): Stream<unknown> {
35	if (!is_pair(stream)) {	39✔
36	throw new InvalidParameterTypeError('non-empty stream', stream, stream_tail.name);	1✔
37	}
38
39	const next = tail(stream);	38✔
40	if (typeof next !== 'function' \|\| arity(next) !== 0) {	38!
41	throw new InvalidParameterTypeError('stream', stream, stream_tail.name);	×
42	}
43
44	return next();	38✔
45	}
46
47	/**
48	* Returns `true` is the given object is a stream.
49	*
50	* NOT Lazy: The function must evaluate all the elements of the stream
51	*/
52	export function is_stream(obj: unknown): obj is Stream<unknown> {
53	if (is_null(obj)) return true;	×
54
55	if (!is_pair(obj)) return false;	×
56	const next = tail(obj);	×
57
58	if (typeof next !== 'function') return false;	×
59	if (arity(next) !== 0) return false;	×
60
61	return is_stream(next());	×
62	}
63
64	/**
65	* Constructs an infinite stream of integers, beginning with n, incrementing 1 at
66	* a time.
67	*
68	* Lazy.
69	*/
70	export function integers_from(n: number): Stream<number> {
71	return pair(n, () => integers_from(n + 1));	×
72	}
73
74	/**
75	* Builds a stream of n elements by applying the provided function to the
76	* numbers [0, n-1].
77	*
78	* Lazy: f is only called when the resulting stream is forced.
79	*/
80	export function build_stream<T>(f: (n: number) => T, n: number): Stream<T> {
81	function build(i: number): Stream<T> {
82	return i >= n ? null : pair(callWithoutMetadata(f, i), () => build(i + 1));	28✔
83	}
84
85	return build(0);	7✔
86	}
87
88	/**
89	* Applies the provided function to elements of the given stream.
90	*
91	* Lazy: the provided function does not execute until the
92	* forced by the resulting stream.
93	*/
94	export function stream_map<T, U>(f: (arg: T) => U, s: Stream<T>): Stream<U> {
95	return is_null(s)	1!
96	? null
NEW 97	: pair(callWithoutMetadata(f, head(s)), () => stream_map(f, stream_tail(s)));	×
98	}
99
100	/**
101	* Returns a substream containing the elements that the provided predicate returned `true` for.
102	*
103	* Partially Lazy: Both the predicate and stream are evaluated as necessary
104	*/
105	export function stream_filter<T, U extends T>(f: (arg: T) => arg is U, s: Stream<T>): Stream<U>;
106	export function stream_filter<T>(f: (arg: T) => boolean, s: Stream<T>): Stream<T>;
107	export function stream_filter<T>(f: (arg: T) => boolean, s: Stream<T>): Stream<T> {
108	if (is_null(s)) return null;	9✔
109
110	const should = callWithoutMetadata(f, head(s));	8✔
111
112	return should	8✔
113	? pair(head(s), () => stream_filter(f, stream_tail(s)))	2✔
114	: stream_filter(f, stream_tail(s));
115	}
116
117	/**
118	* Applies the given function to every single element of the stream.
119	*
120	* NOT lazy: This function evaluates the entire stream.
121	*/
122	export function stream_for_each<T>(f: (arg: T) => void, s: Stream<T>) {
123	if (is_null(s)) {	4✔
124	return true;	2✔
125	} else {
126	callWithoutMetadata(f, head(s));	2✔
127	return stream_for_each(f, stream_tail(s));	2✔
128	}
129	}
130
131	/**
132	* Accumulate applies given operation op to elements of a stream
133	* in a right-to-left order, first apply op to the last element
134	* and an initial element, resulting in r1, then to the second-last
135	* element and r1, resulting in r2, etc, and finally to the first element
136	* and r_n-1, where n is the length of the list. `accumulate(op,zero,list(1,2,3))`
137	* results in `op(1, op(2, op(3, zero)))`.
138	*
139	* NOT lazy: This function evaluates the entire stream when called
140	*/
141	export function stream_accumulate<T, U>(
142	f: (each: T, result: U) => U,
143	initial: U,
144	stream: Stream<T>,
145	): U {
146	let res = initial;	×
147	let entry = stream;	×
148
149	while (!is_null(entry)) {	×
150	const element = head(entry);	×
NEW 151	res = callWithoutMetadata(f, element, res);	×
152	entry = stream_tail(entry);	×
153	}
154
155	return res;	×
156	}
157
158	/**
159	* Returns the length of the stream.
160	*
161	* NOT lazy: The function must evaluate the entire stream
162	*/
163	export function stream_length(s: Stream<unknown>): number {
164	return stream_accumulate((_, res) => res + 1, 0, s);	×
165	}
166
167	/**
168	* Returns the nth element of the stream.
169	*
170	* NOT lazy: The stream must be evaluated up to the nth element.
171	*/
172	export function stream_ref<T>(s: Stream<T>, n: number): T {
173	for (let i = 0; i < n && !is_null(s); i++) {	1✔
174	s = stream_tail(s);	3✔
175	}
176
177	if (is_null(s)) {	1!
178	throw new GeneralRuntimeError(`${stream_ref.name}: Index ${n} out of bounds!`);	×
179	}
180
181	return head(s);	1✔
182	}
183
184	/**
185	* Appends a stream to the end of another stream.
186	*
187	* @param lhs Stream to append to
188	* @param rhs Stream to be appending
189	*
190	* Lazy: `rhs` is only evaluated after `lhs` is fully evaluated. This
191	* does mean that if `lhs` is infinite elements from `rhs` will never be evaluated.
192	*/
193	export function stream_append<T>(lhs: Stream<T>, rhs: Stream<T>): Stream<T> {
194	return is_null(lhs) ? rhs : pair(head(lhs), () => stream_append(stream_tail(lhs), rhs));	8✔
195	}
196
197	/**
198	* Converts the given stream to a {@link List\|list}.
199	*
200	* NOT Lazy: Function has to evaluate every element of the stream
201	* to populate the resulting list
202	*/
203	export function stream_to_list<T>(stream: Stream<T>): List<T> {
204	return is_null(stream) ? null : pair(head(stream), stream_to_list(stream_tail(stream)));	17✔
205	}

source-academy / js-slang / 28319975315

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous