rdfx 0.23.1

RDF 1.2 data-structures, traits and utilities: terms (incl. triple terms), triples, quads, interpretations, graphs, datasets, unstar/restar reification helpers.
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
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
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
use std::{cmp::Ordering, fmt::Debug, hash::Hash};

use educe::Educe;
use raw_btree::RawBTree;
use slab::Slab;

use crate::{
    Quad,
    RdfDisplay,
    Resource,
    dataset::{DatasetMut, Graph, IndexedBTreeDataset, ResourceTraversableDataset, TraversableDataset},
};

fn resource_cmp<R: Ord>(resources: &Slab<Entry<R>>) -> impl '_ + Fn(&usize, &R) -> Ordering {
    |&i, resource| resources[i].value.cmp(resource)
}

fn resource_index_cmp<R: Ord>(resources: &Slab<Entry<R>>) -> impl '_ + Fn(&usize, &usize) -> Ordering {
    |&i, &j| resources[i].value.cmp(&resources[j].value)
}

fn quad_with_resources<R: Resource>(resources: &Slab<Entry<R>>, Quad(s, p, o, g): Quad<usize, usize, usize, usize>) -> Quad<&R, &R, &R, &R> {
    // Safety: resource indexes in stored quads always point to live entries in `resources`.
    // The slab key remains valid until the quad referencing it is removed, which only happens
    // before the corresponding resource entry is freed.
    unsafe {
        Quad(
            &resources.get_unchecked(s).value,
            &resources.get_unchecked(p).value,
            &resources.get_unchecked(o).value,
            g.map(|g| &resources.get_unchecked(g).value),
        )
    }
}

fn quad_cmp<'a, R: Resource + Ord>(
    resources: &'a Slab<Entry<R>>,
    quads: &'a Slab<Quad<usize, usize, usize, usize>>,
) -> impl 'a + Fn(&usize, &Quad<&R, &R, &R, &R>) -> Ordering {
    |&i, quad| quad_with_resources(resources, quads[i]).cmp(quad)
}

fn quad_index_cmp<'a, R: Resource + Ord>(
    resources: &'a Slab<Entry<R>>,
    quads: &'a Slab<Quad<usize, usize, usize, usize>>,
) -> impl 'a + Fn(&usize, &usize) -> Ordering {
    |&i, &j| quad_with_resources(resources, quads[i]).cmp(&quad_with_resources(resources, quads[j]))
}

/// BTree-based RDF dataset.
#[derive(Clone)]
pub struct BTreeDataset<R> {
    pub(crate) resources: Slab<Entry<R>>,
    pub(crate) quads: Slab<Quad<usize, usize, usize, usize>>,
    pub(crate) resources_indexes: RawBTree<usize>,
    pub(crate) quads_indexes: RawBTree<usize>,
}

impl<R> Default for BTreeDataset<R> {
    fn default() -> Self {
        Self {
            quads: Slab::new(),
            resources: Slab::new(),
            quads_indexes: RawBTree::new(),
            resources_indexes: RawBTree::new(),
        }
    }
}

impl<R> BTreeDataset<R> {
    /// Creates a new empty dataset.
    pub fn new() -> Self {
        Self::default()
    }

    /// Returns the number of quads in the dataset.
    pub fn len(&self) -> usize {
        self.quads.len()
    }

    /// Checks if the dataset is empty.
    pub fn is_empty(&self) -> bool {
        self.quads.is_empty()
    }
}

impl<R: Resource> BTreeDataset<R> {
    /// Returns an iterator over the quads of the dataset.
    pub fn iter(&self) -> Quads<'_, R> {
        Quads {
            resources: &self.resources,
            quads: &self.quads,
            indexes: self.quads_indexes.iter(),
        }
    }

    /// Returns an iterator over the resources of the dataset.
    pub fn resources(&self) -> Resources<'_, R> {
        Resources {
            resources: &self.resources,
            indexes: self.resources_indexes.iter(),
        }
    }

    /// Indexes the quads to allow more operation on this dataset, such as
    /// pattern matching using the [`PatternMatchingDataset`] trait.
    ///
    /// [`PatternMatchingDataset`]: super::super::PatternMatchingDataset
    pub fn into_indexed(self) -> IndexedBTreeDataset<R> {
        IndexedBTreeDataset::from_non_indexed(self)
    }
}

