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
use crate::KeyMngTrait;
use super::{config::TreapMapConfig, node::Node};
/// The interface for insert/update/delete a node in a `Treap` by key by custom
/// logic.
pub trait TreapNodeUpdate<C: TreapMapConfig> {
/// The return value
type Ret;
/// The return value if delete is required.
type DeleteRet;
/// Retrieve the key of the node to be updated.
fn treap_key(&self) -> (&C::SortKey, &C::SearchKey);
/// The core update logic for a node.
///
/// We pass `Option<&mut Box<_>>` instead of `&mut Option<Box<_>>` here
/// intentionally. This approach restricts the function from directly
/// inserting or removing nodes. Instead, the function should
/// communicates any attempts to add or remove nodes through
/// the `UpdateResult`.
fn update_node(
self, maybe_node: Option<&mut Box<Node<C>>>,
) -> OpResult<C, Self::Ret, Self::DeleteRet>;
/// When a node needs to be deleted during an update, the deleted node will
/// be fed to this method. The deletion logic itself is managed by
/// `update_inner`.
fn handle_delete(
deleted_node: Option<Box<Node<C>>>, delete_ret: Self::DeleteRet,
) -> Self::Ret;
}
pub enum OpResult<C: TreapMapConfig, R, DR> {
/// Used when the targeted slot in the Treap is vacant and a new node
/// should be inserted at this position.
InsertOnVacant { insert: Box<Node<C>>, ret: R },
/// Used when the targeted node been updated or remains unchanged.
/// `update_weight` is a flag to indicate whether the weight of the node
/// has changed as a result of the update. `ret` is the return value
/// associated with this operation.
///
/// ⚠️ WARNING: The update operation must not change the sort key of the
/// node.
Updated { update_weight: bool, ret: R },
/// Used when the targeted node is not changed. Equivalent to `Updated`
/// with `update_weight = false`
Noop(R),
/// Used when the targeted node should be deleted.
Delete(DR),
}
pub(crate) struct InsertOp<'a, C: TreapMapConfig> {
pub node: Box<Node<C>>,
pub ext_map: &'a mut C::ExtMap,
}
impl<'a, C: TreapMapConfig> TreapNodeUpdate<C> for InsertOp<'a, C> {
type DeleteRet = ();
type Ret = Option<C::Value>;
fn treap_key(&self) -> (&C::SortKey, &C::SearchKey) {
(&self.node.sort_key, &self.node.key)
}
fn update_node(
self, maybe_node: Option<&mut Box<Node<C>>>,
) -> OpResult<C, Self::Ret, Self::DeleteRet> {
use OpResult::*;
if let Some(node) = maybe_node {
let ret = Some(node.value.clone());
let update_weight = node.weight != self.node.weight;
self.ext_map.view_update(
&self.node.key,
Some(&self.node.value),
Some(&node.value),
);
node.value = self.node.value;
node.weight = self.node.weight;
Updated { ret, update_weight }
} else {
self.ext_map.view_update(
&self.node.key,
Some(&self.node.value),
None,
);
InsertOnVacant {
insert: self.node,
ret: None,
}
}
}
fn handle_delete(
_deleted_node: Option<Box<Node<C>>>, _delete_ret: (),
) -> Self::Ret {
// update_node never returns deletion
unreachable!()
}
}
pub(crate) struct RemoveOp<'a, C: TreapMapConfig> {
pub key: (&'a C::SortKey, &'a C::SearchKey),
pub ext_map: &'a mut C::ExtMap,
}
impl<'a, C: TreapMapConfig> TreapNodeUpdate<C> for RemoveOp<'a, C> {
type DeleteRet = ();
type Ret = Option<C::Value>;
fn treap_key(&self) -> (&C::SortKey, &C::SearchKey) { self.key }
fn update_node(
self, maybe_node: Option<&mut Box<Node<C>>>,
) -> OpResult<C, Self::Ret, Self::DeleteRet> {
self.ext_map.view_update(
self.key.1,
None,
maybe_node.map(|x| &x.value),
);
OpResult::Delete(())
}
fn handle_delete(
deleted_node: Option<Box<Node<C>>>, _delete_ret: (),
) -> Self::Ret {
deleted_node.map(|x| x.value)
}
}
/// Represents the outcome of an operation applied in the
/// [`TreapMap::update`][crate::TreapMap::update] function.
///
/// `ApplyOpOutcome` is used to convey the result of a user-defined operation
/// applied to a node in the `TreapMap`. It provides details to the `TreapMap`
/// about how to properly maintain the node after the operation.
pub struct ApplyOpOutcome<T> {
/// The value to be forwarded as the return value of the `update`
/// function.
pub out: T,
/// A flag indicating whether the operation has modified the node's weight.
/// If `true`, the `TreapMap` will recompute the accumulated weights.
pub update_weight: bool,
/// A flag indicating whether the operation has changed the node's key or
/// sort key. If `true`, the `TreapMap` will reposition the node within the
/// treap.
pub update_key: bool,
/// A flag indicating whether the node should be deleted following the
/// operation. If `true`, the `TreapMap` will remove the node.
pub delete_item: bool,
}
pub(crate) struct ApplyOp<'a, C, U, I, T, E>
where
C: TreapMapConfig,
U: FnOnce(&mut Node<C>) -> Result<ApplyOpOutcome<T>, E>,
I: FnOnce() -> Result<(Node<C>, T), E>,
{
pub key: (&'a C::SortKey, &'a C::SearchKey),
pub ext_map: &'a mut C::ExtMap,
pub update: U,
pub insert: I,
}
impl<'a, 'b, C, U, I, T, E> TreapNodeUpdate<C> for ApplyOp<'a, C, U, I, T, E>
where
C: TreapMapConfig,
U: FnOnce(&mut Node<C>) -> Result<ApplyOpOutcome<T>, E>,
I: FnOnce() -> Result<(Node<C>, T), E>,
{
type DeleteRet = (T, bool);
type Ret = Result<(T, Option<Box<Node<C>>>), E>;
fn treap_key(&self) -> (&'a C::SortKey, &'a C::SearchKey) { self.key }
fn update_node(
self, maybe_node: Option<&mut Box<Node<C>>>,
) -> OpResult<C, Self::Ret, Self::DeleteRet> {
use OpResult::*;
match maybe_node {
None => {
let (node, ret) = match (self.insert)() {
Ok(x) => x,
Err(err) => {
return Noop(Err(err));
}
};
self.ext_map
.view_update(&*self.key.1, Some(&node.value), None);
assert!(
C::next_node_dir(self.key, (&node.sort_key, &node.key))
.is_none(),
"Inserted node has incosistent key"
);
InsertOnVacant {
insert: Box::new(node),
ret: Ok((ret, None)),
}
}
Some(node) => {
let old_value = node.value.clone();
let ApplyOpOutcome {
out,
update_weight,
update_key,
delete_item,
} = match (self.update)(node) {
Ok(x) => x,
Err(err) => {
return Noop(Err(err));
}
};
let new_value =
if delete_item { None } else { Some(&node.value) };
self.ext_map.view_update(
&*self.key.1,
new_value,
Some(&old_value),
);
if update_key || delete_item {
Delete((out, delete_item))
} else {
Updated {
update_weight,
ret: Ok((out, None)),
}
}
}
}
}
fn handle_delete(
deleted_node: Option<Box<Node<C>>>, (ret, delete_item): (T, bool),
) -> Self::Ret {
let to_reinsert_node = if !delete_item {
Some(deleted_node.unwrap())
} else {
None
};
Ok((ret, to_reinsert_node))
}
}