chunk 0.10.2

The fastest semantic text chunking library — up to 1TB/s chunking throughput
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
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
//! Shared delimiter utilities for chunking and splitting.
//!
//! This module contains the core delimiter search functions using
//! SIMD-accelerated memchr (1-3 delimiters) or lookup table (4+ delimiters),
//! and multi-byte pattern search using memmem (1-3 patterns) or
//! Aho-Corasick via daggrs (4+ patterns).

use daggrs::{DoubleArrayAhoCorasick, MatchKind, Trie};
use memchr::memmem;

/// Default chunk target size (4KB).
pub const DEFAULT_TARGET_SIZE: usize = 4096;

/// Default delimiters: newline, period, question mark.
pub const DEFAULT_DELIMITERS: &[u8] = b"\n.?";

/// Find last delimiter in window using SIMD-accelerated memchr (1-3 delimiters)
/// or lookup table (4+ delimiters).
#[inline]
pub fn find_last_delimiter(
    window: &[u8],
    delimiters: &[u8],
    table: Option<&[bool; 256]>,
) -> Option<usize> {
    if let Some(t) = table {
        window.iter().rposition(|&b| t[b as usize])
    } else {
        match delimiters.len() {
            1 => memchr::memrchr(delimiters[0], window),
            2 => memchr::memrchr2(delimiters[0], delimiters[1], window),
            3 => memchr::memrchr3(delimiters[0], delimiters[1], delimiters[2], window),
            0 => None,
            _ => unreachable!(),
        }
    }
}

/// Find first delimiter in window using SIMD-accelerated memchr (1-3 delimiters)
/// or lookup table (4+ delimiters).
#[inline]
pub fn find_first_delimiter(
    window: &[u8],
    delimiters: &[u8],
    table: Option<&[bool; 256]>,
) -> Option<usize> {
    if let Some(t) = table {
        window.iter().position(|&b| t[b as usize])
    } else {
        match delimiters.len() {
            1 => memchr::memchr(delimiters[0], window),
            2 => memchr::memchr2(delimiters[0], delimiters[1], window),
            3 => memchr::memchr3(delimiters[0], delimiters[1], delimiters[2], window),
            0 => None,
            _ => unreachable!(),
        }
    }
}

/// Build lookup table for 4+ delimiters.
#[inline]
pub fn build_table(delimiters: &[u8]) -> Option<[bool; 256]> {
    if delimiters.len() > 3 {
        let mut t = [false; 256];
        for &b in delimiters {
            t[b as usize] = true;
        }
        Some(t)
    } else {
        None
    }
}