impl<R: Resource + Ord> BTreeDataset<R> {
    fn index_of_resource(&self, resource: &R) -> Option<usize> {
        self.resources_indexes.get(resource_cmp(&self.resources), resource).copied()
    }

    /// Returns the index of the given quad in the dataset, if any.
    fn index_of_quad(&self, quad: Quad<&R, &R, &R, &R>) -> Option<usize> {
        self.quads_indexes.get(quad_cmp(&self.resources, &self.quads), &quad).copied()
    }

    /// Checks if the provided resource appears in any quad in the dataset.
    pub fn contains_resource(&self, resource: &R) -> bool {
        self.index_of_resource(resource).is_some()
    }

    /// Checks if the provided quad is in the dataset.
    pub fn contains(&self, quad: Quad<&R, &R, &R, &R>) -> bool {
        self.index_of_quad(quad).is_some()
    }

    /// Inserts the given quad in the dataset.
    ///
    /// Returns `true` if the quad was not already in the dataset, and `false`
    /// if it was.
    pub fn insert(&mut self, quad: Quad<R, R, R, R>) -> bool {
        // Resolve resources first. If any is missing, the quad cannot exist,
        // so we skip the dedup check that walks `quads_indexes`.
        let s_i_pre = self.index_of_resource(&quad.0);
        let p_i_pre = self.index_of_resource(&quad.1);
        let o_i_pre = self.index_of_resource(&quad.2);
        let g_i_pre = quad.3.as_ref().map(|g| self.index_of_resource(g));

        let g_existing = match g_i_pre {
            Some(Some(g_i)) => Some(Some(g_i)),
            None => Some(None),
            Some(None) => None,
        };

        if let (Some(s_i), Some(p_i), Some(o_i), Some(g_slot)) = (s_i_pre, p_i_pre, o_i_pre, g_existing) {
            let target = Quad(s_i, p_i, o_i, g_slot);
            let resources = &self.resources;
            let quads = &self.quads;
            let cmp = |i: &usize, t: &Quad<usize, usize, usize, usize>| quad_with_resources(resources, quads[*i]).cmp(&quad_with_resources(resources, *t));
            if self.quads_indexes.get(cmp, &target).is_some() {
                return false;
            }
        }

        let e = self.quads.vacant_entry();
        let i = e.key();

        let s_i = match s_i_pre {
            Some(s_i) => {
                self.resources[s_i].occurrences += 1;
                s_i
            }
            None => {
                let s_i = self.resources.insert(Entry::new(quad.0));
                self.resources_indexes.insert(resource_index_cmp(&self.resources), s_i);
                s_i
            }
        };

        let p_i = match p_i_pre {
            Some(p_i) => {
                self.resources[p_i].occurrences += 1;
                p_i
            }
            None => {
                let p_i = self.resources.insert(Entry::new(quad.1));
                self.resources_indexes.insert(resource_index_cmp(&self.resources), p_i);
                p_i
            }
        };

        let o_i = match o_i_pre {
            Some(o_i) => {
                self.resources[o_i].occurrences += 1;
                o_i
            }
            None => {
                let o_i = self.resources.insert(Entry::new(quad.2));
                self.resources_indexes.insert(resource_index_cmp(&self.resources), o_i);
                o_i
            }
        };

        let g_i = match (quad.3, g_i_pre) {
            (_, Some(Some(g_i))) => {
                self.resources[g_i].occurrences += 1;
                Some(g_i)
            }
            (Some(g), Some(None)) => {
                let g_i = self.resources.insert(Entry::new(g));
                self.resources_indexes.insert(resource_index_cmp(&self.resources), g_i);
                Some(g_i)
            }
            (None, None) => None,
            (Some(_), None) | (None, Some(_)) => unreachable!(),
        };

        e.insert(Quad(s_i, p_i, o_i, g_i));

        self.quads_indexes.insert(quad_index_cmp(&self.resources, &self.quads), i);

        true
    }

