smeagol 0.1.2

Conway's Game of Life using HashLife and SIMD.
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

# smeagol

[![Build status](https://img.shields.io/travis/com/billyrieger/smeagol.svg)](https://travis-ci.com/billyrieger/smeagol)
[![Coverage](https://img.shields.io/codecov/c/github/billyrieger/smeagol.svg)](https://codecov.io/gh/billyrieger/smeagol/branch/master)
[![Lines of code](https://tokei.rs/b1/github/billyrieger/smeagol)](https://github.com/Aaronepower/tokei)
[![Version](https://img.shields.io/crates/v/smeagol.svg)](https://crates.io/crates/smeagol)
[![Documentation](https://docs.rs/smeagol/badge.svg)](https://docs.rs/smeagol/)
[![License](https://img.shields.io/crates/l/smeagol.svg)](https://github.com/billyrieger/smeagol/blob/master/LICENSE)
[![Dependency status](https://deps.rs/repo/github/billyrieger/smeagol/status.svg)](https://deps.rs/repo/github/billyrieger/smeagol)
[![Rust version](https://img.shields.io/badge/rust-nightly-lightgrey.svg)](https://www.rust-lang.org/)

## Introduction

`smeagol` is a Rust library built to efficiently simulate large patterns in the cellular automaton
[Conway's Game of Life](http://www.conwaylife.com/wiki/Conway%27s_Game_of_Life). It uses the
HashLife algorithm developed by Bill Gosper to achieve tremendous speedups for repetitive patterns.
A good explanation of HashLife can be found
[here](http://www.drdobbs.com/jvm/an-algorithm-for-compressing-space-and-t/184406478). It also uses
SIMD instructions to speed up the base case of evolving a 16 by 16 square grid of cells into the
future.

## Usage

Add `smeagol` to your `Cargo.toml`:

```toml
[dependencies]
smeagol = "0.1"
```

Then, start simulating Conway's Game of Life!

```rust
fn main() -> Result<(), failure::Error> {
    // load a pattern
    let mut life = smeagol::Life::from_rle_file("breeder1.rle")?;

    // step 1024 generations into the future
    life.set_step_log_2(10);
    life.step();

    // save the result
    let bbox = life.bounding_box().unwrap().pad(10);
    life.save_png("breeder1.png", bbox, 0)?;

    Ok(())
}
```

This produces the following image:

![Breeder](./breeder1.png)

See [the documentation](https://docs.rs/smeagol/) for more.

## Limitations

Currently there is no garbage collection. Large patterns will eventually crash the program if left
running. This will be fixed in the future.

Only the Life rule B3/S23 is supported.

## License

`smeagol` is licensed under the Mozilla Public License version 2.0. See the [license
file](https://github.com/billyrieger/smeagol/blob/master/LICENSE) and the [MPL 2.0
FAQ](https://www.mozilla.org/en-US/MPL/2.0/FAQ/) for more details.