/// Find delimiter boundary that is the START of a consecutive run.
///
/// Searches backward from `target_end`, then forward if `forward_fallback` is true.
/// When `consecutive` is true, returns position of a delimiter that is NOT preceded
/// by the same delimiter byte.
///
/// Returns positions > start (never returns start itself, as that wouldn't make progress).
pub fn find_delimiter_boundary(
    text: &[u8],
    delimiters: &[u8],
    table: Option<&[bool; 256]>,
    start: usize,
    target_end: usize,
    consecutive: bool,
    forward_fallback: bool,
) -> Option<usize> {
    if delimiters.is_empty() || start >= text.len() {
        return None;
    }

    let target_end = target_end.min(text.len());
    let window = &text[start..target_end];

    // Backward search
    if consecutive {
        // Find last delimiter that is START of consecutive run (same delimiter)
        let mut search_end = window.len();
        while search_end > 0 {
            let rel_pos = find_last_delimiter(&window[..search_end], delimiters, table);

            if let Some(rel_pos) = rel_pos {
                let abs_pos = start + rel_pos;
                let delim_byte = text[abs_pos];
                // Check if this is START of consecutive run (not preceded by same delimiter)
                if abs_pos == 0 || text[abs_pos - 1] != delim_byte {
                    // Found valid boundary, but skip if it equals start (no progress)
                    if abs_pos > start {
                        return Some(abs_pos);
                    }
                    // We've traced back to start - chunk is full of consecutive delimiters
                    // Fall through to forward fallback
                    break;
                }
                // In middle of run, search earlier
                search_end = rel_pos;
            } else {
                break;
            }
        }
    } else {
        // Simple case: just find last occurrence (but not at start position)
        let rel_pos = find_last_delimiter(window, delimiters, table);
        if let Some(rel_pos) = rel_pos {
            let abs_pos = start + rel_pos;
            if abs_pos > start {
                return Some(abs_pos);
            }
        }
    }

    // Forward fallback search - find next boundary after target_end
    if forward_fallback {
        // First, determine where to start searching forward.
        // If we're at the start of a consecutive run, skip past the entire run.
        let mut forward_from = target_end;

        if consecutive && start < text.len() {
            // Check if start is at a delimiter
            let is_delim_at_start = if let Some(t) = table {
                t[text[start] as usize]
            } else {
                delimiters.contains(&text[start])
            };

            if is_delim_at_start {
                // We're at a delimiter at `start`. Skip all consecutive same delimiters.
                let delim_byte = text[start];
                let mut pos = start;
                while pos < text.len() && text[pos] == delim_byte {
                    pos += 1;
                }
                // Start searching from end of consecutive run, but not before target_end
                forward_from = forward_from.max(pos);
            }
        }

        if forward_from < text.len() {
            let forward_window = &text[forward_from..];

            if consecutive {
                // Find first delimiter that is START of consecutive run
                let mut search_start = 0;
                while search_start < forward_window.len() {
                    let rel_pos =
                        find_first_delimiter(&forward_window[search_start..], delimiters, table);

                    if let Some(rel_pos) = rel_pos {
                        let abs_pos = forward_from + search_start + rel_pos;
                        let delim_byte = text[abs_pos];
                        if abs_pos == 0 || text[abs_pos - 1] != delim_byte {
                            return Some(abs_pos);
                        }
                        // In middle of run, search later
                        search_start += rel_pos + 1;
                    } else {
                        break;
                    }
                }
            } else {
                let rel_pos = find_first_delimiter(forward_window, delimiters, table);
                if let Some(rel_pos) = rel_pos {
                    return Some(forward_from + rel_pos);
                }
            }
        }

        // No delimiter found forward. Return text.len() to include all remaining
        // text in one chunk. This avoids O(n²) behavior from repeatedly searching
        // forward through the entire remaining text on each iteration.
        return Some(text.len());
    }

    None
}

