Will close part of #4

The code implementation (set/mod.rs) will be push/rebase in thie branch. Besides the code, the draft will be edit in HackMD before ready to publish. Please feel free to add/suggest good topics to cover! 👉https://hackmd.io/VsM13vR1TrKzVRsKpHuTjA?both

I want to accomplish the "Skip list" for searching. Used in leveldb. However, I could only make it with unsafe Rust and not sure there are no memory leak.

• [x] Skip list.

I noticed the TODO message along with the helpful hints in the HashMap implementation:

https://github.com/weihanglo/rust-algorithm-club/blob/188bb59ee0808dd0da4632eccf3b1cce192ed2be/src/collections/hash_map/mod.rs#L61-L86

if it's not currently under development, I would love to give it a try!

OS: macOS 10.14.1 rustc version: 1.28.0

    Checking rust-algorithm-club v0.0.1 (file:///Users/henry/Develop/rust-algorithm-club)
error[E0309]: the parameter type `T` may not live long enough
  --> src/collections/singly_linked_list/mod.rs:31:5
   |
30 | pub struct Iter<'a, T> {
   |                     - help: consider adding an explicit lifetime bound `T: 'a`...
31 |     next: Option<&'a Node<T>>,
   |     ^^^^^^^^^^^^^^^^^^^^^^^^^
   |
note: ...so that the reference type `&'a collections::singly_linked_list::Node<T>` does not outlive the data it points at
  --> src/collections/singly_linked_list/mod.rs:31:5
   |
31 |     next: Option<&'a Node<T>>,
   |     ^^^^^^^^^^^^^^^^^^^^^^^^^

error[E0309]: the parameter type `T` may not live long enough
  --> src/collections/singly_linked_list/mod.rs:38:5
   |
37 | pub struct IterMut<'a, T> {
   |                        - help: consider adding an explicit lifetime bound `T: 'a`...
38 |     next: Option<&'a mut Node<T>>,
   |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
   |
note: ...so that the reference type `&'a mut collections::singly_linked_list::Node<T>` does not outlive the data it points at
  --> src/collections/singly_linked_list/mod.rs:38:5
   |
38 |     next: Option<&'a mut Node<T>>,
   |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

error[E0309]: the parameter type `T` may not live long enough
   --> src/collections/singly_linked_list/mod.rs:229:5
    |
228 | impl<'a, T> Iterator for Iter<'a, T> {
    |          - help: consider adding an explicit lifetime bound `T: 'a`...
229 |     type Item = &'a T;
    |     ^^^^^^^^^^^^^^^^^^
    |
note: ...so that the reference type `&'a T` does not outlive the data it points at
   --> src/collections/singly_linked_list/mod.rs:229:5
    |
229 |     type Item = &'a T;
    |     ^^^^^^^^^^^^^^^^^^

error[E0309]: the parameter type `T` may not live long enough
   --> src/collections/singly_linked_list/mod.rs:242:5
    |
241 | impl<'a, T> Iterator for IterMut<'a, T> {
    |          - help: consider adding an explicit lifetime bound `T: 'a`...
242 |     type Item = &'a mut T;
    |     ^^^^^^^^^^^^^^^^^^^^^^
    |
note: ...so that the reference type `&'a mut T` does not outlive the data it points at
   --> src/collections/singly_linked_list/mod.rs:242:5
    |
242 |     type Item = &'a mut T;
    |     ^^^^^^^^^^^^^^^^^^^^^^

error: aborting due to 4 previous errors

For more information about this error, try `rustc --explain E0309`.
error: Could not compile `rust-algorithm-club`.

To learn more, run the command again with --verbose.

error message

error: failed to parse manifest at `/Users/henry/Develop/rust-algorithm-club/Cargo.toml`

Caused by:
  editions are unstable

Caused by:
  feature `edition` is required

this Cargo does not support nightly features, but if you
switch to nightly channel you can add
`cargo-features = ["edition"]` to enable this feature

Here are some abstract data type need documentations and implementations.

• [x] stack #23
• [x] queue #37
• [ ] deque #44

Feel free to pick the one you like and leave comments below. Hands on coding!

Here are some variants of binary search algorithm that needs well-documented implementations and tutorials.

• [x] Interpolation search - Done at ba962fd7723fd61d9a54b4a403eed6d3777e416d
• [x] Exponential search - Done at https://github.com/weihanglo/rust-algorithm-club/pull/9

Feel free to pick the one you like and leave comments below. Hands on coding!

Currently we depend on nightly compiler to pass all CI process and deploy automatically. (Related issue https://github.com/weihanglo/rust-algorithm-club/commit/bab20832e55f2e040f9c7ed45141475c4bc1b2d6)

Plan to switch back to stable Rust when 2018 edition is available on stable channel.

In this function you use the unsafe keyword for some safe expressions.

We need to mark unsafe operations more precisely using unsafe keyword. Keeping unsafe blocks small can bring many benefits. For example, when mistakes happen, we can locate any errors related to memory safety within an unsafe block. This is the balance between Safe and Unsafe Rust. The separation is designed to make using Safe Rust as ergonomic as possible, but requires extra effort and care when writing Unsafe Rust.

Hope this PR can help you. Best regards. References https://doc.rust-lang.org/nomicon/safe-unsafe-meaning.html https://doc.rust-lang.org/book/ch19-01-unsafe-rust.html

I am going to implement this one. Which category do you want it to belong with?

Reference: https://rcoh.me/posts/linear-time-median-finding/ https://en.wikipedia.org/wiki/Median_of_medians

The generated Rust doc is public now. Yet it seems too dumb and lack some descriptions. The crate and each modules need to be documented.

For crate doc itself, suppose we can reuse the English version of the root README.md file. Concerning module level docs, the Chinese articles are also absent. We should write down both English and Chinese intros for these three modules.

Any thought Rustaceans?

Missing Docs

• [ ] crate itself
• [ ] searching module
• [ ] collections module
• [ ] sorting module

Here are some linked list implementations and tutorials that need helps.

• [ ] Circular linked list
• [ ] Doubly linked list - WIP at draft/doubly-linked-list

Feel free to pick the one you like and leave comments below. Hands on coding!

Here are some associative container variants that needs well-documented implementations and tutorials.

• [ ] Multimap
• [ ] Ordered Map
• [x] Set #15
• [x] Bloom filter #34

Feel free to pick the one you like and leave comments below. Hands on coding!

Here are some efficient sorting algorithms that needs well-documented implementations and tutorials.

• [ ] Timsort - WIP at draft/timsort
• [ ] Pdqsort
• [ ] Introsort

Feel free to pick the one you like and leave comments below. Hands on coding!