[go: up one dir, main page]

twoway 0.1.8

Fast substring search for strings and byte strings. Optional SSE4.2 acceleration (requires nightly and cargo feature flag pcmp) using pcmpestri. Memchr is the only mandatory dependency. The two way algorithm is also used by rust's libstd itself, but here it is exposed both for byte strings, using memchr, and optionally using a SSE4.2 accelerated version.
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
#![feature(test)]
#![feature(
    pattern, )]

#![allow(unused_imports)]
extern crate test;
#[cfg(feature = "jetscii")]
extern crate jetscii;
extern crate itertools;
extern crate odds;
#[cfg(feature = "benchmarks")]
extern crate galil_seiferas;
extern crate unchecked_index;

extern crate twoway;

#[cfg(unused)]
macro_rules! regex {
    ($e:expr) => (::regex::Regex::new($e).unwrap());
}

pub use twoway::{Str};

use std::str::pattern::{Pattern, Searcher, ReverseSearcher};
use test::{Bencher, black_box};

use twoway::find_str as tw_find;
use twoway::rfind_str as tw_rfind;

pub fn is_prefix(text: &str, pattern: &str) -> bool {
    Str(pattern).is_prefix_of(text)
}

pub fn memmem(text: &str, pattern: &str) -> bool {
    #[allow(improper_ctypes)]
    extern { fn memmem(s1: *const u8, m: usize, s2: *const u8, pattern: usize) -> *const u8; }
    unsafe {
        memmem(text.as_ptr(),
               text.len(),
               pattern.as_ptr(),
               pattern.len()) != 0 as *mut u8
    }

}

macro_rules! get {
    ($slice:expr, $index:expr) => {
        unsafe { ::unchecked_index::get_unchecked(&$slice, $index) }
    }
}

fn brute_force<T: Eq>(text: &[T], pattern: &[T]) -> Option<usize> {
    let n = text.len();
    let m = pattern.len();
    if n < m {
        return None;
    }
    'outer: for i in 0..n - m + 1 {

        /* to use memcmp:
         * it's a tradeoff; memcmp is faster with more pathological-y inputs!
         * for relistic inputs where we quickly find a mismatch at most
         * postions, it's faster using just single element get.
        if get!(text, i .. i + m) == pattern {
            return Some(i);
        }
        */

        for j in 0..m {
            if get!(text, i + j) != get!(pattern, j) {
                continue 'outer;
            }
        }
        return Some(i);
    }
    None
}


