File: lib.rs

package info (click to toggle)
rust-ord-subset 3.1.1-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, trixie
  • size: 172 kB
  • sloc: makefile: 4
file content (487 lines) | stat: -rw-r--r-- 13,376 bytes parent folder | download
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
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
#![cfg_attr(feature = "cargo-clippy", allow(float_cmp, match_wild_err_arm))]
extern crate ord_subset;
extern crate core;
use ord_subset::OrdSubsetIterExt;
use ord_subset::OrdSubsetSliceExt;
use ord_subset::OrdSubset;
use ord_subset::OrdVar;

use std::f64::INFINITY as INF;
use std::f64::NAN;

const N: usize = 32;
const N_NO_NAN: usize = 30;

const TEST_ARRAY: [f64; N] =
	[1.0,  7.0,  26.0,  INF,  NAN,  0.0, 14.0, 17.0,
	27.0, 13.0,  10.0,  3.0,  NAN, 25.0,  9.0, 20.0,
	16.0,  8.0,  -INF,  4.0,  2.0, 22.0, 18.0, 21.0,
	15.0,  6.0,  24.0, 19.0, 12.0, 11.0,  5.0, 23.0];

// subset of TEST_ARRAY
const TEST_ARRAY_NO_NAN: [f64; N_NO_NAN] =
	[1.0,  7.0,  26.0,  INF,        0.0, 14.0, 17.0,
	27.0, 13.0,  10.0,  3.0,       25.0,  9.0, 20.0,
	16.0,  8.0,  -INF,  4.0,  2.0, 22.0, 18.0, 21.0,
	15.0,  6.0,  24.0, 19.0, 12.0, 11.0,  5.0, 23.0];

const SORTED_TEST_ARRAY: [f64; N] =
	[-INF, 0.0,  1.0,  2.0,  3.0,  4.0,  5.0,  6.0,
	 7.0,  8.0,  9.0, 10.0, 11.0, 12.0, 13.0, 14.0,
	15.0, 16.0, 17.0, 18.0, 19.0, 20.0, 21.0, 22.0,
	23.0, 24.0, 25.0, 26.0, 27.0,  INF,  NAN,  NAN];

const SORTED_TEST_ARRAY_NO_NAN: [f64; N_NO_NAN] =
	[-INF, 0.0,  1.0,  2.0,  3.0,  4.0,  5.0,  6.0,
	 7.0,  8.0,  9.0, 10.0, 11.0, 12.0, 13.0, 14.0,
	15.0, 16.0, 17.0, 18.0, 19.0, 20.0, 21.0, 22.0,
	23.0, 24.0, 25.0, 26.0, 27.0, INF             ];


#[derive(PartialEq, PartialOrd, Clone, Copy)]
struct NotOrdSub();
#[derive(PartialEq, PartialOrd, Clone, Copy)]
struct OrdSub();

impl OrdSubset for OrdSub {
	fn is_outside_order(&self) -> bool {
		true
	}
}

// ---------------------------- iter ext methods -------------------------------

#[test]
fn ord_subset_max() {
	let arr = [2.0, 3.0, 5.0, std::f64::NAN];
	let max = arr.iter().ord_subset_max().unwrap();
	assert_eq!(&5.0, max);
}

#[test]
fn ord_subset_max_by() {
	let arr = [2.0, 3.0, 5.0, std::f64::NAN];
	let max_by = arr.iter().ord_subset_max_by_key(|num| num.recip()).unwrap();
	assert_eq!(&2.0, max_by);
}

#[test]
fn ord_subset_min() {
	let arr = [2.0, 3.0, 5.0, std::f64::NAN];
	let min = arr.iter().ord_subset_min().unwrap();
	assert_eq!(&2.0, min);
}

#[test]
fn ord_subset_min_by() {
	let arr = [2.0, 3.0, 5.0, std::f64::NAN];
	let min_by = arr.iter().ord_subset_min_by_key(|num| num.recip()).unwrap();
	assert_eq!(&5.0, min_by);
}

// This is a compile time test. It can't fail at runtime.
// The referenced functions must accept iters of values, that are not OrdSubset
// if the closure produces OrdSubset values
#[allow(unused)]
fn ord_subset_min_or_max_by_key() {
	let array: [NotOrdSub; 0] = [];
	array.iter().ord_subset_min_by_key(|_| 0.0);
	array.iter().ord_subset_max_by_key(|_| 0.0);
}

// ---------------------------slice ext methods --------------------------------
// ----------------------------- stable sorts ----------------------------------

#[test]
#[cfg(feature="std")]
fn sort() {
	let mut array = TEST_ARRAY;
	array.ord_subset_sort();
	assert_eq!(&array[0..N_NO_NAN], &SORTED_TEST_ARRAY_NO_NAN);
}

