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

use crate::{fun::Fun, Closure, OneOf3};

type UnionClosures<C1, C2, C3, In, Out> =
    OneOf3<Closure<C1, In, Out>, Closure<C2, In, Out>, Closure<C3, In, Out>>;

/// `ClosureOneOf3<C1, C2, C3, In, Out>` is a union of three closures:
///
/// * `Closure<C1, In, Out>`
/// * `Closure<C2, In, Out>`
/// * `Closure<C3, In, Out>`
///
/// This is useful when it is possible that the closure might capture and work with either of the three types of data `C1`, `C2` and `C3`.
///
/// It represents the transformation `In -> Out`.
///
/// Note that, unlike trait objects of fn-traits, `ClosureOneOf3` auto-implements `Clone` given that captured data variants are cloneable.
///
/// # Example
///
/// The example below illustrates the usage of the closure over two possible types of captures; however, ClosureOneOf3 is only a generalization of the below for three different capture types.
///
/// ```rust
/// use orx_closure::*;
/// use std::collections::HashSet;
///
/// type Node = usize; // for brevity
/// type Edge = (Node, Node); // for brevity
///
/// // captures either () or Vec<HashSet<Node>>
/// type PrecedenceClosure = ClosureOneOf2<(), Vec<HashSet<Node>>, Edge, bool>;
///
/// struct Precedence(PrecedenceClosure);
///
/// impl Precedence {
///     fn new_variant1(closure: Closure<(), Edge, bool>) -> Self {
///         Self(closure.into_oneof2_var1())
///     }
///     fn new_variant2(closure: Closure<Vec<HashSet<Node>>, Edge, bool>) -> Self {
///         Self(closure.into_oneof2_var2())
///     }
///
///     fn can_precede(&self, edge: Edge) -> bool {
///         self.0.call(edge)
///     }
/// }
///
/// let allow_all = Precedence::new_variant1(Capture(()).fun(|_, _| true));
/// assert_eq!(allow_all.can_precede((0, 1)), true);
/// assert_eq!(allow_all.can_precede((10, 21)), true);
///
/// let disallow_all = Precedence::new_variant1(Capture(()).fun(|_, _| false));
/// assert_eq!(disallow_all.can_precede((0, 1)), false);
/// assert_eq!(disallow_all.can_precede((10, 21)), false);
///
/// let allowed: Vec<HashSet<Node>> = vec![
///     HashSet::from_iter([1, 2, 3].into_iter()),
///     HashSet::from_iter([2, 3].into_iter()),
///     HashSet::from_iter([3].into_iter()),
///     HashSet::from_iter([0].into_iter()),
/// ];
/// let from_allowed = Precedence::new_variant2(
///     Capture(allowed).fun(|allowed, edge| allowed[edge.0].contains(&edge.1)),
/// );
/// assert_eq!(from_allowed.can_precede((1, 3)), true);
/// assert_eq!(from_allowed.can_precede((2, 1)), false);
/// ```
#[derive(Clone, Debug)]
pub struct ClosureOneOf3<C1, C2, C3, In, Out> {
    closure: UnionClosures<C1, C2, C3, In, Out>,
}
impl<C1, C2, C3, In, Out> ClosureOneOf3<C1, C2, C3, In, Out> {
    /// Calls the closure with the given `input`.
    ///
    /// *The example below illustrates the usage of the closure over two possible types of captures; however, ClosureOneOf3 is only a generalization of the below for three different capture types.*
    ///
    /// # Example
    ///
    /// ```rust
    /// use orx_closure::*;
    /// use std::collections::HashSet;
    ///
    /// type Node = usize; // for brevity
    /// type Edge = (Node, Node); // for brevity
    ///
    /// // captures either () or Vec<HashSet<Node>>
    /// type PrecedenceClosure = ClosureOneOf2<(), Vec<HashSet<Node>>, Edge, bool>;
    ///
    /// struct Precedence(PrecedenceClosure);
    ///
    /// impl Precedence {
    ///     fn new_variant1(closure: Closure<(), Edge, bool>) -> Self {
    ///         Self(closure.into_oneof2_var1())
    ///     }
    ///     fn new_variant2(closure: Closure<Vec<HashSet<Node>>, Edge, bool>) -> Self {
    ///         Self(closure.into_oneof2_var2())
    ///     }
    ///
    ///     fn can_precede(&self, edge: Edge) -> bool {
    ///         self.0.call(edge)
    ///     }
    /// }
    ///
    /// let allow_all = Precedence::new_variant1(Capture(()).fun(|_, _| true));
    /// assert_eq!(allow_all.can_precede((0, 1)), true);
    /// assert_eq!(allow_all.can_precede((10, 21)), true);
    ///
    /// let disallow_all = Precedence::new_variant1(Capture(()).fun(|_, _| false));
    /// assert_eq!(disallow_all.can_precede((0, 1)), false);
    /// assert_eq!(disallow_all.can_precede((10, 21)), false);
    ///
    /// let allowed: Vec<HashSet<Node>> = vec![
    ///     HashSet::from_iter([1, 2, 3].into_iter()),
    ///     HashSet::from_iter([2, 3].into_iter()),
    ///     HashSet::from_iter([3].into_iter()),
    ///     HashSet::from_iter([0].into_iter()),
    /// ];
    /// let from_allowed = Precedence::new_variant2(
    ///     Capture(allowed).fun(|allowed, edge| allowed[edge.0].contains(&edge.1)),
    /// );
    /// assert_eq!(from_allowed.can_precede((1, 3)), true);
    /// assert_eq!(from_allowed.can_precede((2, 1)), false);
    /// ```
    #[inline(always)]
    pub fn call(&self, input: In) -> Out {
        match &self.closure {
            OneOf3::Variant1(fun) => fun.call(input),
            OneOf3::Variant2(fun) => fun.call(input),
            OneOf3::Variant3(fun) => fun.call(input),
        }
    }

