https://github.com/bluss/twoway

Twoway / Fast substring search for strings and byte strings (Rust) / Also assorted benchmarks and string search snippets
https://github.com/bluss/twoway

exact-string-matching rust string-search

Last synced: 6 days ago
JSON representation

Twoway / Fast substring search for strings and byte strings (Rust) / Also assorted benchmarks and string search snippets

• Host: GitHub
• URL: https://github.com/bluss/twoway
• Owner: bluss
• License: apache-2.0
• Created: 2015-06-15T21:58:42.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2021-05-19T22:07:17.000Z (over 3 years ago)
• Last Synced: 2024-12-08T11:51:36.316Z (14 days ago)
• Topics: exact-string-matching, rust, string-search
• Language: Rust
• Homepage: https://docs.rs/twoway/
• Size: 80.1 KB
• Stars: 65
• Watchers: 5
• Forks: 5
• Open Issues: 4
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        

This is my substring search workspace.

Please read the `API documentation here`__

__ https://docs.rs/twoway/

|build_status|_ |crates|_

.. |build_status| image:: https://travis-ci.org/bluss/twoway.svg?branch=master

.. _build_status: https://travis-ci.org/bluss/twoway

.. |crates| image:: http://meritbadge.herokuapp.com/twoway

.. _crates: https://crates.io/crates/twoway

Documentation

-------------

Fast substring search for strings and byte strings, using the `two-way algorithm`_.

This is the same code as is included in Rust's libstd to “power” ``str::find(&str)``,

but here it is exposed with some improvements:

- Available for byte string searches using ``&[u8]``

- Having an optional SSE4.2 accelerated version (if detected at runtime) which is even faster.

- Using ``memchr`` for the single byte case, which is ultra fast.

- ``twoway::find_bytes(text: &[u8], pattern: &[u8]) -> Option``

- ``twoway::rfind_bytes(text: &[u8], pattern: &[u8]) -> Option``

- ``twoway::find_str(text: &str, pattern: &str) -> Option``

- ``twoway::rfind_str(text: &str, pattern: &str) -> Option``

Recent Changes

--------------

- 0.2.1

  - Update dev-deps

- 0.2.0

  - Use `std::arch` and transparently support SSE4.2 when possible (x86 and

    x86-64 only) to enable an accelerated implementation of the algorithm.

    Forward search only. By @RReverser and @bluss

  - Fix a bug in the SSE4.2 algorithm that made it much slower than it should have been,

    so performance increases as well.

  - Requires Rust 1.27

- 0.1.8

  - Tweak crate keywords by @tari

  - Only testing and benchmarking changes otherwise (no changes to the crate itself)

- 0.1.7

  - The crate is optionally ``no_std``. Regular and ``pcmp`` both support this

    mode.

- 0.1.6

  - The hidden and internal test module set, technically pub, was removed from

    standard compilation.

- 0.1.5

  - Update from an odds dependency to using ``unchecked-index`` instead

    (only used by the pcmp feature).

  - The hidden and internal test module tw, technically pub, was removed from

    standard compilation.

- 0.1.4

  - Update memchr dependency to 2.0

- 0.1.3

  - Link to docs.rs docs

  - Drop ``pcmp``'s itertools dependency

  - Update nightly code for recent changes

- 0.1.2

  - Internal improvements to the ``pcmp`` module.

- 0.1.1

  - Add ``rfind_bytes``, ``rfind_str``

- 0.1.0

  - Initial release

  - Add ``find_bytes``, ``find_str``

License

-------

MIT / APACHE-2.0

Interesting Links

-----------------

.. _`two-way algorithm`: http://www-igm.univ-mlv.fr/~lecroq/string/node26.html

- Two Way: http://www-igm.univ-mlv.fr/~lecroq/string/node26.html

- Matters Computational: http://www.jjj.de/fxt/#fxtbook

Notes

-----

Consider denying 0/n factorizations, see

http://lists.gnu.org/archive/html/bug-gnulib/2010-06/msg00184.html