#[test]
#[cfg(feature="std")]
fn sort_rev() {
	let mut array = TEST_ARRAY;
	array.ord_subset_sort_rev();

	let mut rev_sorted_array = SORTED_TEST_ARRAY_NO_NAN;
	rev_sorted_array.reverse();

	assert_eq!(&array[0..N_NO_NAN], &rev_sorted_array);
}

#[test]
#[cfg(feature="std")]
fn sort_by_key() {
	fn key_function(el: &f64) -> f64 {
		(el - 13.0).recip()
	}
	let mut array = TEST_ARRAY;
	array.ord_subset_sort_by_key(key_function);
	let mut std_sorted_array = TEST_ARRAY_NO_NAN;
	std_sorted_array.sort_by_key(|num| OrdVar::new(key_function(num)));
	assert_eq!(&array[..N_NO_NAN], &std_sorted_array);
}

// ----------------------------- unstable sorts --------------------------------

#[test]
fn sort_unstable() {
	let mut array = TEST_ARRAY;
	array.ord_subset_sort_unstable();
	assert_eq!(&array[0..N_NO_NAN], &SORTED_TEST_ARRAY_NO_NAN);
}

#[test]
fn sort_unstable_rev() {
	let mut array = TEST_ARRAY;
	array.ord_subset_sort_unstable_rev();

	let mut rev_sorted_array = SORTED_TEST_ARRAY_NO_NAN;
	rev_sorted_array.reverse();

	assert_eq!(&array[0..N_NO_NAN], &rev_sorted_array);
}

#[test]
fn sort_unstable_by_key() {
	fn key_function(el: &f64) -> f64 {
		(el - 13.0).recip()
	}
	let mut array = TEST_ARRAY;
	array.ord_subset_sort_unstable_by_key(key_function);
	let mut std_sorted_array = TEST_ARRAY_NO_NAN;
	std_sorted_array.sort_unstable_by_key(|num| OrdVar::new(key_function(num)));
	assert_eq!(&array[..N_NO_NAN], &std_sorted_array);
}

// ---------------------------- binary searches --------------------------------

#[test]
fn binary_search() {
	let array = SORTED_TEST_ARRAY;
	for (i, num) in array.iter().enumerate().take(N_NO_NAN) {
		assert_eq!(array.ord_subset_binary_search(num), Ok(i));
	}
}

#[test]
fn binary_search_rev() {
	let mut array = TEST_ARRAY;
	array.ord_subset_sort_unstable_rev();
	for (i, num) in array.iter().enumerate().take(N_NO_NAN) {
		assert_eq!(array.ord_subset_binary_search_rev(num), Ok(i));
	}
}

#[test]
fn binary_search_by_key() {
	fn key_function(el: &f64) -> f64 {
		(el - 13.0).recip()
	}
	let mut array = TEST_ARRAY;
	array.ord_subset_sort_unstable_by_key(key_function);
	for num in array.iter().take(N_NO_NAN) {
		let key = key_function(num);
		match array.ord_subset_binary_search_by_key(&key, key_function) {
			Err(_) => panic!("Did not find correct location of element"),
			Ok(pos) => assert_eq!(key_function(&array[pos]), key),
		}
	}
}

// ------ binary search error cases ------

#[test]
fn binary_search_err() {
	let array = SORTED_TEST_ARRAY;
	for (i, num) in array.iter()
		.enumerate()
		.filter(|&(_, num)| num.is_finite())
	{
		let new_num = num + 0.5;
		assert_eq!(array.ord_subset_binary_search(&new_num), Err(i+1));
	}
}

#[test]
fn binary_search_rev_err() {
	let mut array = TEST_ARRAY;
	array.ord_subset_sort_unstable_rev();
	for (i, num) in array.iter()
		.enumerate()
		.filter(|&(_, num)| num.is_finite())
	{
		let new_num = num + 0.5;
		assert_eq!(array.ord_subset_binary_search_rev(&new_num), Err(i));
	}
}