    /// Removes the given quad from the dataset.
    ///
    /// Returns whether or not the quad was in the dataset.
    /// Does nothing if the quad was not in the dataset.
    pub fn remove(&mut self, quad: Quad<&R, &R, &R, &R>) -> bool {
        match self.quads_indexes.remove(quad_cmp(&self.resources, &self.quads), &quad) {
            Some(i) => {
                let Quad(s_i, p_i, o_i, g_i) = self.quads.remove(i);

                let s = &mut self.resources[s_i];
                s.occurrences -= 1;
                if s.is_empty() {
                    self.resources_indexes.remove(resource_cmp(&self.resources), quad.0);
                    self.resources.remove(s_i);
                }

                let p = &mut self.resources[p_i];
                p.occurrences -= 1;
                if p.is_empty() {
                    self.resources_indexes.remove(resource_cmp(&self.resources), quad.1);
                    self.resources.remove(p_i);
                }

                let o = &mut self.resources[o_i];
                o.occurrences -= 1;
                if o.is_empty() {
                    self.resources_indexes.remove(resource_cmp(&self.resources), quad.2);
                    self.resources.remove(o_i);
                }

                if let Some(g_i) = g_i {
                    let g = &mut self.resources[g_i];
                    g.occurrences -= 1;
                    if g.is_empty() {
                        self.resources_indexes.remove(resource_index_cmp(&self.resources), &g_i);
                        self.resources.remove(g_i);
                    }
                }

                true
            }
            None => false,
        }
    }
}

impl<R: Resource + Clone + Ord> FromIterator<Quad<R, R, R, R>> for BTreeDataset<R> {
    fn from_iter<T: IntoIterator<Item = Quad<R, R, R, R>>>(iter: T) -> Self {
        let mut result = Self::new();
        result.extend(iter);
        result
    }
}

impl<R: Resource + Clone + Ord> Extend<Quad<R, R, R, R>> for BTreeDataset<R> {
    fn extend<T: IntoIterator<Item = Quad<R, R, R, R>>>(&mut self, iter: T) {
        for quad in iter {
            self.insert(quad);
        }
    }
}

impl<R: Resource + Clone + Ord> BTreeDataset<R> {
    /// Inserts every quad of `iter` in the dataset.
    pub fn absorb<I: IntoIterator<Item = Quad<R, R, R, R>>>(&mut self, iter: I) {
        self.extend(iter);
    }
}

impl<R: Resource> Graph for BTreeDataset<R> {
    type Subject = R;
    type Predicate = R;
    type Object = R;
}

impl<R: Resource> crate::dataset::Dataset for BTreeDataset<R> {
    type Graph = R;
}

impl<R: Resource> TraversableDataset for BTreeDataset<R> {
    type Quads<'a>
        = Quads<'a, R>
    where
        R: 'a;

    fn quads(&self) -> Self::Quads<'_> {
        self.iter()
    }

    fn quads_count(&self) -> usize {
        self.len()
    }
}

impl<R: Resource> ResourceTraversableDataset for BTreeDataset<R> {
    type Resources<'a>
        = Resources<'a, R>
    where
        R: 'a;

    fn resources(&self) -> Self::Resources<'_> {
        self.resources()
    }

    fn resource_count(&self) -> usize {
        self.resources.len()
    }
}

impl<R: Resource + Clone + Ord> DatasetMut for BTreeDataset<R> {
    fn insert(&mut self, quad: Quad<Self::Subject, Self::Predicate, Self::Object, <Self as crate::dataset::Dataset>::Graph>) {
        self.insert(quad);
    }

