permoot 0.2.1

General-purpose no_std permutation library
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

/// An invalid array or function representation was encountered
#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)]
pub enum InvalidArrFnRepr {
	/// The output (`value`) for the `input` is too large (should have been `<= max`)
	#[allow(missing_docs)]
	InvalidValue {
		input: usize,
		value: usize,
		max: usize,
	},
	/// The output (`value`) is associated to at least two different inputs
	#[allow(missing_docs)]
	RepeatedValue {
		first_input: usize,
		second_input: usize,
		value: usize,
	},
}

#[derive(Debug, Copy, Clone, Ord, PartialOrd, Eq, PartialEq, Hash)]
/// An location of any single value in [`Cycles`](crate::reprs::Cycles)
pub struct CycleElementLocation {
	/// The index of the cycle containing the value
	pub cycle_index: usize,
	/// The index of the value inside the cycle
	pub index: usize,
}

/// An invalid cycle representation was encountered
#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)]
pub enum InvalidCycleRepr {
	/// A too large `value` at `location` (should have been `<= max`)
	#[allow(missing_docs)]
	InvalidValue {
		location: CycleElementLocation,
		value: usize,
		max: usize,
	},
	/// The `value` appears in multiple locations (either in multiple cycles or multiple times in a single cycle)
	#[allow(missing_docs)]
	RepeatedValue {
		first_occurrence: CycleElementLocation,
		second_occurrence: CycleElementLocation,
		value: usize,
	},
}

/// An invalid swap representation was encountered
#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)]
pub enum InvalidSwapRepr {
	/// The left value of the swap at `index` is too large (should have been `<= max`)
	#[allow(missing_docs)]
	InvalidLeftValue {
		index: usize,
		value: usize,
		max: usize,
	},
	/// The right value of the swap at `index` is too large (should have been `<= max`)
	#[allow(missing_docs)]
	InvalidRightValue {
		index: usize,
		value: usize,
		max: usize,
	},
}

/// Tried to use a slice longer than `self.max` in the context of a permutation on `self.max` objects
#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)]
#[allow(missing_docs)]
pub struct TooLongSliceForPermutation {
	pub length: usize,
	pub max: usize,
}