#[test]
fn binary_search_by_key_err() {
	fn key_function(el: &f64) -> f64 {
		(el - 13.0).recip()
	}
	let mut array = TEST_ARRAY;
	array.ord_subset_sort_unstable_by_key(key_function);
	for num in array.iter().take(N_NO_NAN) {
		let key_diff = key_function(&(num+0.01))*1.01 + 0.01;
		let pos = array.ord_subset_binary_search_by_key(&key_diff, key_function);
		let pos_std = (&array[..N_NO_NAN]).binary_search_by_key(
			&OrdVar::new(key_diff),
			|num| OrdVar::new(key_function(num))
		);
		match (pos, pos_std) {
			(Err(pos), Err(pos_std)) => assert!(pos == pos_std),
			// the commented out match branch is also valid behaviour
			// but this function is supposed to test as many error cases as possible
			// by choosing key_diff the right way
			//(Ok(pos), Ok(pos_std)) => {
			//	let key1 = key_function(&array[pos]);
			//	let key2 = key_function(&array[pos_std]);
			//	assert!(key1 == key2);
			//},
			_ => panic!("Inconsistency between this library's and std's binary_search_by_key"),
		}
	}
}

// -------------------- compile time implementation tests ----------------------

// check that slices, arrays and vecs as well as references
// all implement the OrdSubsetSliceExt trait, no matter the mutability.
#[allow(unused)]
fn ord_subset_slice_ext_impl_test() {
	fn foo<T: OrdSubsetSliceExt<U> + AsRef<[U]>, U: OrdSubset + Clone>(as_slice: T) {
		// would panic, good thing it doesn't run
		let element: &U = as_slice.as_ref().first().unwrap();
		as_slice.ord_subset_binary_search(element);
		as_slice.ord_subset_binary_search_rev(element);
		as_slice.ord_subset_binary_search_by_key(element, |_| element.clone());
		as_slice.ord_subset_binary_search_by(|_| std::cmp::Ordering::Equal);
	}

	let mut vec: Vec<OrdSub> = vec![];
	let mut arr: [OrdSub; 0] = [];

	// &vec
	foo(&vec);
	foo(&mut vec);

	// &array
	foo(&arr);
	foo(&mut arr);

	// &slice
	foo(&arr[..]);
	foo(&mut arr[..]);

	// &&slice
	foo(&&arr[..]);
	foo(&mut &mut arr[..]);
	foo(& &mut arr[..]);

	// owned
	foo(vec);
	foo(arr);
}

// check that mutable vecs, arrays and slices are all sortable
#[allow(unused)]
fn ord_subset_mut_slice_ext_impl_test() {
	fn sortable<T, U>(mut as_slice: T)
		where T: OrdSubsetSliceExt<U> + AsMut<[U]>,
		      U: OrdSubset,
	{
		#[cfg(feature="std")]
		as_slice.ord_subset_sort();
		#[cfg(feature="std")]
		as_slice.ord_subset_sort_rev();
		#[cfg(feature="std")]
		as_slice.ord_subset_sort_by(|_, _| core::cmp::Ordering::Equal);
		#[cfg(feature="std")]
		as_slice.ord_subset_sort_by_key(|_| 0.0);

		as_slice.ord_subset_sort_unstable();
		as_slice.ord_subset_sort_unstable_rev();
		as_slice.ord_subset_sort_unstable_by(|_, _| core::cmp::Ordering::Equal);
		as_slice.ord_subset_sort_unstable_by_key(|_| 0.0);
	}

	let mut vec: Vec<OrdSub> = vec![];
	let mut arr: [OrdSub; 0] = [];

	sortable(&mut vec);
	sortable(&mut arr);
	sortable(&mut arr[..]);
	sortable(&mut &mut arr[..]);
	// owned
	sortable(vec);
	sortable(arr);
}

// check that slices, arrays and vecs as well as references of non-OrdSubset items
// all implement the OrdSubsetSliceExt trait and allow binary_search_by_key.
#[allow(unused)]
fn non_ord_subset_slice_ext_impl_test() {
	/*
	fn foo<T: OrdSubsetSliceExt<U> + AsRef<[U]>, U: Clone>(as_slice: T) {
		// would panic, good thing it doesn't run
		let element: &U = as_slice.as_ref().first().unwrap();
		as_slice.ord_subset_binary_search(element);
		as_slice.ord_subset_binary_search_rev(element);
		as_slice.ord_subset_binary_search_by_key(element, |_| element.clone());
		as_slice.ord_subset_binary_search_by(|_| std::cmp::Ordering::Equal);
	}
	*/
	fn foo<T: OrdSubsetSliceExt<U> + AsRef<[U]>, U>(as_slice: T) {
		let key = OrdSub();
		as_slice.ord_subset_binary_search_by_key(&key, |_| key);
	}

	let mut vec: Vec<NotOrdSub> = vec![];
	let mut arr: [NotOrdSub; 0] = [];

	// &vec
	foo(&vec);
	foo(&mut vec);

	// &array
	foo(&arr);
	foo(&mut arr);

	// &slice
	foo(&arr[..]);
	foo(&mut arr[..]);

	// &&slice
	foo(&&arr[..]);
	foo(&mut &mut arr[..]);
	foo(& &mut arr[..]);

	// owned
	foo(vec);
	foo(arr);
}

