pupil 1.0.0

Arithmetic expression evaluator.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
use super::*;

pub fn id(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	let &mut [value] = vals else {
		return Err(ErrorKind::BadArgument);
	};
	Ok(value)
}
pub fn sign(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	let &mut [value] = vals else {
		return Err(ErrorKind::BadArgument);
	};
	Ok(value.signum())
}
pub fn add(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	Ok(vals.iter().fold(0f64, |acc, x| acc + x))
}
pub fn sub(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	match vals {
		&mut [value] => Ok(-value),
		&mut [lhs, rhs] => Ok(lhs - rhs),
		_ => Err(ErrorKind::BadArgument),
	}
}
pub fn mul(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	Ok(vals.iter().fold(1f64, |acc, x| acc * x))
}
pub fn div(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	let &mut [lhs, rhs] = vals else {
		return Err(ErrorKind::BadArgument);
	};
	Ok(lhs / rhs)
}
pub fn rem(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	let &mut [lhs, rhs] = vals else {
		return Err(ErrorKind::BadArgument);
	};
	Ok(lhs % rhs)
}
pub fn pow(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	let &mut [base, exp] = vals else {
		return Err(ErrorKind::BadArgument);
	};
	Ok(base.powf(exp))
}
pub fn fract(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	let &mut [value] = vals else {
		return Err(ErrorKind::BadArgument);
	};
	Ok(value.fract())
}
pub fn floor(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	let &mut [value] = vals else {
		return Err(ErrorKind::BadArgument);
	};
	Ok(value.floor())
}
pub fn ceil(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	let &mut [value] = vals else {
		return Err(ErrorKind::BadArgument);
	};
	Ok(value.ceil())
}
pub fn trunc(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	let &mut [value] = vals else {
		return Err(ErrorKind::BadArgument);
	};
	Ok(value.trunc())
}
pub fn round(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	let &mut [value] = vals else {
		return Err(ErrorKind::BadArgument);
	};
	Ok(value.round())
}
pub fn abs(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	let &mut [value] = vals else {
		return Err(ErrorKind::BadArgument);
	};
	Ok(value.abs())
}
pub fn sqr(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	let &mut [value] = vals else {
		return Err(ErrorKind::BadArgument);
	};
	Ok(value * value)
}
pub fn cube(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	let &mut [value] = vals else {
		return Err(ErrorKind::BadArgument);
	};
	Ok(value * value * value)
}
pub fn sqrt(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	let &mut [value] = vals else {
		return Err(ErrorKind::BadArgument);
	};
	Ok(value.sqrt())
}
pub fn cbrt(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	let &mut [value] = vals else {
		return Err(ErrorKind::BadArgument);
	};
	Ok(value.cbrt())
}
pub fn isinf(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	let &mut [value] = vals else {
		return Err(ErrorKind::BadArgument);
	};
	if value.is_infinite() { Ok(1f64) } else { Ok(0f64) }
}
pub fn isnan(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	let &mut [value] = vals else {
		return Err(ErrorKind::BadArgument);
	};
	if value.is_nan() { Ok(1f64) } else { Ok(0f64) }
}
pub fn min(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	Ok(vals.iter().fold(Value::INFINITY, |acc, &x| acc.min(x)))
}
pub fn max(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	Ok(vals.iter().fold(Value::NEG_INFINITY, |acc, &x| acc.max(x)))
}
pub fn clamp(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	let &mut [value, min, max] = vals else {
		return Err(ErrorKind::BadArgument);
	};
	Ok(value.max(min).min(max))
}
pub fn eq(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	match vals {
		&mut [lhs, rhs] => if lhs == rhs { Ok(1f64) } else { Ok(0f64) },
		&mut [lhs, rhs, tolerance] => if (lhs - rhs).abs() <= tolerance.abs() { Ok(1f64) } else { Ok(0f64) },
		_ => Err(ErrorKind::BadArgument),
	}
}
pub fn ne(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	match vals {
		&mut [lhs, rhs] => if lhs != rhs { Ok(1f64) } else { Ok(0f64) },
		&mut [lhs, rhs, tolerance] => if (lhs - rhs).abs() > tolerance.abs() { Ok(1f64) } else { Ok(0f64) },
		_ => Err(ErrorKind::BadArgument),
	}
}
pub fn lt(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	let &mut [lhs, rhs] = vals else {
		return Err(ErrorKind::BadArgument);
	};
	if lhs < rhs { Ok(1f64) } else { Ok(0f64) }
}
pub fn le(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	let &mut [lhs, rhs] = vals else {
		return Err(ErrorKind::BadArgument);
	};
	if lhs <= rhs { Ok(1f64) } else { Ok(0f64) }
}
pub fn gt(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	let &mut [lhs, rhs] = vals else {
		return Err(ErrorKind::BadArgument);
	};
	if lhs > rhs { Ok(1f64) } else { Ok(0f64) }
}
pub fn ge(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	let &mut [lhs, rhs] = vals else {
		return Err(ErrorKind::BadArgument);
	};
	if lhs >= rhs { Ok(1f64) } else { Ok(0f64) }
}
pub fn all(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	for &val in vals.iter() {
		if val == 0f64 {
			return Ok(0f64);
		}
	}
	Ok(1f64)
}
pub fn any(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	for &val in vals.iter() {
		if val != 0f64 {
			return Ok(1f64);
		}
	}
	Ok(0f64)
}
pub fn not(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	let &mut [value] = vals else {
		return Err(ErrorKind::BadArgument);
	};
	Ok(1.0 - value.signum().abs())
}
pub fn select(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	if vals.len() < 2 {
		return Err(ErrorKind::BadArgument);
	}
	let index = vals[0].floor() as i32 as usize;
	let choices = &vals[1..];
	choices.get(index).cloned().ok_or(ErrorKind::BadArgument)
}
pub fn step(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	let &mut [edge, value] = vals else {
		return Err(ErrorKind::BadArgument);
	};
	if value < edge { Ok(0f64) } else { Ok(1f64) }
}
pub fn smoothstep(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	let &mut [x] = vals else {
		return Err(ErrorKind::BadArgument);
	};
	if x <= 0f64 {
		Ok(0f64)
	}
	else if x >= 1f64 {
		Ok(1f64)
	}
	else {
		Ok(x * x * (3f64 - 2f64 * x))
	}
}
pub fn smootherstep(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	let &mut [x] = vals else {
		return Err(ErrorKind::BadArgument);
	};
	if x <= 0f64 {
		Ok(0f64)
	}
	else if x >= 1f64 {
		Ok(1f64)
	}
	else {
		Ok(x * x * x * (x * (x * 6f64 - 15f64) + 10f64))
	}
}
pub fn exp(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	let &mut [value] = vals else {
		return Err(ErrorKind::BadArgument);
	};
	Ok(value.exp())
}
pub fn exp2(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	let &mut [value] = vals else {
		return Err(ErrorKind::BadArgument);
	};
	Ok(value.exp2())
}
pub fn expm1(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	let &mut [value] = vals else {
		return Err(ErrorKind::BadArgument);
	};
	Ok(value.exp_m1())
}
pub fn ln(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	let &mut [value] = vals else {
		return Err(ErrorKind::BadArgument);
	};
	Ok(value.ln())
}
pub fn log(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	let &mut [value, base] = vals else {
		return Err(ErrorKind::BadArgument);
	};
	Ok(value.log(base))
}
pub fn log2(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	let &mut [value] = vals else {
		return Err(ErrorKind::BadArgument);
	};
	Ok(value.log2())
}
pub fn log10(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	let &mut [value] = vals else {
		return Err(ErrorKind::BadArgument);
	};
	Ok(value.log10())
}
pub fn ln1p(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	let &mut [value] = vals else {
		return Err(ErrorKind::BadArgument);
	};
	Ok(value.ln_1p())
}
pub fn mean(env: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	if vals.is_empty() {
		return Err(ErrorKind::BadArgument);
	}
	Ok(add(env, vals)? / vals.len() as Value)
}
pub fn median(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	if vals.is_empty() {
		return Err(ErrorKind::BadArgument);
	}
	vals.sort_unstable_by(f64::total_cmp);
	// Pick the median value
	let len = vals.len();
	if len & 1 == 0 {
		Ok((vals[(len >> 1) - 1] + vals[len >> 1]) * 0.5)
	}
	else {
		Ok(vals[len >> 1])
	}
}
pub fn range(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	let (mut min, mut max) = (Value::INFINITY, Value::NEG_INFINITY);
	for &val in vals.iter() {
		if !(val >= min) {
			min = val;
		}
		else if !(val <= max) {
			max = val;
		}
	}
	Ok(max - min)
}
pub fn var(env: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	let mean = mean(env, vals)?;
	Ok(vals.iter().fold(0f64, |acc, &x| acc + (x - mean) * (x - mean)) / vals.len() as Value)
}
pub fn stdev(env: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	Ok(var(env, vals)?.sqrt())
}
pub fn deg(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	let &mut [radians] = vals else {
		return Err(ErrorKind::BadArgument);
	};
	Ok(radians.to_degrees())
}
pub fn rad(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	let &mut [degrees] = vals else {
		return Err(ErrorKind::BadArgument);
	};
	Ok(degrees.to_radians())
}
pub fn sin(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	let &mut [radians] = vals else {
		return Err(ErrorKind::BadArgument);
	};
	Ok(radians.sin())
}
pub fn cos(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	let &mut [radians] = vals else {
		return Err(ErrorKind::BadArgument);
	};
	Ok(radians.cos())
}
pub fn tan(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	let &mut [radians] = vals else {
		return Err(ErrorKind::BadArgument);
	};
	Ok(radians.tan())
}
pub fn asin(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	let &mut [value] = vals else {
		return Err(ErrorKind::BadArgument);
	};
	Ok(value.asin())
}
pub fn acos(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	let &mut [value] = vals else {
		return Err(ErrorKind::BadArgument);
	};
	Ok(value.acos())
}
pub fn atan(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	let &mut [value] = vals else {
		return Err(ErrorKind::BadArgument);
	};
	Ok(value.atan())
}
pub fn atan2(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	let &mut [this, other] = vals else {
		return Err(ErrorKind::BadArgument);
	};
	Ok(this.atan2(other))
}
pub fn sinh(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	let &mut [value] = vals else {
		return Err(ErrorKind::BadArgument);
	};
	Ok(value.sinh())
}
pub fn cosh(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	let &mut [value] = vals else {
		return Err(ErrorKind::BadArgument);
	};
	Ok(value.cosh())
}
pub fn tanh(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	let &mut [value] = vals else {
		return Err(ErrorKind::BadArgument);
	};
	Ok(value.tanh())
}
pub fn asinh(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	let &mut [value] = vals else {
		return Err(ErrorKind::BadArgument);
	};
	Ok(value.asinh())
}
pub fn acosh(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	let &mut [value] = vals else {
		return Err(ErrorKind::BadArgument);
	};
	Ok(value.acosh())
}
pub fn atanh(_: &dyn Env, vals: &mut [Value]) -> Result<Value, ErrorKind> {
	let &mut [value] = vals else {
		return Err(ErrorKind::BadArgument);
	};
	Ok(value.atanh())
}

#[test]
fn stats() {
	let env = BasicEnv::default();
	assert_eq!(mean(&env, &mut [1.0, 2.0, 4.0, -1.0]), Ok(1.5));
	assert_eq!(median(&env, &mut [2.0, 1.0, 4.0]), Ok(2.0));
	assert_eq!(median(&env, &mut [8.0, 4.0]), Ok(6.0));
	assert_eq!(range(&env, &mut [1.0, 7.0, 4.5]), Ok(6.0));
	assert_eq!(var(&env, &mut [3.0, 4.0, 7.0, 10.0]), Ok(7.5));
	assert_eq!(stdev(&env, &mut [2.0, 4.0, 4.0, 4.0, 5.0, 5.0, 7.0, 9.0]), Ok(2.0));
}