Skip to content

Update README.md #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ScarletBlue wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# IBLT

Invertible bloom lookup table implementation in rust.
An Invertible Bloom Lookup Table implementation in the Rust programming language.
Copy link
Contributor

@remagpie remagpie Apr 8, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think in XXX is quite a common sentence.
(eg. ed25519-dalek)


`IBLT` uses bincode for serialization/deserialization of key and values, so both key and value type must implement `Serialize` and `Deserialize`. If two serialized values have different length, zero padding is added at the end of shorter value for xor operation.
`IBLT` uses bincode for serialization/deserialization of key and values, so both key and value type must implement `Serialize` and `Deserialize`. If two serialized values have different lengths, zero padding is added at the end of the shorter value for xor operation.

Hash function can be specified by creating `IBLT` with `with_hasher` function. Hash value for `hash_sum` is calculated as `hash(val)`, and index is calculated as `hash(hash(val)), hash(hash(hash(val))), ...`. If hasher is not specified, `DefaultHasher` from `std::collections::hash_map` is used.
A hash function can be specified by creating an `IBLT` with the `with_hasher` function. The hash value for `hash_sum` is calculated as `hash(val)`, and the index is calculated as `hash(hash(val)), hash(hash(hash(val))), ...`. If the hasher is not specified, `DefaultHasher` from `std::collections::hash_map` is used.

## Example
```rust
Expand Down