macro_rules! bench_contains_vs_tw {
    ($name: ident, $hay: expr, $n: expr) => {
        pub mod $name {
            use super::{test, tw_find, tw_rfind,
                LONG,
                LONG_CY,
            };
            use itertools::Itertools;
            use twoway::TwoWaySearcher;
            use test::{Bencher, black_box};
            #[cfg(feature = "jetscii")]
            use jetscii::Substring;
            use odds::string::StrExt;

            #[bench]
            pub fn find(b: &mut Bencher) {
                let haystack = black_box($hay);
                let needle = black_box($n);
                b.iter(|| {
                    test::black_box(haystack.find(&needle));
                });
                b.bytes = haystack.len() as u64;
            }

            #[bench]
            pub fn rfind(b: &mut Bencher) {
                let haystack = black_box($hay);
                let needle = black_box($n);
                b.iter(|| {
                    test::black_box(haystack.rfind(&needle));
                });
                b.bytes = haystack.len() as u64;
            }

            /*
            #[bench]
            pub fn regex_find(b: &mut Bencher) {
                let haystack = black_box($hay);
                let needle = black_box($n);
                let reg = regex!(&needle);
                b.iter(|| {
                    reg.find(&haystack)
                });
                b.bytes = haystack.len() as u64;
            }
            */

            #[cfg(feature = "jetscii")]
            #[bench]
            pub fn jetscii_find(b: &mut Bencher) {
                let haystack = black_box($hay);
                let needle = black_box($n);
                b.iter(|| {
                    haystack.find(Substring::new(&needle))
                });
                b.bytes = haystack.len() as u64;
            }

            /*
            #[bench]
            pub fn str_is_prefix(b: &mut Bencher) {
                let haystack = $hay;
                let needle = $n;
                b.iter(|| {
                    let needle = test::black_box(&needle);
                    let haystack = test::black_box(&haystack);
                    test::black_box(needle.is_prefix_of(haystack));
                });
                b.bytes = needle.len() as u64;
            }
            */

            /*
            #[bench]
            pub fn str_first_reject(b: &mut Bencher) {
                let haystack = $hay;
                let needle = $n;
                b.iter(|| {
                    let needle = test::black_box(&needle);
                    let haystack = test::black_box(&haystack);
                    test::black_box(needle.into_searcher(haystack).next_reject())
                });
            }
            */

            #[cfg(feature = "pcmp")]
            #[bench]
            pub fn pcmp_find(b: &mut Bencher) {
                let haystack = black_box($hay);
                let needle = black_box($n);
                b.iter(|| {
                    test::black_box(::twoway::pcmp::find(haystack.as_bytes(), needle.as_bytes()));
                });
                b.bytes = haystack.len() as u64;
            }

            #[bench]
            pub fn bmh_find(b: &mut Bencher) {
                let haystack = black_box($hay);
                let needle = black_box($n);
                b.iter(|| {
                    test::black_box(::twoway::bmh::find(haystack.as_bytes(), needle.as_bytes()));
                });
                b.bytes = haystack.len() as u64;
            }

            #[bench]
            pub fn memmem(b: &mut Bencher) {
                let haystack = black_box($hay);
                let needle = black_box($n);
                b.iter(|| {
                    test::black_box(::memmem(&haystack, &needle));
                });
                b.bytes = haystack.len() as u64;
            }

            #[bench]
            pub fn twoway_find(b: &mut Bencher) {
                let haystack = $hay;
                let needle = $n;
                b.iter(|| {
                    let needle = test::black_box(&needle);
                    let haystack = test::black_box(&haystack);
                    test::black_box(tw_find(haystack, needle));
                });
                b.bytes = haystack.len() as u64;
            }


            #[cfg(feature = "benchmarks")]
            #[bench]
            pub fn gs_find(b: &mut Bencher) {
                let haystack = $hay;
                let needle = $n;
                b.iter(|| {
                    let needle = test::black_box(&needle);
                    let haystack = test::black_box(&haystack);
                    ::galil_seiferas::gs_find(haystack.as_bytes(), needle.as_bytes())
                });
                b.bytes = haystack.len() as u64;
            }

            #[bench]
            pub fn brute_force(b: &mut Bencher) {
                let haystack = $hay;
                let needle = $n;
                b.iter(|| {
                    let needle = test::black_box(&needle);
                    let haystack = test::black_box(&haystack);
                    ::brute_force(haystack.as_bytes(), needle.as_bytes())
                });
                b.bytes = haystack.len() as u64;
            }

            #[bench]
            pub fn twoway_rfind(b: &mut Bencher) {
                let haystack = $hay;
                let needle = $n;
                b.iter(|| {
                    let needle = test::black_box(&needle);
                    let haystack = test::black_box(&haystack);
                    test::black_box(tw_rfind(haystack, needle));
                });
                b.bytes = haystack.len() as u64;
            }

            /*
            #[bench]
            pub fn tw_is_prefix(b: &mut Bencher) {
                let haystack = $hay;
                let needle = $n;
                b.iter(|| {
                    let needle = test::black_box(&needle);
                    let haystack = test::black_box(&haystack);
                    test::black_box(is_prefix(haystack, needle));
                });
                b.bytes = needle.len() as u64;
            }
            */

            #[bench]
            pub fn twoway_new(b: &mut Bencher) {
                let needle = black_box($n);
                b.iter(|| {
                    let needle = needle.as_bytes();
                    let t = TwoWaySearcher::new(needle, 1);
                    t
                });
                b.bytes = needle.len() as u64;
            }

            /*
            #[bench]
            pub fn pcmp_is_prefix(b: &mut Bencher) {
                let haystack = $hay;
                let needle = $n;
                b.iter(|| {
                    let needle = test::black_box(&needle);
                    let haystack = test::black_box(&haystack);
                    let l = ::std::cmp::min(needle.len(), haystack.len());
                    l == ::twoway::pcmp::shared_prefix(haystack.as_bytes(), needle.as_bytes())
                });
                b.bytes = needle.len() as u64;
            }
            */

            /*
            #[bench]
            pub fn tw_first_reject(b: &mut Bencher) {
                let haystack = $hay;
                let needle = $n;
                b.iter(|| {
                    let needle = test::black_box(&needle);
                    let haystack = test::black_box(&haystack);
                    test::black_box(Str(needle).into_searcher(haystack).next_reject())
                });
            }
            */

            /*
            #[bench]
            pub fn tw_paper(b: &mut Bencher) {
                use twoway::tw::{find_first, Str};
                let haystack = $hay;
                let needle = $n;
                b.iter(|| {
                    let needle = test::black_box(Str(needle.as_bytes()));
                    let haystack = test::black_box(Str(haystack.as_bytes()));
                    test::black_box(find_first(haystack, needle));
                });
                b.bytes = haystack.len() as u64;
            }
            */
        }
    }
}