// check that mutable vecs, arrays and slices of non-OrdSubset types are all sortable by key
#[allow(unused)]
fn non_ord_subset_mut_slice_ext_impl_test() {
	fn sortable<T, U>(mut as_slice: T)
		where T: OrdSubsetSliceExt<U> + AsMut<[U]>,
	{
		let key = OrdSub();

		#[cfg(feature="std")]
		as_slice.ord_subset_sort_by_key(|_| key);

		as_slice.ord_subset_sort_unstable_by_key(|_| key);
	}

	let mut vec: Vec<NotOrdSub> = vec![];
	let mut arr: [NotOrdSub; 0] = [];

	sortable(&mut vec);
	sortable(&mut arr);
	sortable(&mut arr[..]);
	sortable(&mut &mut arr[..]);
	// owned
	sortable(vec);
	sortable(arr);
}

// std-library bug: https://github.com/rust-lang/rust/issues/34683
// caused valid code not to compile due to elided lifetime parameters being too strict
// this test is a compile test, it can't fail at runtime
#[test]
fn binary_search_lifetime() {
	#[derive(Debug)]
	struct Foo {
    	property: f32,
	}

    let xs = vec![
        Foo { property: 1. },
        Foo { property: 2. },
        Foo { property: 3. },
    ];

    let _r = xs.ord_subset_binary_search_by_key(&2., |entry| entry.property);
}

#[cfg(feature="ops")]
use core::ops::{Add, Sub, Mul, Div, Rem,
	//BitAnd, BitOr, BitXor, Shl, Shr,
	Neg, //Not,
	AddAssign, SubAssign, MulAssign, DivAssign, RemAssign,
	//BitAndAssign, BitOrAssign, BitXorAssign, ShlAssign, ShrAssign,
};

#[test]
#[cfg(feature="ops")]
fn ops_correctness_test() {
	let infix_ops = [
		Add::add, Sub::sub, Mul::mul, Div::div, Rem::rem,
		//BitAnd::bitand, BitOr::bitor, BitXor::bitxor, Shl::shl, Shr::shr
	];

	let unary_ops = [
		Neg::neg,
		//Not::not
	];
	let assign_ops = [
		AddAssign::add_assign, SubAssign::sub_assign, MulAssign::mul_assign, DivAssign::div_assign, RemAssign::rem_assign,
		//BitAndAssign::bitand_assign, BitOrAssign::bitor_assign, BitXorAssign::bitxor_assign,
		//ShlAssign::shl_assign, ShrAssign::shr_assign
	];

	// same functions but for OrdVar variables
	let infix_ops_ordvar = [
		Add::add, Sub::sub, Mul::mul, Div::div, Rem::rem,
		//BitAnd::bitand, BitOr::bitor, BitXor::bitxor, Shl::shl, Shr::shr
	];

	let unary_ops_ordvar = [
		Neg::neg,
		//Not::not
	];

	let assign_ops_ordvar = [
		AddAssign::add_assign, SubAssign::sub_assign, MulAssign::mul_assign, DivAssign::div_assign, RemAssign::rem_assign,
		//BitAndAssign::bitand_assign, BitOrAssign::bitor_assign, BitXorAssign::bitxor_assign,
		//ShlAssign::shl_assign, ShrAssign::shr_assign
	];

	// skip 0, can't divide by it
	let nums = (-10..0).chain(1..11i32).map(|n| n as f64).collect::<Vec<_>>();
	let combinations = nums.iter().flat_map(|&n1| nums.iter().map(move |&n2| (n1, n2)));

	for (num1, num2) in combinations {
		// infix ops
		for (op, op_ordvar) in infix_ops.iter().zip(infix_ops_ordvar.iter()) {
			let res = op(num1, num2);
			let res2 = op_ordvar(OrdVar::new(num1), num2);
			//let res2 = op_ordvar(num1, num2);
			assert!(res == res2.into_inner())
		}

		// unary ops
		for (op, op_ordvar) in unary_ops.iter().zip(unary_ops_ordvar.iter()) {
			let res = op(num1);
			let res2 = op_ordvar(OrdVar::new(num1));
			//let res2 = op_ordvar(num1, num2);
			assert!(res == res2.into_inner())
		}

		// assign ops
		for (op, op_ordvar) in assign_ops.iter().zip(assign_ops_ordvar.iter()) {
			let mut num1 = num1;
			let mut ordvar = OrdVar::new(num1);
			op(&mut num1, num2);
			op_ordvar(&mut ordvar, num2);
			assert!(num1 == ordvar.into_inner())
		}
	}
}