/// Find pattern boundary that is the START of a consecutive run.
///
/// Searches backward from `target_end`, then forward if `forward_fallback` is true.
/// When `consecutive` is true, returns position of a pattern that is NOT preceded
/// by another instance of the same pattern.
///
/// Returns positions > start (never returns start itself, as that wouldn't make progress).
pub fn find_pattern_boundary(
    text: &[u8],
    pattern: &[u8],
    start: usize,
    target_end: usize,
    consecutive: bool,
    forward_fallback: bool,
) -> Option<usize> {
    let plen = pattern.len();
    if plen == 0 || start >= text.len() {
        return None;
    }

    let target_end = target_end.min(text.len());
    let window = &text[start..target_end];

    // Backward search
    if consecutive {
        // Find last pattern that is START of consecutive run
        let mut search_end = window.len();
        while search_end > 0 {
            let rel_pos = if plen == 1 {
                memchr::memrchr(pattern[0], &window[..search_end])
            } else {
                memmem::rfind(&window[..search_end], pattern)
            };

            if let Some(rel_pos) = rel_pos {
                let abs_pos = start + rel_pos;
                // Check if this is START of consecutive run (not preceded by same pattern)
                if abs_pos < plen || &text[abs_pos - plen..abs_pos] != pattern {
                    // Found valid boundary, but skip if it equals start (no progress)
                    if abs_pos > start {
                        return Some(abs_pos);
                    }
                    // We've traced back to start - chunk is full of consecutive patterns
                    // Fall through to forward fallback
                    break;
                }
                // In middle of run, search earlier
                search_end = rel_pos;
            } else {
                break;
            }
        }
    } else {
        // Simple case: just find last occurrence (but not at start position)
        let rel_pos = if plen == 1 {
            memchr::memrchr(pattern[0], window)
        } else {
            memmem::rfind(window, pattern)
        };
        if let Some(rel_pos) = rel_pos {
            let abs_pos = start + rel_pos;
            if abs_pos > start {
                return Some(abs_pos);
            }
        }
    }

    // Forward fallback search - find next boundary after target_end
    if forward_fallback {
        // First, determine where to start searching forward.
        // If we're at the start of a consecutive run, skip past the entire run.
        let mut forward_from = target_end;

        if consecutive && start + plen <= text.len() && &text[start..start + plen] == pattern {
            // We're at a pattern at `start`. Skip all consecutive patterns.
            let mut pos = start;
            while pos + plen <= text.len() && &text[pos..pos + plen] == pattern {
                pos += plen;
            }
            // Start searching from end of consecutive run, but not before target_end
            forward_from = forward_from.max(pos);
        }

        if forward_from < text.len() {
            let forward_window = &text[forward_from..];

            if consecutive {
                // Find first pattern that is START of consecutive run
                let mut search_start = 0;
                while search_start < forward_window.len() {
                    let rel_pos = if plen == 1 {
                        memchr::memchr(pattern[0], &forward_window[search_start..])
                    } else {
                        memmem::find(&forward_window[search_start..], pattern)
                    };

                    if let Some(rel_pos) = rel_pos {
                        let abs_pos = forward_from + search_start + rel_pos;
                        if abs_pos < plen || &text[abs_pos - plen..abs_pos] != pattern {
                            return Some(abs_pos);
                        }
                        // In middle of run, search later
                        search_start += rel_pos + 1;
                    } else {
                        break;
                    }
                }
            } else {
                let rel_pos = if plen == 1 {
                    memchr::memchr(pattern[0], forward_window)
                } else {
                    memmem::find(forward_window, pattern)
                };
                if let Some(rel_pos) = rel_pos {
                    return Some(forward_from + rel_pos);
                }
            }
        }

        // No pattern found forward. Return text.len() to include all remaining
        // text in one chunk. This avoids O(n²) behavior from repeatedly searching
        // forward through the entire remaining text on each iteration.
        return Some(text.len());
    }

    None
}

// =============================================================================
// Multi-byte pattern search (hybrid memmem / Aho-Corasick)
// =============================================================================

/// Threshold: use memmem for 1-3 patterns, Aho-Corasick for 4+.
const MEMMEM_PATTERN_THRESHOLD: usize = 3;

/// Pre-compiled multi-pattern searcher.
///
/// Automatically selects the optimal strategy based on pattern count:
/// - 1-3 patterns: parallel memmem searches (SIMD-accelerated)
/// - 4+ patterns: Aho-Corasick automaton (single pass, constant in pattern count)
pub enum MultiPatternSearcher {
    /// SIMD memmem for small pattern sets. Stores (forward_finder_needle, reverse_finder_needle) as bytes.
    Memmem { patterns: Vec<Vec<u8>> },
    /// Aho-Corasick for large pattern sets.
    AhoCorasick {
        daac: DoubleArrayAhoCorasick,
        pattern_lens: Vec<usize>,
    },
}

impl MultiPatternSearcher {
    /// Build a searcher from pattern byte slices.
    pub fn new(patterns: &[&[u8]]) -> Self {
        if patterns.len() <= MEMMEM_PATTERN_THRESHOLD {
            MultiPatternSearcher::Memmem {
                patterns: patterns.iter().map(|p| p.to_vec()).collect(),
            }
        } else {
            let mut trie = Trie::new();
            for (i, &pat) in patterns.iter().enumerate() {
                trie.add(pat, i as u32);
            }
            trie.build(MatchKind::LeftmostFirst);
            let daac = trie.compile();
            let pattern_lens = patterns.iter().map(|p| p.len()).collect();
            MultiPatternSearcher::AhoCorasick { daac, pattern_lens }
        }
    }

