Document the underlying algorithm

Open
#4 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
cpp, python, rust, swift
Domain
documentation

Research direction

Start with the self-contained Python reference at lifehash/lifehash.py, then compare it with the Swift and C++ implementations linked in the issue. Document the complete algorithm, including details absent from the video, so another developer can implement LifeHash without reverse engineering an existing library.

Written by the indexing model from the issue text.

Description

Is there a document that specifies the algorithm behind LifeHash?

I know there are at least three reference implementations in various languages, listed below for completeness, however it requires a lot of effort to reverse engineer these:

For example I was looking for a pure Rust based implementation but there is none. I might have tried to implement one in a weekend, but there is no specification to start from, and reverse engineering an already implementation is far from a weekend project. :)

Also, for completeness, the video linked in the repository does give some insight, but it doesn't contain all the actual details: https://www.youtube.com/watch?v=cu0K__KLxKo

Dominant language
Mathematica
Stars
83
Forks
6
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.