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
use core::cmp::Ordering;
use core::marker::PhantomData;
use core::mem::replace;
#[cfg(feature = "alloc")]
use alloc::vec::Vec;
use crate::endian::Native;
use crate::pointer::{Coerce, Pointee};
use crate::slice::{BinarySearch, Slice};
use crate::{Buf, ByteOrder, Error, OwnedBuf, Ref, Size, ZeroCopy};
use super::{prefix, DefaultFlavor, Flavor, LinksRef, NodeRef, TrieRef};
/// Store the given collection in a trie.
///
/// The trie is stored as a graph, where each level contains a sorted collection
/// of strings. Each level is traversed using a binary search. Since levels are
/// expected to be relatively small, this produces a decent time to complexity
/// tradeoff.
///
/// Note that construction of the trie is the most performant if the input keys
/// are already sorted. Otherwise trie construction might require many
/// re-allocations.
///
/// # Examples
///
/// ```
/// use musli_zerocopy::{trie, OwnedBuf};
///
/// let mut buf = OwnedBuf::new();
///
/// let values = [
/// (buf.store_unsized("work"), 1),
/// (buf.store_unsized("worker"), 2),
/// (buf.store_unsized("workers"), 3),
/// (buf.store_unsized("working"), 4),
/// (buf.store_unsized("working"), 5),
/// (buf.store_unsized("working man"), 6),
/// ];
///
/// let trie = trie::store(&mut buf, values)?;
///
/// assert_eq!(trie.get(&buf, "aard")?, None);
/// assert_eq!(trie.get(&buf, "worker")?, Some(&[2][..]));
/// assert_eq!(trie.get(&buf, "working")?, Some(&[4, 5][..]));
/// # Ok::<_, musli_zerocopy::Error>(())
/// ```
#[cfg(feature = "alloc")]
pub fn store<S, E: ByteOrder, O: Size, I, T>(
buf: &mut OwnedBuf<E, O>,
it: I,
) -> Result<TrieRef<T, DefaultFlavor<E, O>>, Error>
where
I: IntoIterator<Item = (Ref<S, E, O>, T)>,
T: ZeroCopy,
S: ?Sized + Pointee + Coerce<[u8]>,
{
// First step is to construct the trie in-memory.
let mut trie = Builder::with_flavor();
for (string, value) in it {
trie.insert(buf, string, value)?;
}
trie.build(buf)
}
/// An in-memory trie structure as it's being constructed.
///
/// This can be used over [`store()`] to provide more control.
#[cfg(feature = "alloc")]
pub struct Builder<T, F: Flavor = DefaultFlavor> {
links: Links<T>,
_marker: PhantomData<F>,
}
#[cfg(feature = "alloc")]
impl<T> Builder<T> {
/// Construct a new empty trie builder with the default [`DefaultFlavor`].
#[inline]
pub const fn new() -> Self {
Self::with_flavor()
}
}
#[cfg(feature = "alloc")]
impl<T, F: Flavor> Builder<T, F> {
/// Construct a new empty trie builder with a custom [`Flavor`].
pub const fn with_flavor() -> Self {
Self {
links: Links::empty(),
_marker: PhantomData,
}
}
/// Insert a value into the trie.
///
/// # Examples
///
/// ```rust
/// use musli_zerocopy::{trie, OwnedBuf};
///
/// let mut buf = OwnedBuf::new();
///
/// let mut trie = trie::Builder::new();
///
/// let key = buf.store_unsized("working");
/// trie.insert(&buf, key, 4)?;
/// let key = buf.store_unsized("working man");
/// trie.insert(&buf, key, 6)?;
/// let key = buf.store_unsized("work");
/// trie.insert(&buf, key, 1)?;
/// let key = buf.store_unsized("worker");
/// trie.insert(&buf, key, 2)?;
/// let key = buf.store_unsized("workers");
/// trie.insert(&buf, key, 3)?;
/// let key = buf.store_unsized("working");
/// trie.insert(&buf, key, 5)?;
///
/// let trie = trie.build(&mut buf)?;
///
/// assert_eq!(trie.get(&buf, "aard")?, None);
/// assert_eq!(trie.get(&buf, "worker")?, Some(&[2][..]));
/// assert_eq!(trie.get(&buf, "working")?, Some(&[4, 5][..]));
/// # Ok::<_, musli_zerocopy::Error>(())
/// ```
pub fn insert<S, E: ByteOrder, O: Size>(
&mut self,
buf: &Buf,
string: Ref<S, E, O>,
value: T,
) -> Result<(), Error>
where
S: ?Sized + Pointee + Coerce<[u8]>,
{
let mut string = string.coerce::<[u8]>();
let mut current = buf.load(string)?;
let mut this = &mut self.links;
loop {
let search =
try_binary_search_by(&this.children, |c| Ok(buf.load(c.string)?.cmp(current)))?;
match search {
BinarySearch::Found(n) => {
this.children[n].links.values.push(value);
return Ok(());
}
BinarySearch::Missing(0) => {
this.children.insert(
0,
Node {
string: Ref::try_with_metadata(string.offset(), string.len())?,
links: Links::new(value),
},
);
return Ok(());
}
BinarySearch::Missing(n) => {
let pre = n - 1;
// Find common prefix and split nodes if necessary.
let prefix = prefix(buf.load(this.children[pre].string)?, current);
// No common prefix in prior node, so a new node is needed.
if prefix == 0 {
this.children.insert(
n,
Node {
string: Ref::try_with_metadata(string.offset(), string.len())?,
links: Links::new(value),
},
);
return Ok(());
}
let child = &mut this.children[pre];
// This happens if `current` contains a shorter subset match
// than the string represented by `child`, like `work` and
// the child string is `working` (common prefix is `work`).
//
// In that scenario, the child node has to be split up, so we transpose it from:
//
// ```
// "working" => { values = [1, 2, 3] }
// =>
// "work" => { "ing" => { values = [1, 2, 3] } }
// ```
if prefix != child.string.len() {
let (prefix, suffix) = child.string.split_at(prefix);
let new_node = Node::new(prefix);
let mut replaced = replace(child, new_node);
replaced.string = suffix;
child.links.children.push(replaced);
}
current = ¤t[prefix..];
string = string.split_at(prefix).1;
this = &mut child.links;
}
}
}
}
/// Construct a [`TrieRef`] out of the current [`Builder`].
///
/// # Errors
///
/// Trie construction will error in case an interior node overflows its
/// representation as per its [`Flavor`] defined by `F`.
///
/// # Examples
///
/// ```rust
/// use musli_zerocopy::{trie, OwnedBuf};
///
/// let mut buf = OwnedBuf::new();
///
/// let mut trie = trie::Builder::new();
///
/// let key = buf.store_unsized("work");
/// trie.insert(&buf, key, 1)?;
/// let key = buf.store_unsized("working");
/// trie.insert(&buf, key, 4)?;
///
/// let trie = trie.build(&mut buf)?;
///
/// assert_eq!(trie.get(&buf, "aard")?, None);
/// assert_eq!(trie.get(&buf, "work")?, Some(&[1][..]));
/// assert_eq!(trie.get(&buf, "working")?, Some(&[4][..]));
/// # Ok::<_, musli_zerocopy::Error>(())
/// ```
pub fn build<E: ByteOrder, O: Size>(
self,
buf: &mut OwnedBuf<E, O>,
) -> Result<TrieRef<T, F>, Error>
where
T: ZeroCopy,
{
Ok(TrieRef {
links: self.links.into_ref(buf)?,
})
}
}
#[cfg(feature = "alloc")]
struct Links<T> {
values: Vec<T>,
children: Vec<Node<T>>,
}
#[cfg(feature = "alloc")]
impl<T> Links<T> {
const fn empty() -> Self {
Self {
values: Vec::new(),
children: Vec::new(),
}
}
fn new(value: T) -> Self {
Self {
values: alloc::vec![value],
children: Vec::new(),
}
}
fn into_ref<E: ByteOrder, O: Size, F: Flavor>(
self,
buf: &mut OwnedBuf<E, O>,
) -> Result<LinksRef<T, F>, Error>
where
T: ZeroCopy,
{
let values = F::Values::try_from_ref(buf.store_slice(&self.values))?;
let mut children = Vec::with_capacity(self.children.len());
for node in self.children {
children.push(node.into_ref(buf)?);
}
let children = F::Children::try_from_ref(buf.store_slice(&children))?;
Ok(LinksRef { values, children })
}
}
#[cfg(feature = "alloc")]
struct Node<T> {
string: Ref<[u8], Native, usize>,
links: Links<T>,
}
#[cfg(feature = "alloc")]
impl<T> Node<T> {
const fn new(string: Ref<[u8], Native, usize>) -> Self {
Self {
string,
links: Links::empty(),
}
}
fn into_ref<E: ByteOrder, O: Size, F: Flavor>(
self,
buf: &mut OwnedBuf<E, O>,
) -> Result<NodeRef<T, F>, Error>
where
T: ZeroCopy,
{
Ok(NodeRef {
string: F::String::try_from_ref(self.string)?,
links: self.links.into_ref(buf)?,
})
}
}
/// Helper function to perform a binary search over a loaded slice.
fn try_binary_search_by<T, F, E>(slice: &[T], mut f: F) -> Result<BinarySearch, E>
where
F: FnMut(&T) -> Result<Ordering, E>,
{
// INVARIANTS:
// - 0 <= left <= left + size = right <= slice.len()
// - f returns Less for everything in slice[..left]
// - f returns Greater for everything in slice[right..]
let mut size = slice.len();
let mut left = 0;
let mut right = size;
while left < right {
let mid = left + size / 2;
// SAFETY: The while condition means `size` is strictly positive, so
// `size/2 < size`. Thus `left + size/2 < left + size`, which coupled
// with the `left + size <= slice.len()` invariant means we have `left +
// size/2 < slice.len()`, and this is in-bounds.
let value = unsafe { slice.get_unchecked(mid) };
let cmp = f(value)?;
// The reason why we use if/else control flow rather than match
// is because match reorders comparison operations, which is perf sensitive.
// This is x86 asm for u8: https://rust.godbolt.org/z/8Y8Pra.
if cmp == Ordering::Less {
left = mid + 1;
} else if cmp == Ordering::Greater {
right = mid;
} else {
return Ok(BinarySearch::Found(mid));
}
size = right - left;
}
Ok(BinarySearch::Missing(left))
}