static LONG: &'static str = "\
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse quis lorem sit amet dolor \
ultricies condimentum. Praesent iaculis purus elit, ac malesuada quam malesuada in. Duis sed orci \
eros. Suspendisse sit amet magna mollis, mollis nunc luctus, imperdiet mi. Integer fringilla non \
sem ut lacinia. Fusce varius tortor a risus porttitor hendrerit. Morbi mauris dui, ultricies nec \
tempus vel, gravida nec quam.

In est dui, tincidunt sed tempus interdum, adipiscing laoreet ante. Etiam tempor, tellus quis \
sagittis interdum, nulla purus mattis sem, quis auctor erat odio ac tellus. In nec nunc sit amet \
diam volutpat molestie at sed ipsum. Vestibulum laoreet consequat vulputate. Integer accumsan \
lorem ac dignissim placerat. Suspendisse convallis faucibus lorem. Aliquam erat volutpat. In vel \
eleifend felis. Sed suscipit nulla lorem, sed mollis est sollicitudin et. Nam fermentum egestas \
interdum. Curabitur ut nisi justo.

Sed sollicitudin ipsum tellus, ut condimentum leo eleifend nec. Cras ut velit ante. Phasellus nec \
mollis odio. Mauris molestie erat in arcu mattis, at aliquet dolor vehicula. Quisque malesuada \
lectus sit amet nisi pretium, a condimentum ipsum porta. Morbi at dapibus diam. Praesent egestas \
est sed risus elementum, eu rutrum metus ultrices. Etiam fermentum consectetur magna, id rutrum \
felis accumsan a. Aliquam ut pellentesque libero. Sed mi nulla, lobortis eu tortor id, suscipit \
ultricies neque. Morbi iaculis sit amet risus at iaculis. Praesent eget ligula quis turpis \
feugiat suscipit vel non arcu. Interdum et malesuada fames ac ante ipsum primis in faucibus. \
Aliquam sit amet placerat lorem.

Cras a lacus vel ante posuere elementum. Nunc est leo, bibendum ut facilisis vel, bibendum at \
mauris. Nullam adipiscing diam vel odio ornare, luctus adipiscing mi luctus. Nulla facilisi. \
Mauris adipiscing bibendum neque, quis adipiscing lectus tempus et. Sed feugiat erat et nisl \
lobortis pharetra. Donec vitae erat enim. Nullam sit amet felis et quam lacinia tincidunt. Aliquam \
suscipit dapibus urna. Sed volutpat urna in magna pulvinar volutpat. Phasellus nec tellus ac diam \
cursus accumsan.

Nam lectus enim, dapibus non nisi tempor, consectetur convallis massa. Maecenas eleifend dictum \
feugiat. Etiam quis mauris vel risus luctus mattis a a nunc. Nullam orci quam, imperdiet id \
vehicula in, porttitor ut nibh. Duis sagittis adipiscing nisl vitae congue. Donec mollis risus eu \
leo suscipit, varius porttitor nulla porta. Pellentesque ut sem nec nisi euismod vehicula. Nulla \
malesuada sollicitudin quam eu fermentum.";

static LONG_CY: &'static str = "\
Брутэ дольорэ компрэхэнжам йн эжт, ючю коммюны дылыктуч эа, квюо льаорыыт вёвындо мэнандря экз. Ед ыюм емпыдит аккюсам, нык дйкит ютенам ад. Хаж аппэтырэ хонэзтатёз нэ. Ад мовэт путант юрбанйтаж вяш.

Коммодо квюальизквюэ абхоррэант нэ ыюм, праэчынт еракюндйа ылаборарэт эю мыа. Нэ квуым жюмо вольуптатибюж вяш, про ыт бонорюм вёвындо, мэя юллюм новум ку. Пропрёаы такематыш атоморюм зыд ан. Эи омнэжквюы оффекйяж компрэхэнжам жят, апыирёан конкыптам ёнкорруптэ ючю ыт.

Жят алёа лэгыры ед, эи мацим оффэндйт вим. Нык хёнк льаборэж йн, зыд прима тимэам ан. Векж нужквюам инимёкюж ты, ыам эа омнеж ырант рэформйданч. Эрож оффекйяж эю вэл.

