some documentation and one test

Author: jeffwack

Project.toml

@@ -1,4 +1,4 @@
-name = "Spiders"
+name = "Mandelbrot"
 uuid = "52854307-bbd1-4ac7-933f-adc0936abe8a"
 authors = ["Jeffrey Wack"]
 version = "0.1.0"

README.md

@@ -1,3 +1,10 @@
-# Spiders
+# Mandelbrot
+
+This package implements several algorithms related to complex quadratic dynamics. 
+- The spider algorithm calculates the center of a hyperbolic component of the Mandelbrot set from one of its external angles. [Read about the spider algorithm.](https://pi.math.cornell.edu/~hubbard/SpidersFinal.pdf)
+- The external angles of a hyperbolic component can be calculated from an angled internal address, describing the path to this component from zero. [Read about internal addresses.](https://arxiv.org/abs/math/9411238)
+- A combinatorial description of a Hubbard trees can be generated from a kneading sequence, and when oriented in the plane can produce external angles. [Read about Hubbard trees.](https://www.mat.univie.ac.at/~bruin/papers/bkafsch.pdf)
+
+This package is a work in progress. Currently, KneadingSequence, AngledInternalAddress, HubbardTree, and OrientedHubbardTree can be constructed. To run the spider algorithm use parameter().
 
 [![Build Status](https://github.com/jeffwack111/Spiders.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/jeffwack111/Spiders.jl/actions/workflows/CI.yml?query=branch%3Amain)

src/Spiders.jl

@@ -9,8 +9,10 @@ export HubbardTree
 export AngledInternalAddress
 export OrientedHubbardTree
 
-export HyperbolicComponent
+export parameter
 
-export treeplot
+#export HyperbolicComponent
+
+#export treeplot
 
 end

src/trees/Lamination.jl

@@ -149,7 +149,7 @@ end
 
 function conjugate(angle::Rational)
     orb = orbit(angle)
-    n = period(orb)
+    n = orb.period
 
     halfa = angle/2
     halfb = angle/2 + 1//2

src/trees/OrientTrees.jl

@@ -1,5 +1,8 @@
 include("HubbardTrees.jl") 
 
+"A combinatorial Hubbard tree with cyclic order at each vertex. 
+It can be constructed from an AngledInternalAddress
+or a rational angle, and it can be used to construct a HyperbolicComponent"
 struct OrientedHubbardTree <: AbstractHubbardTree
     adj::Dict{Sequence,Vector{Sequence}}
     criticalpoint::KneadingSequence

test/runtests.jl

@@ -2,5 +2,5 @@ using Spiders
 using Test
 
 @testset "Spiders.jl" begin
-    # Write your tests here.
+    @test KneadingSequence(3//5) == KneadingSequence(2//5)
 end