    fn remove(&mut self, quad: Quad<&Self::Subject, &Self::Predicate, &Self::Object, &<Self as crate::dataset::Dataset>::Graph>) {
        self.remove(quad);
    }
}

/// Iterator over the quads of a [`BTreeDataset`].
#[derive(Educe)]
#[educe(Clone, Copy)]
pub struct Quads<'a, R> {
    resources: &'a Slab<Entry<R>>,
    quads: &'a Slab<Quad<usize, usize, usize, usize>>,
    indexes: raw_btree::Iter<'a, usize>,
}

impl<'a, R: Resource> Iterator for Quads<'a, R> {
    type Item = Quad<&'a R, &'a R, &'a R, &'a R>;

    fn next(&mut self) -> Option<Self::Item> {
        self.indexes.next().map(|&i| quad_with_resources(self.resources, self.quads[i]))
    }
}

/// Iterator over the quads of a [`BTreeDataset`].
pub struct IntoQuads<R> {
    resources: Slab<Entry<R>>,
    quads: Slab<Quad<usize, usize, usize, usize>>,
    indexes: raw_btree::IntoIter<usize>,
}

impl<R: Resource + Clone> Iterator for IntoQuads<R> {
    type Item = Quad<R, R, R, R>;

    fn next(&mut self) -> Option<Self::Item> {
        self.indexes.next().map(|i| quad_with_resources(&self.resources, self.quads.remove(i)).cloned())
    }
}

impl<'a, R: Resource> IntoIterator for &'a BTreeDataset<R> {
    type Item = Quad<&'a R, &'a R, &'a R, &'a R>;
    type IntoIter = Quads<'a, R>;

    fn into_iter(self) -> Self::IntoIter {
        self.iter()
    }
}

impl<R: Resource + Clone> IntoIterator for BTreeDataset<R> {
    type Item = Quad<R, R, R, R>;
    type IntoIter = IntoQuads<R>;

    fn into_iter(self) -> Self::IntoIter {
        IntoQuads {
            resources: self.resources,
            quads: self.quads,
            indexes: self.quads_indexes.into_iter(),
        }
    }
}

pub struct Resources<'a, R> {
    resources: &'a Slab<Entry<R>>,
    indexes: raw_btree::Iter<'a, usize>,
}

impl<'a, R> Iterator for Resources<'a, R> {
    type Item = &'a R;

    fn next(&mut self) -> Option<Self::Item> {
        self.indexes.next().map(|&i| &self.resources[i].value)
    }
}

impl<A: Resource + PartialEq<B>, B: Resource> PartialEq<BTreeDataset<B>> for BTreeDataset<A> {
    fn eq(&self, other: &BTreeDataset<B>) -> bool {
        self.len() == other.len() && self.iter().zip(other).all(|(a, b)| a == b)
    }
}

impl<R: Resource + Eq> Eq for BTreeDataset<R> {}

impl<R: Resource + PartialOrd> PartialOrd for BTreeDataset<R> {
    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
        self.iter().partial_cmp(other)
    }
}

impl<R: Resource + Ord> Ord for BTreeDataset<R> {
    fn cmp(&self, other: &Self) -> Ordering {
        self.iter().cmp(other)
    }
}

impl<R: Resource + Hash> Hash for BTreeDataset<R> {
    fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
        state.write_usize(self.len());
        for elt in self {
            elt.hash(state);
        }
    }
}

#[derive(Default, Clone)]
pub(crate) struct Entry<R> {
    pub value: R,
    pub(crate) occurrences: usize,
}

impl<R> Entry<R> {
    pub const fn new(value: R) -> Self {
        Self { value, occurrences: 1 }
    }

    pub const fn is_empty(&self) -> bool {
        self.occurrences == 0
    }
}

impl<R: Resource + Debug> Debug for BTreeDataset<R> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_set().entries(self.iter()).finish()
    }
}

