Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Collatz: Julia 🔴🟢🟣

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 Julia.

Getting Started

To install the latest from JuliaRegistries/General (also see JuliaHub);

From anywhere, in REPL

julia> using Pkg; Pkg.add("Collatz")

Or add it to a Project.tml

julia --project=. -e "using Pkg; Pkg.add(\"Collatz\")"

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.

Developing

The first time setup

git clone https://github.com/Skenvy/Collatz.git && cd Collatz/julia && make deps

Iterative development

  • make build will run both make test (the unit tests) and make docs.
  • make test precompiles and runs the unit tests.
  • make docs runs the strict doctesting makedocs.
  • make docs_view will make docs and start LiveServer on them.
  • make repl will reinitialise the package and initiate the repl with using Collatz