    /// Build a searcher from string slices (convenience for UTF-8 patterns).
    pub fn from_strs(patterns: &[&str]) -> Self {
        let byte_patterns: Vec<&[u8]> = patterns.iter().map(|s| s.as_bytes()).collect();
        Self::new(&byte_patterns)
    }

    /// Find the **last** (rightmost) pattern match in `window`.
    /// Returns `(position, pattern_length)` relative to window start.
    pub fn find_last(&self, window: &[u8]) -> Option<(usize, usize)> {
        match self {
            MultiPatternSearcher::Memmem { patterns } => {
                let mut best: Option<(usize, usize)> = None;
                for pat in patterns {
                    let finder = memmem::FinderRev::new(pat);
                    if let Some(pos) = finder.rfind(window) {
                        match best {
                            None => best = Some((pos, pat.len())),
                            Some((best_pos, _)) if pos > best_pos => best = Some((pos, pat.len())),
                            _ => {}
                        }
                    }
                }
                best
            }
            MultiPatternSearcher::AhoCorasick { daac, pattern_lens } => {
                let mut last: Option<(usize, usize)> = None;
                for m in daac.find_iter(window) {
                    last = Some((m.start, pattern_lens[m.pattern_id as usize]));
                }
                last
            }
        }
    }

    /// Find the **first** (leftmost) pattern match in `window`.
    /// Returns `(position, pattern_length)` relative to window start.
    pub fn find_first(&self, window: &[u8]) -> Option<(usize, usize)> {
        match self {
            MultiPatternSearcher::Memmem { patterns } => {
                let mut best: Option<(usize, usize)> = None;
                for pat in patterns {
                    let finder = memmem::Finder::new(pat);
                    if let Some(pos) = finder.find(window) {
                        match best {
                            None => best = Some((pos, pat.len())),
                            Some((best_pos, _)) if pos < best_pos => best = Some((pos, pat.len())),
                            _ => {}
                        }
                    }
                }
                best
            }
            MultiPatternSearcher::AhoCorasick { daac, pattern_lens } => daac
                .find_iter(window)
                .next()
                .map(|m| (m.start, pattern_lens[m.pattern_id as usize])),
        }
    }
}