    /// Returns a reference to the captured data.
    #[inline(always)]
    pub fn captured_data(&self) -> OneOf3<&C1, &C2, &C3> {
        match &self.closure {
            OneOf3::Variant1(x) => OneOf3::Variant1(x.captured_data()),
            OneOf3::Variant2(x) => OneOf3::Variant2(x.captured_data()),
            OneOf3::Variant3(x) => OneOf3::Variant3(x.captured_data()),
        }
    }

    /// Consumes the closure and returns back the captured data.
    ///
    /// *The example below illustrates the usage of the closure over two possible types of captures; however, ClosureOneOf3 is only a generalization of the below for three different capture types.*
    ///
    /// # Example
    ///
    /// ```rust
    /// use orx_closure::*;
    /// use std::collections::HashSet;
    ///
    /// type Node = usize; // for brevity
    /// type Edge = (Node, Node); // for brevity
    ///
    /// // captures either () or Vec<HashSet<Node>>
    /// type PrecedenceClosure = ClosureOneOf2<(), Vec<HashSet<Node>>, Edge, bool>;
    ///
    /// struct Precedence(PrecedenceClosure);
    ///
    /// impl Precedence {
    ///     fn new_variant1(closure: Closure<(), Edge, bool>) -> Self {
    ///         Self(closure.into_oneof2_var1())
    ///     }
    ///     fn new_variant2(closure: Closure<Vec<HashSet<Node>>, Edge, bool>) -> Self {
    ///         Self(closure.into_oneof2_var2())
    ///     }
    ///
    ///     fn can_precede(&self, edge: Edge) -> bool {
    ///         self.0.call(edge)
    ///     }
    /// }
    ///
    /// let allowed: Vec<HashSet<Node>> = vec![
    ///     HashSet::from_iter([1, 2, 3].into_iter()),
    ///     HashSet::from_iter([2, 3].into_iter()),
    ///     HashSet::from_iter([3].into_iter()),
    ///     HashSet::from_iter([0].into_iter()),
    /// ];
    /// let from_allowed = Precedence::new_variant2(
    ///     Capture(allowed.clone()).fun(|allowed, edge| allowed[edge.0].contains(&edge.1)),
    /// );
    /// assert_eq!(from_allowed.can_precede((1, 3)), true);
    /// assert_eq!(from_allowed.can_precede((2, 1)), false);
    ///
    /// let data = from_allowed.0.into_captured_data();
    /// assert!(matches!(data, OneOf2::Variant2(allowed)));
    /// ```
    pub fn into_captured_data(self) -> OneOf3<C1, C2, C3> {
        match self.closure {
            OneOf3::Variant1(fun) => OneOf3::Variant1(fun.into_captured_data()),
            OneOf3::Variant2(fun) => OneOf3::Variant2(fun.into_captured_data()),
            OneOf3::Variant3(fun) => OneOf3::Variant3(fun.into_captured_data()),
        }
    }