impl<R: Resource + RdfDisplay> RdfDisplay for BTreeDataset<R> {
    fn rdf_fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        for t in self {
            writeln!(f, "{} .", t.rdf_display())?;
        }

        Ok(())
    }
}

#[cfg(feature = "serde")]
impl<R: Resource + serde::Serialize> serde::Serialize for BTreeDataset<R> {
    fn serialize<S: serde::Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
        use serde::ser::SerializeSeq;
        let mut seq = serializer.serialize_seq(Some(self.len()))?;

        for quad in self {
            seq.serialize_element(&quad)?;
        }

        seq.end()
    }
}

#[cfg(feature = "serde")]
impl<'de, R: Resource + Clone + Ord + serde::Deserialize<'de>> serde::Deserialize<'de> for BTreeDataset<R> {
    fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
        struct Visitor<R>(std::marker::PhantomData<R>);

        impl<'de, R: Resource + Clone + Ord + serde::Deserialize<'de>> serde::de::Visitor<'de> for Visitor<R> {
            type Value = BTreeDataset<R>;

            fn expecting(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result {
                write!(formatter, "an RDF dataset")
            }

            fn visit_seq<A>(self, mut seq: A) -> Result<Self::Value, A::Error>
            where
                A: serde::de::SeqAccess<'de>,
            {
                let mut result = BTreeDataset::new();

                while let Some(quad) = seq.next_element()? {
                    result.insert(quad);
                }

                Ok(result)
            }
        }

        deserializer.deserialize_seq(Visitor(std::marker::PhantomData))
    }
}

#[cfg(test)]
#[allow(clippy::unwrap_used, clippy::panic, clippy::expect_used)]
mod tests {
    use rand::{Rng, SeedableRng, rngs::SmallRng};

    use crate::Quad;

    use super::BTreeDataset;

    fn rng_graph(rng: &mut SmallRng) -> Option<u32> {
        let g = rng.next_u32();
        if g % 2 == 0 { Some(g) } else { None }
    }

    fn insert_test(n: usize, seed: [u8; 32]) {
        let mut rng = SmallRng::from_seed(seed);
        let mut quads = Vec::new();
        quads.resize_with(n, || Quad(rng.next_u32(), rng.next_u32(), rng.next_u32(), rng_graph(&mut rng)));

        let mut dataset = BTreeDataset::new();
        for &t in &quads {
            dataset.insert(t);
        }

        quads.sort_unstable();
        quads.dedup();

        assert_eq!(dataset.len(), quads.len());

        test_eq(dataset, quads)
    }

    fn remove_test(n: usize, seed: [u8; 32]) {
        use rand::prelude::SliceRandom;
        let mut rng = SmallRng::from_seed(seed);
        let mut quads = Vec::new();
        quads.resize_with(n, || Quad(rng.next_u32(), rng.next_u32(), rng.next_u32(), rng_graph(&mut rng)));

        let mut dataset = BTreeDataset::new();
        for &t in &quads {
            dataset.insert(t);
        }

        quads.shuffle(&mut rng);

        for _ in 0..(n / 2) {
            let t = quads.pop().unwrap();
            dataset.remove(t.as_ref());
        }

        quads.sort_unstable();
        quads.dedup();

        test_eq(dataset, quads)
    }

    fn test_eq(dataset: BTreeDataset<u32>, quads: Vec<Quad<u32, u32, u32, u32>>) {
        assert_eq!(dataset.len(), quads.len());

        let mut a = quads.iter().copied();
        let mut b = dataset.iter().map(Quad::into_copied);

        loop {
            match (a.next(), b.next()) {
                (Some(a), Some(b)) => assert_eq!(a, b),
                (None, None) => break,
                _ => panic!("different length"),
            }
        }
    }

    #[test]
    fn insert() {
        for i in 0u8..32 {
            insert_test(i as usize * 11, [i; 32]);
        }
    }

    #[test]
    fn remove() {
        for i in 0u8..32 {
            remove_test(i as usize * 11, [i; 32]);
        }
    }
}