/// Compute split position combining single-byte delimiters AND multi-byte patterns.
///
/// Checks both delimiter and multi-pattern searches, picks the rightmost match
/// (backward) or leftmost match (forward fallback). This allows `.delimiters()`
/// and `.patterns()` to be used together.
#[inline]
#[allow(clippy::too_many_arguments)]
pub fn compute_split_at_combined(
    text: &[u8],
    pos: usize,
    end: usize,
    delimiters: &[u8],
    table: Option<&[bool; 256]>,
    multi_searcher: Option<&MultiPatternSearcher>,
    prefix_mode: bool,
    consecutive: bool,
    forward_fallback: bool,
) -> usize {
    let target_end = end.min(text.len());
    let window = &text[pos..target_end];

    // --- Backward search: find rightmost match across both sources ---
    let mut best_pos: Option<usize> = None;
    let mut best_pat_len: usize = 1; // default for single-byte delimiters

    // Check single-byte delimiters
    if !delimiters.is_empty()
        && let Some(found) =
            find_delimiter_boundary(text, delimiters, table, pos, target_end, consecutive, false)
        && found > pos
        && found < text.len()
    {
        best_pos = Some(found);
        best_pat_len = 1;
    }

    // Check multi-byte patterns
    if let Some(searcher) = multi_searcher
        && let Some((rel_pos, pat_len)) = searcher.find_last(window)
    {
        let abs_pos = pos + rel_pos;
        if abs_pos > pos {
            match best_pos {
                None => {
                    best_pos = Some(abs_pos);
                    best_pat_len = pat_len;
                }
                Some(bp) if abs_pos > bp => {
                    best_pos = Some(abs_pos);
                    best_pat_len = pat_len;
                }
                _ => {}
            }
        }
    }

    // If we found something in backward search, apply prefix/suffix mode
    if let Some(found_pos) = best_pos {
        return if prefix_mode {
            found_pos
        } else {
            found_pos + best_pat_len
        };
    }

    // --- Forward fallback: find leftmost match across both sources ---
    if forward_fallback && target_end < text.len() {
        let mut first_pos: Option<usize> = None;
        let mut first_pat_len: usize = 1;

        // Check single-byte delimiters forward
        if !delimiters.is_empty()
            && let Some(found) =
                find_delimiter_boundary(text, delimiters, table, pos, target_end, consecutive, true)
        {
            // find_delimiter_boundary with forward_fallback returns positions >= target_end
            // or text.len() as sentinel
            if found >= target_end && found < text.len() {
                first_pos = Some(found);
                first_pat_len = 1;
            } else if found == text.len() {
                first_pos = Some(text.len());
            }
        }

        // Check multi-byte patterns forward
        if let Some(searcher) = multi_searcher {
            let forward_window = &text[target_end..];
            if let Some((rel_pos, pat_len)) = searcher.find_first(forward_window) {
                let abs_pos = target_end + rel_pos;
                match first_pos {
                    None => {
                        first_pos = Some(abs_pos);
                        first_pat_len = pat_len;
                    }
                    Some(fp) if abs_pos < fp => {
                        first_pos = Some(abs_pos);
                        first_pat_len = pat_len;
                    }
                    _ => {}
                }
            } else if first_pos.is_none() {
                first_pos = Some(text.len());
            }
        }

        if let Some(found_pos) = first_pos {
            if found_pos == text.len() {
                return text.len();
            }
            return if prefix_mode {
                found_pos
            } else {
                found_pos + first_pat_len
            };
        }
    }

    // No match anywhere — hard split at target
    end
}

/// Compute the split position given the current state.
///
/// Returns the position to split at, handling pattern mode vs delimiter mode,
/// prefix vs suffix mode, and the special `text.len()` signal.
#[inline]
#[allow(clippy::too_many_arguments)]
pub fn compute_split_at(
    text: &[u8],
    pos: usize,
    end: usize,
    pattern: Option<&[u8]>,
    delimiters: &[u8],
    table: Option<&[bool; 256]>,
    prefix_mode: bool,
    consecutive: bool,
    forward_fallback: bool,
) -> usize {
    if let Some(pattern) = pattern {
        // Multi-byte pattern mode
        match find_pattern_boundary(text, pattern, pos, end, consecutive, forward_fallback) {
            Some(found_pos) => {
                if found_pos == text.len() {
                    // Special case: text.len() means "take all remaining"
                    found_pos
                } else if prefix_mode {
                    // Split BEFORE pattern (pattern goes to next chunk)
                    if found_pos == pos { end } else { found_pos }
                } else {
                    // Split AFTER pattern (pattern stays with current chunk)
                    found_pos + pattern.len()
                }
            }
            None => end, // No pattern found, hard split at target
        }
    } else {
        // Single-byte delimiters mode
        match find_delimiter_boundary(
            text,
            delimiters,
            table,
            pos,
            end,
            consecutive,
            forward_fallback,
        ) {
            Some(found_pos) => {
                if found_pos == text.len() {
                    // Special case: text.len() means "take all remaining"
                    found_pos
                } else if prefix_mode {
                    // Split BEFORE delimiter (delimiter goes to next chunk)
                    if found_pos == pos { end } else { found_pos }
                } else {
                    // Split AFTER delimiter (delimiter stays with current chunk)
                    found_pos + 1
                }
            }
            None => end, // No delimiter found, hard split at target
        }
    }
}