    /// Returns the closure as an `impl Fn(In) -> Out` struct, allowing the convenience
    ///
    /// * to avoid the `call` method,
    /// * or pass the closure to functions accepting a function generic over the `Fn`.
    ///
    /// *The example below illustrates the usage of the closure over two possible types of captures; however, ClosureOneOf3 is only a generalization of the below for three different capture types.*
    ///
    /// # Example
    ///
    /// ```rust
    /// use orx_closure::*;
    /// use std::collections::HashSet;
    ///
    /// type Node = usize; // for brevity
    /// type Edge = (Node, Node); // for brevity
    ///
    /// // captures either () or Vec<HashSet<Node>>
    /// type PrecedenceClosure = ClosureOneOf2<(), Vec<HashSet<Node>>, Edge, bool>;
    ///
    /// struct Precedence(PrecedenceClosure);
    ///
    /// impl Precedence {
    ///     fn new_variant1(closure: Closure<(), Edge, bool>) -> Self {
    ///         Self(closure.into_oneof2_var1())
    ///     }
    ///     fn new_variant2(closure: Closure<Vec<HashSet<Node>>, Edge, bool>) -> Self {
    ///         Self(closure.into_oneof2_var2())
    ///     }
    ///
    ///     fn get_can_precede(&self) -> impl Fn(Edge) -> bool + '_ {
    ///         self.0.as_fn()
    ///     }
    /// }
    ///
    /// let allow_all = Precedence::new_variant1(Capture(()).fun(|_, _| true));
    /// let fun = allow_all.get_can_precede();
    /// assert_eq!(fun((0, 1)), true);
    /// assert_eq!(fun((10, 21)), true);
    ///
    /// let disallow_all = Precedence::new_variant1(Capture(()).fun(|_, _| false));
    /// let fun = disallow_all.get_can_precede();
    /// assert_eq!(fun((0, 1)), false);
    /// assert_eq!(fun((10, 21)), false);
    ///
    /// let allowed: Vec<HashSet<Node>> = vec![
    ///     HashSet::from_iter([1, 2, 3].into_iter()),
    ///     HashSet::from_iter([2, 3].into_iter()),
    ///     HashSet::from_iter([3].into_iter()),
    ///     HashSet::from_iter([0].into_iter()),
    /// ];
    /// let from_allowed = Precedence::new_variant2(
    ///     Capture(allowed).fun(|allowed, edge| allowed[edge.0].contains(&edge.1)),
    /// );
    /// let fun = from_allowed.get_can_precede();
    /// assert_eq!(fun((1, 3)), true);
    /// assert_eq!(fun((2, 1)), false);
    /// ```
    pub fn as_fn(&self) -> impl Fn(In) -> Out + '_ {
        move |x| self.call(x)
    }
}