Ад нам ножтрюд долорюм, еюж ут вэрыар эюрйпйдяч. Квюач аффэрт тинкидюнт про экз, дёкант вольуптатибюж ат зыд. Ыт зыд экшырки констятюам. Квюо квюиж юрбанйтаж ометтантур экз, хёз экз мютат граэкы рыкючабо, нэ прё пюрто элитр пэрпэтюа. Но квюандо минемум ыам.

Амэт лыгимуз ометтантур кюм ан. Витюпырата котёдиэквюэ нам эю, эю вокынт алёквюам льебэравичсы жят. Экз пыртенакж янтэрэсщэт инзтруктеор нам, еюж ад дйкит каючаэ, шэа витаэ конжтетуто ут. Квюач мандамюч кюм ат, но ёнкорруптэ рэформйданч ючю, незл либриз аюдирэ зыд эи. Ты эож аугюэ иреуры льюкяльиюч, мэль алььтыра докэндё омнэжквюы ат. Анёмал жямиляквюы аккоммодары ыам нэ, экз пэрчёус дэфянятйоныс квюо. Эи дуо фюгит маиорюм.

Эвэртё партйэндо пытынтёюм ыюм ан, шэа ку промпта квюаырэндум. Агам дикунт вим ку. Мюкиуж аюдиам тамквюам про ут, ку мыа квюод квюот эррэм, вяш ад номинави зючкёпит янжольэнж. Нык эи пожжёт путант эффякиантур. Ку еюж нощтыр контынтёонэж. Кюм йужто харюм ёужто ад, ыюм оратио квюоджё экз.

Чонэт факэтэ кюм ан, вэре факэр зальютатуж мэя но. Ыюм ут зальы эффикеэнди, экз про алиё конжыквуюнтюр. Квуй ыльит хабымуч ты, алёа омнэжквюы мандамюч шэа ыт, пльакырат аккюжамюз нэ мэль. Хаж нэ партым нюмквуам прёнкипыз, ат импэрдеэт форынчйбюж кончэктэтюыр шэа. Пльакырат рэформйданч эи векж, ючю дюиж фюйзчыт эи.

Экз квюо ажжюм аугюэ, ат нык мёнём анёмал кытэрож. Кюм выльёт эрюдитя эа. Йн порро малйж кончэктэтюыр хёз, жят кашы эрюдитя ат. Эа вяш мацим пыртенакж, но порро утамюр дяшзынтиыт кюм. Ыт мютат зючкёпит эож, нэ про еракюндйа котёдиэквюэ. Квуй лаудым плььатонэм ед, ку вим ножтрюм лаборамюз.

Вёжи янвыняры хаж ед, ты нолюёжжэ индоктум квуй. Квюач тебиквюэ ут жят, тальэ адхюк убяквюэ йн эож. Ыррор бландит вяш ан, ютроквюы нолюёжжэ констятюам йн ыюм, жят эи прима нобёз тхэопхражтуз. Ты дёкант дэльэнйт нолюёжжэ пэр, молыжтйаы модыратиюз интыллыгам ку мэль.

Ад ылаборарэт конжыквуюнтюр ентырпрытаряш прё, факэтэ лыгэндоч окюррырэт вим ад, элитр рэформйданч квуй ед. Жюмо зальы либриз мэя ты. Незл зюаз видишчы ан ыюм, но пожжэ молыжтйаы мэль. Фиэрэнт адипижкй ометтантур квюо экз. Ут мольлиз пырикюлёз квуй. Ыт квюиж граэко рыпудяары жят, вим магна обльйквюэ контынтёонэж эю, ты шэа эним компльыктётюр.
";

bench_contains_vs_tw!(short_short,
    "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
    "tis");

// a word with some uncommon letters
bench_contains_vs_tw!(short_word1_long,
    LONG,
    "english");

// a word of only common letters (but does not appear)
bench_contains_vs_tw!(short_word2_long,
    LONG,
    "lite");

bench_contains_vs_tw!(short_1let_long,
    LONG,
    "z");

bench_contains_vs_tw!(short_2let_rare,
    LONG,
    "qq");

bench_contains_vs_tw!(short_2let_common,
    LONG,
    "uu");

bench_contains_vs_tw!(short_3let_long,
    LONG,
    "aga");

bench_contains_vs_tw!(short_1let_cy,
    LONG_CY,
    "Ѯ");

