surrealdb-core 3.2.3

A scalable, distributed, collaborative, document-graph database, for the realtime web
Documentation
use std::collections::BTreeMap;
use std::collections::btree_map::Entry;
use std::sync::Arc;

use ahash::{HashMap, HashMapExt, HashSet, HashSetExt};
use tokio::sync::Mutex;

use crate::expr::Expr;
use crate::val::{Number, RecordId, TableName};

pub(super) struct KnnPriorityList(Arc<Mutex<Inner>>);

struct Inner {
	knn: usize,
	docs: HashSet<Arc<RecordId>>,
	priority_list: BTreeMap<Number, HashSet<Arc<RecordId>>>,
}
impl KnnPriorityList {
	pub(super) fn new(knn: usize) -> Self {
		Self(Arc::new(Mutex::new(Inner {
			knn,
			docs: HashSet::with_capacity(knn),
			priority_list: BTreeMap::default(),
		})))
	}

	pub(super) async fn add(&self, dist: Number, record: &RecordId) {
		let mut i = self.0.lock().await;
		if i.check_add(&dist) {
			i.add(dist, record);
		}
		drop(i);
	}

	pub(super) async fn build(&self) -> HashMap<Arc<RecordId>, Number> {
		let l = self.0.lock().await;
		let r = l.build();
		drop(l);
		r
	}
}

impl Inner {
	fn check_add(&self, dist: &Number) -> bool {
		if self.docs.len() < self.knn {
			true
		} else if let Some(d) = self.priority_list.keys().last() {
			d.gt(dist)
		} else {
			true
		}
	}

	pub(super) fn add(&mut self, dist: Number, thg: &RecordId) {
		let thg = Arc::new(thg.clone());
		match self.priority_list.entry(dist) {
			Entry::Vacant(e) => {
				let mut h = HashSet::new();
				h.insert(Arc::clone(&thg));
				e.insert(h);
				self.docs.insert(thg);
			}
			Entry::Occupied(mut e) => {
				let h = e.get_mut();
				h.insert(thg);
			}
		}

		// Do possible eviction
		let docs_len = self.docs.len();
		if docs_len > self.knn
			&& let Some((_, d)) = self.priority_list.last_key_value()
			&& docs_len - d.len() >= self.knn
			&& let Some((_, evicted_docs)) = self.priority_list.pop_last()
		{
			for id in evicted_docs {
				self.docs.remove(&id);
			}
		}
	}

	fn build(&self) -> HashMap<Arc<RecordId>, Number> {
		let mut result = HashMap::with_capacity(self.knn);
		#[cfg(debug_assertions)]
		debug!("self.priority_list: {:?} - self.docs: {:?}", self.priority_list, self.docs);
		let mut left = self.knn;
		for (dist, docs) in &self.priority_list {
			let dl = docs.len();
			if dl > left {
				for doc_id in docs.iter().take(left) {
					result.insert(Arc::clone(doc_id), *dist);
				}
				break;
			}
			for doc_id in docs {
				result.insert(Arc::clone(doc_id), *dist);
			}
			left -= dl;
			// We don't expect anymore result, we can leave
			if left == 0 {
				break;
			}
		}
		result
	}
}

pub(crate) struct KnnBruteForceResult {
	exp: HashMap<Arc<Expr>, usize>,
	res: Vec<HashMap<Arc<RecordId>, Number>>,
}

impl KnnBruteForceResult {
	pub(super) fn with_capacity(capacity: usize) -> Self {
		Self {
			exp: HashMap::with_capacity(capacity),
			res: Vec::with_capacity(capacity),
		}
	}

	pub(super) fn insert(&mut self, e: Arc<Expr>, m: HashMap<Arc<RecordId>, Number>) {
		self.exp.insert(e, self.res.len());
		self.res.push(m);
	}
}

#[derive(Clone)]
pub(crate) struct KnnBruteForceResults(
	Arc<std::collections::HashMap<TableName, KnnBruteForceResult>>,
);

impl From<std::collections::HashMap<TableName, KnnBruteForceResult>> for KnnBruteForceResults {
	fn from(map: std::collections::HashMap<TableName, KnnBruteForceResult>) -> Self {
		Self(map.into())
	}
}
impl KnnBruteForceResults {
	pub(super) fn contains(&self, exp: &Expr, record: &RecordId) -> bool {
		if let Some(result) = self.0.get(record.table.as_str())
			&& let Some(&pos) = result.exp.get(exp)
			&& let Some(records) = result.res.get(pos)
		{
			return records.contains_key(record);
		}
		false
	}

	pub(crate) fn get_dist(&self, pos: usize, record: &RecordId) -> Option<Number> {
		if let Some(result) = self.0.get(record.table.as_str())
			&& let Some(records) = result.res.get(pos)
		{
			return records.get(record).copied();
		}
		None
	}
}