impl<Capture, In, Out> Closure<Capture, In, Out> {
    /// Transforms `Closure<C1, In, Out>` into the more general `ClosureOneOf3<C1, C2, C3, In, Out>` for any `C2` and `C3`.
    ///
    /// *The example below illustrates the usage of the closure over two possible types of captures; however, ClosureOneOf3 is only a generalization of the below for three different capture types.*
    ///
    /// # Example
    ///
    /// ```rust
    /// use orx_closure::*;
    /// use std::collections::HashSet;
    ///
    /// type Node = usize; // for brevity
    /// type Edge = (Node, Node); // for brevity
    ///
    /// // captures either () or Vec<HashSet<Node>>
    /// type PrecedenceClosure = ClosureOneOf2<(), Vec<HashSet<Node>>, Edge, bool>;
    ///
    /// struct Precedence(PrecedenceClosure);
    ///
    /// impl Precedence {
    ///     fn new_variant1(closure: Closure<(), Edge, bool>) -> Self {
    ///         // transforms        : Closure<(), Edge, bool>
    ///         // into more general : ClosureOneOf2<(), Vec<HashSet<Node>>, Edge, bool>
    ///         Self(closure.into_oneof2_var1())
    ///     }
    /// }
    /// ```
    pub fn into_oneof3_var1<Var2, Var3>(self) -> ClosureOneOf3<Capture, Var2, Var3, In, Out> {
        let closure = OneOf3::Variant1(self);
        ClosureOneOf3 { closure }
    }

    /// Transforms `Closure<C2, In, Out>` into the more general `ClosureOneOf3<C1, C2, C3, In, Out>` for any `C1` and `C3`.
    ///
    /// *The example below illustrates the usage of the closure over two possible types of captures; however, ClosureOneOf3 is only a generalization of the below for three different capture types.*
    ///
    /// # Example
    ///
    /// ```rust
    /// use orx_closure::*;
    /// use std::collections::HashSet;
    ///
    /// type Node = usize; // for brevity
    /// type Edge = (Node, Node); // for brevity
    ///
    /// // captures either () or Vec<HashSet<Node>>
    /// type PrecedenceClosure = ClosureOneOf2<(), Vec<HashSet<Node>>, Edge, bool>;
    ///
    /// struct Precedence(PrecedenceClosure);
    ///
    /// impl Precedence {
    ///     fn new_variant2(closure: Closure<Vec<HashSet<Node>>, Edge, bool>) -> Self {
    ///         // transforms        : Closure<Vec<HashSet<Node>>, Edge, bool>
    ///         // into more general : ClosureOneOf2<(), Vec<HashSet<Node>>, Edge, bool>
    ///         Self(closure.into_oneof2_var2())
    ///     }
    /// }
    /// ```
    pub fn into_oneof3_var2<Var1, Var3>(self) -> ClosureOneOf3<Var1, Capture, Var3, In, Out> {
        let closure = OneOf3::Variant2(self);
        ClosureOneOf3 { closure }
    }

    /// Transforms `Closure<C3, In, Out>` into the more general `ClosureOneOf3<C1, C2, C3, In, Out>` for any `C1` and `C2`.
    ///
    /// *The example below illustrates the usage of the closure over two possible types of captures; however, ClosureOneOf3 is only a generalization of the below for three different capture types.*
    ///
    /// # Example
    ///
    /// ```rust
    /// use orx_closure::*;
    /// use std::collections::HashSet;
    ///
    /// type Node = usize; // for brevity
    /// type Edge = (Node, Node); // for brevity
    ///
    /// // captures either () or Vec<HashSet<Node>>
    /// type PrecedenceClosure = ClosureOneOf2<(), Vec<HashSet<Node>>, Edge, bool>;
    ///
    /// struct Precedence(PrecedenceClosure);
    ///
    /// impl Precedence {
    ///     fn new_variant2(closure: Closure<Vec<HashSet<Node>>, Edge, bool>) -> Self {
    ///         // transforms        : Closure<Vec<HashSet<Node>>, Edge, bool>
    ///         // into more general : ClosureOneOf2<(), Vec<HashSet<Node>>, Edge, bool>
    ///         Self(closure.into_oneof2_var2())
    ///     }
    /// }
    /// ```
    pub fn into_oneof3_var3<Var1, Var2>(self) -> ClosureOneOf3<Var1, Var2, Capture, In, Out> {
        let closure = OneOf3::Variant3(self);
        ClosureOneOf3 { closure }
    }
}

impl<C1, C2, C3, In, Out> Fun<In, Out> for ClosureOneOf3<C1, C2, C3, In, Out> {
    fn call(&self, input: In) -> Out {
        ClosureOneOf3::call(self, input)
    }
}