bench_contains_vs_tw!(short_2let_cy,
    LONG_CY,
    "оо");

bench_contains_vs_tw!(short_3let_cy,
    LONG_CY,
    "коэ");

bench_contains_vs_tw!(naive,
    "a".repeat(250),
    "aaaaaaaab");

bench_contains_vs_tw!(naive_rev,
    "a".repeat(250),
    "baaaaaaaa");

bench_contains_vs_tw!(naive_longpat,
    "a".repeat(100_000),
    "a".repeat(24).append("b"));

bench_contains_vs_tw!(naive_longpat_reversed,
    "a".repeat(100_000),
    "b".append(&"a".repeat(24)));

bench_contains_vs_tw!(bb_in_aa,
    "a".repeat(100_000),
    "b".repeat(100));

bench_contains_vs_tw!(aaab_in_aab,
    "aab".repeat(100_000),
    "aaab".repeat(100));

bench_contains_vs_tw!(periodic2,
    "bb".append(&"ab".repeat(99)).repeat(100),
    "ab".repeat(100));

bench_contains_vs_tw!(periodic5,
    "bacba".repeat(39).append("bbbbb").repeat(40),
    "bacba".repeat(40));

// This one is two-way specific
bench_contains_vs_tw!(pathological_two_way,
    "dac".repeat(20_000),
    "bac");

// This one is two-way specific
bench_contains_vs_tw!(pathological_two_way_rev,
    "cad".repeat(20_000),
    "cab");

bench_contains_vs_tw!(bbbaaa,
    "aab".repeat(100_000),
    "b".repeat(100) + &"a".repeat(100));

bench_contains_vs_tw!(aaabbb,
    "aab".repeat(100_000),
    "a".repeat(100) + &"b".repeat(100));

bench_contains_vs_tw!(allright,
    "allrightagtogether".repeat(10_000),
     "allrightaltogether");

bench_contains_vs_tw!(gllright,
    "gllrightaltogether".repeat(10_000),
     "allrightaltogether");


/*
bench_contains_vs_tw!(long_prefix,
    (0..20_000).map(|_| "cad").collect::<String>(),
    (0..100).map(|_| "cad").collect::<String>());
    */

/*
bench_contains_vs_tw!(pathological_test1,
    (0..10_000).map(|_| "daaaaaaaaacc").collect::<String>(),
    (0..100).map(|_| "eaaaaaaaaacc").collect::<String>());
    */

/*
// This one is two-way specific
bench_contains_vs_tw!(long_trim,
    (0..20_000).map(|_| "abcd").collect::<String>(),
    "abc");
    */

#[bench]
pub fn find_char_1(b: &mut Bencher) {
    let haystack = black_box(LONG);
    let needle = black_box('z');
    b.iter(|| {
        let t = haystack.find(needle);
        t
    });
    b.bytes = haystack.len() as u64;
}

#[bench]
pub fn find_char_2(b: &mut Bencher) {
    let haystack = black_box(LONG);
    let needle = black_box('ö');
    b.iter(|| {
        let t = haystack.find(needle);
        t
    });
    b.bytes = haystack.len() as u64;
}

#[bench]
pub fn find_char_3(b: &mut Bencher) {
    let haystack = black_box(LONG);
    let needle = black_box('α');
    b.iter(|| {
        let t = haystack.find(needle);
        t
    });
    b.bytes = haystack.len() as u64;
}

#[bench]
pub fn rfind_char_1(b: &mut Bencher) {
    let haystack = black_box(LONG);
    let needle = black_box('z');
    b.iter(|| {
        let t = haystack.rfind(needle);
        t
    });
    b.bytes = haystack.len() as u64;
} 

#[cfg(feature = "test-set")]
fn bench_data() -> Vec<u8> { vec![0u8; 256 * 1024] }

#[cfg(feature = "test-set")]
#[bench]
pub fn rfind_byte_1(b: &mut Bencher) {
    let haystack = black_box(bench_data());
    let needle = black_box('x');
    b.iter(|| {
        let t = ::twoway::set::rfind_byte(needle as u8, &haystack);
        t
    });
    b.bytes = haystack.len() as u64;
}

#[cfg(feature = "test-set")]
#[bench]
pub fn find_byte_1(b: &mut Bencher) {
    let haystack = black_box(bench_data());
    let needle = black_box('x');
    b.iter(|| {
        let t = ::twoway::set::find_byte(needle as u8, &haystack);
        t
    });
    b.bytes = haystack.len() as u64;
}