snomed-ecl-engine 0.1.1

Compact SNOMED CT ECL engine and RF2 index builder
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
use super::*;
use crate::decimal::Decimal;
use crate::ecl::{Comparison, MemberPredicate, MemberQuery};
use crate::store::{MemberColumn, MemberValue};
use std::collections::BTreeMap;

#[derive(Debug, PartialEq, Eq)]
pub enum QueryResult {
    Concepts(Vec<u32>),
    Values(Vec<MemberValue>),
    Rows(Vec<BTreeMap<String, MemberValue>>),
}
impl QueryResult {
    pub fn len(&self) -> usize {
        match self {
            Self::Concepts(v) => v.len(),
            Self::Values(v) => v.len(),
            Self::Rows(v) => v.len(),
        }
    }
    pub fn is_empty(&self) -> bool {
        self.len() == 0
    }
}
enum Prepared<'a> {
    /// Identifiers of the allowed concepts, sorted.
    Concepts(Vec<u64>),
    Number(&'a Decimal),
    Boolean(Option<bool>),
    Dates(&'a [Option<u32>]),
    DatesOrText {
        dates: &'a [Option<u32>],
        #[cfg(feature = "unicode")]
        terms: Option<crate::text::Terms<'a>>,
    },
    #[cfg(feature = "unicode")]
    Text(crate::text::Terms<'a>),
}

impl Context<'_> {
    pub(super) fn member_query(
        &mut self,
        query: &MemberQuery,
        depth: usize,
        terminal: bool,
    ) -> Result<QueryResult> {
        self.tick(1)?;
        if depth > MAX_DEPTH * 3
            || query.filters.len() > MAX_NODES
            || query.reverse && query.fields.is_some()
        {
            return Err(EvalError::InvalidAst);
        }
        let index = &self.store.member_tables;
        if !index.is_available() {
            return Err(EvalError::Unsupported(
                "Typed member index is absent; rebuild this store from RF2",
            ));
        }
        let candidates = self.eval(&query.source, depth + 1)?;
        if !query.reverse {
            if let Some(membership) = &self.store.membership {
                self.check_member_domain(membership, &candidates)?;
            }
        }
        let selected: Vec<_> = index
            .refsets()
            .filter(|id| {
                query.reverse
                    || self
                        .store
                        .ordinal(*id)
                        .is_some_and(|o| candidates.binary_search(&o).is_ok())
            })
            .collect();
        self.tick(
            index
                .refsets()
                .count()
                .saturating_mul(candidates.len().checked_ilog2().unwrap_or(0) as usize + 1),
        )?;
        let requested = query
            .fields
            .clone()
            .unwrap_or_else(|| vec!["referencedcomponentid".into()]);
        if requested.len() > 64 {
            return Err(EvalError::InvalidAst);
        }
        for field in requested
            .iter()
            .chain(query.filters.iter().map(|f| &f.field))
        {
            if !selected.iter().any(|r| {
                index
                    .fields(*r)
                    .unwrap()
                    .iter()
                    .any(|n| n.eq_ignore_ascii_case(field))
            }) {
                // An ordinary empty member expansion is valid; named projection/filter fields must exist.
                if query.fields.is_some() || !query.filters.is_empty() {
                    return Err(EvalError::InvalidField(field.clone()));
                }
            }
        }
        let mut prepared = Vec::new();
        for filter in &query.filters {
            self.nodes += 1;
            if self.nodes > MAX_NODES {
                return Err(EvalError::InvalidAst);
            }
            let op = filter.comparison;
            let value = match &filter.value {
                MemberPredicate::Concepts(expr)
                    if matches!(op, Comparison::Eq | Comparison::Ne) =>
                {
                    let ordinals = self.eval(expr, depth + 1)?;
                    let ids = self.identifiers(&ordinals)?;
                    self.release(ordinals);
                    Prepared::Concepts(ids)
                }
                MemberPredicate::Number(value) => Prepared::Number(value),
                MemberPredicate::Boolean(value)
                    if matches!(op, Comparison::Eq | Comparison::Ne) =>
                {
                    Prepared::Boolean(*value)
                }
                MemberPredicate::Dates(values) if !values.is_empty() => Prepared::Dates(values),
                MemberPredicate::DatesOrText { dates, terms } if !dates.is_empty() => {
                    #[cfg(not(feature = "unicode"))]
                    let _ = terms;
                    Prepared::DatesOrText {
                        dates,
                        #[cfg(feature = "unicode")]
                        terms: if dates.iter().all(Option::is_some) {
                            Some(
                                crate::text::Terms::new(terms)
                                    .map_err(|_| EvalError::InvalidAst)?,
                            )
                        } else {
                            None
                        },
                    }
                }
                MemberPredicate::Text(values) if matches!(op, Comparison::Eq | Comparison::Ne) => {
                    #[cfg(feature = "unicode")]
                    {
                        Prepared::Text(
                            crate::text::Terms::new(values).map_err(|_| EvalError::InvalidAst)?,
                        )
                    }
                    #[cfg(not(feature = "unicode"))]
                    {
                        let _ = values;
                        return Err(EvalError::Unsupported(
                            "Member string matching requires the unicode Cargo feature",
                        ));
                    }
                }
                _ => return Err(EvalError::InvalidAst),
            };
            prepared.push(value);
        }
        // Reject tuple-valued subqueries before scanning, even when no row could match.
        if !terminal && requested.len() != 1 {
            return Err(EvalError::TypeMismatch);
        }
        let referenced = if query.reverse {
            self.identifiers(&candidates)?
        } else {
            Vec::new()
        };
        let mut rows = Vec::new();
        let mut values = std::collections::BTreeSet::new();
        let words = self.store.ids.len().div_ceil(32);
        let mut marked = self.reserve(words)?;
        marked.resize(words, 0);
        let row_result = terminal && query.fields.as_ref().is_some_and(|f| f.len() != 1);
        let membership =
            requested.len() == 1 && requested[0].eq_ignore_ascii_case("referencedComponentId");
        let mut has_scalar_values = false;
        let active_explicit = query
            .filters
            .iter()
            .any(|f| f.field.eq_ignore_ascii_case("active"));
        for refset in selected {
            self.tick(1)?;
            let table = index
                .get(refset)
                .map_err(|e| EvalError::Index(e.to_string()))?
                .unwrap();
            let names = if requested.is_empty() {
                table.names[crate::store::REFERENCES..].to_vec()
            } else {
                requested.clone()
            };
            let columns: Option<Vec<_>> = names.iter().map(|name| table.column(name)).collect();
            let Some(columns) = columns else {
                continue;
            };
            let filter_columns: Option<Vec<_>> = query
                .filters
                .iter()
                .map(|f| table.column(&f.field))
                .collect();
            let Some(filter_columns) = filter_columns else {
                continue;
            };
            let concepts =
                query.reverse || columns.len() == 1 && matches!(columns[0], MemberColumn::Id(_));
            if requested.len() == 1 {
                has_scalar_values |= !concepts;
            }
            for (column, predicate) in filter_columns.iter().zip(&prepared) {
                validate_type(column, predicate)?;
            }
            let MemberColumn::Boolean(active) = &table.columns[crate::store::ACTIVE] else {
                return Err(EvalError::Index("Invalid member status".into()));
            };
            let MemberColumn::Id(references) = &table.columns[crate::store::REFERENCES] else {
                return Err(EvalError::TypeMismatch);
            };
            // The smallest `=` concept set on an identifier column names the
            // only rows that can match; the rest of the table is not read.
            let mut drive: Option<(usize, &[u64])> = query
                .reverse
                .then_some((crate::store::REFERENCES, &referenced[..]));
            for ((filter, column), predicate) in
                query.filters.iter().zip(&filter_columns).zip(&prepared)
            {
                if let (Comparison::Eq, MemberColumn::Id(_), Prepared::Concepts(ids)) =
                    (filter.comparison, column, predicate)
                {
                    if drive.is_none_or(|(_, best)| ids.len() < best.len()) {
                        let position = table
                            .names
                            .iter()
                            .position(|n| n.eq_ignore_ascii_case(&filter.field))
                            .unwrap();
                        drive = Some((position, ids));
                    }
                }
            }
            let probe = table.len().checked_ilog2().unwrap_or(0) as usize + 1;
            let driven = match drive {
                Some((position, ids)) if ids.len().saturating_mul(probe) < table.len() => {
                    let order = index
                        .order(refset, position)
                        .map_err(|e| EvalError::Index(e.to_string()))?
                        .ok_or(EvalError::TypeMismatch)?;
                    let MemberColumn::Id(keys) = &table.columns[position] else {
                        unreachable!()
                    };
                    self.tick(ids.len() * probe)?;
                    let mut found = Vec::new();
                    for &id in ids {
                        let start = order.partition_point(|&r| keys[r as usize] < id);
                        let end =
                            start + order[start..].partition_point(|&r| keys[r as usize] == id);
                        self.claim(end - start)?;
                        found.extend_from_slice(&order[start..end]);
                    }
                    self.tick(found.len())?;
                    found.sort_unstable();
                    Some(found)
                }
                _ => None,
            };
            let scanned = driven.as_ref().map_or(table.len(), Vec::len);
            for step in 0..scanned {
                let row = driven.as_ref().map_or(step, |rows| rows[step] as usize);
                self.tick(1)?;
                if !active_explicit && active[row] == 0 {
                    continue;
                }
                if query.reverse {
                    self.tick(referenced.len().checked_ilog2().unwrap_or(0) as usize + 1)?;
                    if referenced.binary_search(&references[row]).is_err() {
                        continue;
                    }
                }
                let mut matches = true;
                for ((column, predicate), filter) in
                    filter_columns.iter().zip(&mut prepared).zip(&query.filters)
                {
                    if !self.member_matches(column, row, predicate, filter.comparison)? {
                        matches = false;
                        break;
                    }
                }
                if !matches {
                    continue;
                }
                if query.reverse {
                    let ordinal = self.store.ordinal(refset).ok_or(EvalError::TypeMismatch)?;
                    marked[ordinal as usize / 32] |= 1 << (ordinal % 32);
                    break;
                } else if concepts && !row_result {
                    let MemberColumn::Id(ids) = columns[0] else {
                        unreachable!()
                    };
                    let id = ids[row];
                    if let Some(ordinal) = self.store.ordinal(id) {
                        marked[ordinal as usize / 32] |= 1 << (ordinal % 32);
                    } else if membership && crate::store::is_concept_id(id) {
                        // memberOf is the set of referenced concepts; an identifier naming no
                        // concept of this substrate adds none. Other fields return their values.
                    } else {
                        let value = if crate::store::is_concept_id(id) {
                            MemberValue::Concept(id.to_string())
                        } else {
                            MemberValue::Component(id.to_string())
                        };
                        has_scalar_values = true;
                        if !values.contains(&value) {
                            self.claim(super::values::value_cost(&value))?;
                            values.insert(value);
                        }
                    }
                } else if !row_result && requested.len() == 1 {
                    let column = columns[0];
                    let bytes = match column {
                        MemberColumn::Text(text) | MemberColumn::Number(text) => {
                            text.get(row).len()
                        }
                        _ => 40,
                    };
                    self.tick(bytes)?;
                    // Check before cloning a potentially large string.
                    self.claim(16 + bytes.div_ceil(4))?;
                    let mut value = column.value(row);
                    if let MemberValue::Number(number) = &mut value {
                        *number = Decimal::parse(number)
                            .ok_or(EvalError::InvalidAst)?
                            .to_string();
                    }
                    self.live -= 16 + bytes.div_ceil(4);
                    if !values.contains(&value) {
                        self.claim(super::values::value_cost(&value))?;
                        values.insert(value);
                    }
                } else {
                    self.claim(names.len().saturating_mul(32))?;
                    let mut values = BTreeMap::new();
                    for (name, col) in names.iter().zip(&columns) {
                        if let MemberColumn::Text(text) | MemberColumn::Number(text) = col {
                            self.tick(text.get(row).len())?;
                            self.claim(text.get(row).len().div_ceil(4))?;
                        }
                        let canonical = table
                            .names
                            .iter()
                            .find(|n| n.eq_ignore_ascii_case(name))
                            .unwrap()
                            .clone();
                        values.insert(canonical, col.value(row));
                    }
                    rows.push(values);
                }
            }
            if let Some(found) = driven {
                self.live -= found.len();
            }
        }
        for predicate in prepared {
            if let Prepared::Concepts(ids) = predicate {
                self.live -= ids.len() * 2;
            }
        }
        self.live -= referenced.len() * 2;
        self.release(candidates);
        if has_scalar_values && !row_result {
            for (word, &bits) in marked.iter().enumerate() {
                let mut bits = bits;
                while bits != 0 {
                    self.tick(1)?;
                    let ordinal = word * 32 + bits.trailing_zeros() as usize;
                    let value = MemberValue::Concept(self.store.ids[ordinal].to_string());
                    self.claim(super::values::value_cost(&value))?;
                    values.insert(value);
                    bits &= bits - 1;
                }
            }
            self.release(marked);
            return Ok(QueryResult::Values(values.into_iter().collect()));
        }
        if row_result {
            self.release(marked);
            return Ok(QueryResult::Rows(rows));
        }
        let count = marked.iter().map(|v| v.count_ones() as usize).sum();
        let mut result = self.reserve(count)?;
        for (word, &bits) in marked.iter().enumerate() {
            let mut bits = bits;
            while bits != 0 {
                self.tick(1)?;
                result.push(word as u32 * 32 + bits.trailing_zeros());
                bits &= bits - 1;
            }
        }
        self.release(marked);
        Ok(QueryResult::Concepts(result))
    }

    /// The identifiers of sorted ordinals, which are sorted too since
    /// ordinals follow identifier order. Claims two values per identifier.
    fn identifiers(&mut self, ordinals: &[u32]) -> Result<Vec<u64>> {
        self.tick(ordinals.len())?;
        self.claim(ordinals.len() * 2)?;
        Ok(ordinals
            .iter()
            .map(|&o| self.store.ids[o as usize])
            .collect())
    }

    fn member_matches(
        &mut self,
        column: &MemberColumn,
        row: usize,
        predicate: &mut Prepared<'_>,
        op: Comparison,
    ) -> Result<bool> {
        self.tick(1)?;
        let member = match (column, predicate) {
            (MemberColumn::Id(values), Prepared::Concepts(allowed)) => {
                self.tick(allowed.len().checked_ilog2().unwrap_or(0) as usize + 1)?;
                allowed.binary_search(&values[row]).is_ok()
            }
            (MemberColumn::Integer(values), Prepared::Number(value)) => {
                return Ok(op.matches(Decimal::parse(&values[row].to_string()).unwrap().cmp(value)))
            }
            (MemberColumn::Number(values), Prepared::Number(value)) => {
                self.tick(values.get(row).len())?;
                return Ok(op.matches(
                    Decimal::parse(values.get(row))
                        .ok_or(EvalError::InvalidAst)?
                        .cmp(value),
                ));
            }
            (MemberColumn::Boolean(values), Prepared::Boolean(value)) => {
                value.is_none_or(|v| v == (values[row] != 0))
            }
            (
                MemberColumn::Time(values),
                Prepared::Dates(dates) | Prepared::DatesOrText { dates, .. },
            ) => {
                self.tick(dates.len())?;
                let actual = (values[row] != 0).then_some(values[row]);
                dates.iter().any(|date| match op {
                    Comparison::Eq | Comparison::Ne => actual == *date,
                    Comparison::Le | Comparison::Ge if actual.is_none() && date.is_none() => true,
                    _ => actual
                        .zip(*date)
                        .is_some_and(|(a, b)| op.matches(a.cmp(&b))),
                })
            }
            #[cfg(feature = "unicode")]
            (
                MemberColumn::Text(values),
                Prepared::Text(terms)
                | Prepared::DatesOrText {
                    terms: Some(terms), ..
                },
            ) => {
                self.tick(terms.work(values.get(row)))?;
                terms
                    .matches(
                        values.get(row),
                        self.store
                            .config
                            .member_language_code()
                            .ok_or(EvalError::InvalidAst)?,
                    )
                    .map_err(|e| EvalError::Text(format!("{e:?}")))?
            }
            #[cfg(feature = "unicode")]
            (
                MemberColumn::Uuid(values),
                Prepared::Text(terms)
                | Prepared::DatesOrText {
                    terms: Some(terms), ..
                },
            ) => {
                let text = crate::store::format_uuid(&values[row]);
                self.tick(terms.work(&text))?;
                terms
                    .matches(
                        &text,
                        self.store
                            .config
                            .member_language_code()
                            .ok_or(EvalError::InvalidAst)?,
                    )
                    .map_err(|e| EvalError::Text(format!("{e:?}")))?
            }
            _ => return Err(EvalError::TypeMismatch),
        };
        Ok(member != (op == Comparison::Ne))
    }
}
fn validate_type(column: &MemberColumn, predicate: &Prepared<'_>) -> Result<()> {
    let valid = match (column, predicate) {
        (MemberColumn::Id(_), Prepared::Concepts(_))
        | (MemberColumn::Integer(_) | MemberColumn::Number(_), Prepared::Number(_))
        | (MemberColumn::Boolean(_), Prepared::Boolean(_))
        | (MemberColumn::Time(_), Prepared::Dates(_) | Prepared::DatesOrText { .. }) => true,
        (MemberColumn::Text(_) | MemberColumn::Uuid(_), Prepared::DatesOrText { dates, .. })
            if dates.iter().all(Option::is_some) =>
        {
            if !cfg!(feature = "unicode") {
                return Err(EvalError::Unsupported(
                    "Member string matching requires the unicode Cargo feature",
                ));
            }
            true
        }
        #[cfg(feature = "unicode")]
        (MemberColumn::Text(_) | MemberColumn::Uuid(_), Prepared::Text(_)) => true,
        _ => false,
    };
    if valid {
        Ok(())
    } else {
        Err(EvalError::TypeMismatch)
    }
}