Collatz: Ruby 🔻💎🔻

Banner Image, Collatz Coral

Colourised Collatz Coral; derived from this original by Edmund Harriss

Functions related to the Collatz/Syracuse/3N+1 problem, implemented in Ruby.

Getting Started

To install the latest from RubyGems;

gem install collatz

Or to install from GitHub's hosted gems;

gem install collatz --source "https://rubygems.pkg.github.com/skenvy"

Add to the Gemfile

Add the RubyGems hosted gem;

gem "collatz", ">= 1.0.0

Add the GitHub hosted gem;

source "https://rubygems.pkg.github.com/skenvy" do
  gem "collatz", ">= 1.0.0"
end

Usage

Provides the basic functionality to interact with the Collatz conjecture. The parameterisation uses the same (P,a,b) notation as Conway's generalisations. Besides the function and reverse function, there is also functionality to retrieve the hailstone sequence, the "stopping time"/"total stopping time", or tree-graph. The only restriction placed on parameters is that both P and a can't be 0.

RDoc generated docs

Developing

You will need to install rvm and one of its ruby binaries.

You'll also need to set the RVM_DIR in your shell profile e.g. like this. RVM will set some basic initialisation in your shell profile, but changing what it sets to instead use RVM_DIR like this allows you to install it somewhere other than the default.

The make initialise in first time setup will install the intended development version for you, but it might not be a precompiled binary, depending on your OS and architecture ~ if it isn't precompiled, contributing your time in compiling to publish the binary for rvm is probably more worth your time than this lol.

RVM is locally how we manage proctoring the ruby environment. It is not on the github runners, so the make invocations in the workflows set the RVM proctors empty.

The first time setup

git clone https://github.com/Skenvy/Collatz.git && cd Collatz/ruby && make setup

Iterative development

The majority of make recipes for this are just wrapping a bundle invocation of rake.

  • make docs will recreate the RDoc docs
  • make test will run the RSpec tests.
  • make lint will run the RuboCop linter.