mirror of
https://github.com/meilisearch/MeiliSearch
synced 2024-06-01 10:28:02 +02:00
233 lines
8.7 KiB
Rust
233 lines
8.7 KiB
Rust
use heed::Result;
|
|
use roaring::RoaringBitmap;
|
|
|
|
use super::{get_first_facet_value, get_highest_level};
|
|
use crate::heed_codec::facet::{
|
|
FacetGroupKey, FacetGroupKeyCodec, FacetGroupValue, FacetGroupValueCodec,
|
|
};
|
|
use crate::heed_codec::ByteSliceRefCodec;
|
|
|
|
/// Return an iterator which iterates over the given candidate documents in
|
|
/// ascending order of their facet value for the given field id.
|
|
///
|
|
/// The documents returned by the iterator are grouped by the facet values that
|
|
/// determined their rank. For example, given the documents:
|
|
///
|
|
/// ```ignore
|
|
/// 0: { "colour": ["blue", "green"] }
|
|
/// 1: { "colour": ["blue", "red"] }
|
|
/// 2: { "colour": ["orange", "red"] }
|
|
/// 3: { "colour": ["green", "red"] }
|
|
/// 4: { "colour": ["blue", "orange", "red"] }
|
|
/// ```
|
|
/// Then calling the function on the candidates `[0, 2, 3, 4]` will return an iterator
|
|
/// over the following elements:
|
|
/// ```ignore
|
|
/// [0, 4] // corresponds to all the documents within the candidates that have the facet value "blue"
|
|
/// [3] // same for "green"
|
|
/// [2] // same for "orange"
|
|
/// END
|
|
/// ```
|
|
/// Note that once a document id is returned by the iterator, it is never returned again.
|
|
pub fn ascending_facet_sort<'t>(
|
|
rtxn: &'t heed::RoTxn<'t>,
|
|
db: heed::Database<FacetGroupKeyCodec<ByteSliceRefCodec>, FacetGroupValueCodec>,
|
|
field_id: u16,
|
|
candidates: RoaringBitmap,
|
|
) -> Result<impl Iterator<Item = Result<(RoaringBitmap, &'t [u8])>> + 't> {
|
|
let highest_level = get_highest_level(rtxn, db, field_id)?;
|
|
if let Some(first_bound) = get_first_facet_value::<ByteSliceRefCodec>(rtxn, db, field_id)? {
|
|
let first_key = FacetGroupKey { field_id, level: highest_level, left_bound: first_bound };
|
|
let iter = db.range(rtxn, &(first_key..)).unwrap().take(usize::MAX);
|
|
|
|
Ok(itertools::Either::Left(AscendingFacetSort {
|
|
rtxn,
|
|
db,
|
|
field_id,
|
|
stack: vec![(candidates, iter)],
|
|
}))
|
|
} else {
|
|
Ok(itertools::Either::Right(std::iter::empty()))
|
|
}
|
|
}
|
|
|
|
struct AscendingFacetSort<'t, 'e> {
|
|
rtxn: &'t heed::RoTxn<'e>,
|
|
db: heed::Database<FacetGroupKeyCodec<ByteSliceRefCodec>, FacetGroupValueCodec>,
|
|
field_id: u16,
|
|
#[allow(clippy::type_complexity)]
|
|
stack: Vec<(
|
|
RoaringBitmap,
|
|
std::iter::Take<
|
|
heed::RoRange<'t, FacetGroupKeyCodec<ByteSliceRefCodec>, FacetGroupValueCodec>,
|
|
>,
|
|
)>,
|
|
}
|
|
|
|
impl<'t, 'e> Iterator for AscendingFacetSort<'t, 'e> {
|
|
type Item = Result<(RoaringBitmap, &'t [u8])>;
|
|
|
|
fn next(&mut self) -> Option<Self::Item> {
|
|
'outer: loop {
|
|
let (documents_ids, deepest_iter) = self.stack.last_mut()?;
|
|
for result in deepest_iter {
|
|
let (
|
|
FacetGroupKey { level, left_bound, field_id },
|
|
FacetGroupValue { size: group_size, mut bitmap },
|
|
) = result.unwrap();
|
|
// The range is unbounded on the right and the group size for the highest level is MAX,
|
|
// so we need to check that we are not iterating over the next field id
|
|
if field_id != self.field_id {
|
|
return None;
|
|
}
|
|
|
|
// If the last iterator found an empty set of documents it means
|
|
// that we found all the documents in the sub level iterations already,
|
|
// we can pop this level iterator.
|
|
if documents_ids.is_empty() {
|
|
// break our of the for loop into the end of the 'outer loop, which
|
|
// pops the stack
|
|
break;
|
|
}
|
|
|
|
bitmap &= &*documents_ids;
|
|
if !bitmap.is_empty() {
|
|
*documents_ids -= &bitmap;
|
|
|
|
if level == 0 {
|
|
// Since the level is 0, the left_bound is the exact value.
|
|
return Some(Ok((bitmap, left_bound)));
|
|
}
|
|
let starting_key_below =
|
|
FacetGroupKey { field_id: self.field_id, level: level - 1, left_bound };
|
|
let iter = match self.db.range(self.rtxn, &(starting_key_below..)) {
|
|
Ok(iter) => iter,
|
|
Err(e) => return Some(Err(e)),
|
|
}
|
|
.take(group_size as usize);
|
|
|
|
self.stack.push((bitmap, iter));
|
|
continue 'outer;
|
|
}
|
|
}
|
|
self.stack.pop();
|
|
}
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use roaring::RoaringBitmap;
|
|
|
|
use crate::milli_snap;
|
|
use crate::search::facet::facet_sort_ascending::ascending_facet_sort;
|
|
use crate::search::facet::tests::{
|
|
get_random_looking_index, get_random_looking_string_index_with_multiple_field_ids,
|
|
get_simple_index, get_simple_string_index_with_multiple_field_ids,
|
|
};
|
|
use crate::snapshot_tests::display_bitmap;
|
|
|
|
#[test]
|
|
fn filter_sort_ascending() {
|
|
let indexes = [get_simple_index(), get_random_looking_index()];
|
|
for (i, index) in indexes.iter().enumerate() {
|
|
let txn = index.env.read_txn().unwrap();
|
|
let candidates = (200..=300).collect::<RoaringBitmap>();
|
|
let mut results = String::new();
|
|
let iter = ascending_facet_sort(&txn, index.content, 0, candidates).unwrap();
|
|
for el in iter {
|
|
let (docids, _) = el.unwrap();
|
|
results.push_str(&display_bitmap(&docids));
|
|
results.push('\n');
|
|
}
|
|
milli_snap!(results, i);
|
|
|
|
txn.commit().unwrap();
|
|
}
|
|
}
|
|
|
|
#[test]
|
|
fn filter_sort_ascending_multiple_field_ids() {
|
|
let indexes = [
|
|
get_simple_string_index_with_multiple_field_ids(),
|
|
get_random_looking_string_index_with_multiple_field_ids(),
|
|
];
|
|
for (i, index) in indexes.iter().enumerate() {
|
|
let txn = index.env.read_txn().unwrap();
|
|
let candidates = (200..=300).collect::<RoaringBitmap>();
|
|
let mut results = String::new();
|
|
let iter = ascending_facet_sort(&txn, index.content, 0, candidates.clone()).unwrap();
|
|
for el in iter {
|
|
let (docids, _) = el.unwrap();
|
|
results.push_str(&display_bitmap(&docids));
|
|
results.push('\n');
|
|
}
|
|
milli_snap!(results, format!("{i}-0"));
|
|
|
|
let mut results = String::new();
|
|
let iter = ascending_facet_sort(&txn, index.content, 1, candidates).unwrap();
|
|
for el in iter {
|
|
let (docids, _) = el.unwrap();
|
|
results.push_str(&display_bitmap(&docids));
|
|
results.push('\n');
|
|
}
|
|
milli_snap!(results, format!("{i}-1"));
|
|
|
|
txn.commit().unwrap();
|
|
}
|
|
}
|
|
|
|
#[test]
|
|
fn filter_sort_ascending_with_no_candidates() {
|
|
let indexes = [
|
|
get_simple_string_index_with_multiple_field_ids(),
|
|
get_random_looking_string_index_with_multiple_field_ids(),
|
|
];
|
|
for (_i, index) in indexes.iter().enumerate() {
|
|
let txn = index.env.read_txn().unwrap();
|
|
let candidates = RoaringBitmap::new();
|
|
let mut results = String::new();
|
|
let iter = ascending_facet_sort(&txn, index.content, 0, candidates.clone()).unwrap();
|
|
for el in iter {
|
|
let (docids, _) = el.unwrap();
|
|
results.push_str(&display_bitmap(&docids));
|
|
results.push('\n');
|
|
}
|
|
assert!(results.is_empty());
|
|
|
|
let mut results = String::new();
|
|
let iter = ascending_facet_sort(&txn, index.content, 1, candidates).unwrap();
|
|
for el in iter {
|
|
let (docids, _) = el.unwrap();
|
|
results.push_str(&display_bitmap(&docids));
|
|
results.push('\n');
|
|
}
|
|
assert!(results.is_empty());
|
|
|
|
txn.commit().unwrap();
|
|
}
|
|
}
|
|
|
|
#[test]
|
|
fn filter_sort_ascending_with_inexisting_field_id() {
|
|
let indexes = [
|
|
get_simple_string_index_with_multiple_field_ids(),
|
|
get_random_looking_string_index_with_multiple_field_ids(),
|
|
];
|
|
for (_i, index) in indexes.iter().enumerate() {
|
|
let txn = index.env.read_txn().unwrap();
|
|
let candidates = RoaringBitmap::new();
|
|
let mut results = String::new();
|
|
let iter = ascending_facet_sort(&txn, index.content, 3, candidates.clone()).unwrap();
|
|
for el in iter {
|
|
let (docids, _) = el.unwrap();
|
|
results.push_str(&display_bitmap(&docids));
|
|
results.push('\n');
|
|
}
|
|
assert!(results.is_empty());
|
|
|
|
txn.commit().unwrap();
|
|
}
|
|
}
|
|
}
|