Manifest and Cargo.toml updates (#8)

* revisit todos #6 and revise manifest

* fix reference link in README.md

Cargo.toml

@@ -1,7 +1,14 @@
 [package]
+authors = ["Tom Krüger <[email protected]>"]
+description = "An interactive visualization tool for dynamics in chaotic systems."
+homepage = "https://tomtuamnuq.github.io/rusty-chaos-craftor/"
+keywords = ["chaotic-dynamical-systems", "particles", "fractals", "complex-numbers", "perplex-numbers"]
+categories = ["chaos-theory", "simulation", "mathematics"]
+license = "MIT"
+repository = "https://github.com/tomtuamnuq/rusty-chaos-craftor"
 name = "rusty-chaos-craftor"
 version = "1.0.0"
-authors = ["Tom Krüger <[email protected]>"]
+readme = "README.md"
 edition = "2021"
 rust-version = "1.76"
 
@@ -33,9 +40,9 @@ num-dual = "0.8"
 
 # switch manually between local git and upstream
 egui-plotter = { git = "https://github.com/Gip-Gip/egui-plotter.git", branch = "main" }
-perplex_num = { git = "https://github.com/tomtuamnuq/perplex_num.git", branch = "main" }
-#egui-plotter = { path = "../egui-plotter" }
-#perplex_num = { path = "../perplex_num" }
+perplex_num = "0.1"
+# egui-plotter = { path = "../egui-plotter" }
+# perplex_num = { path = "../perplex_num" }
 
 # native:
 [target.'cfg(not(target_arch = "wasm32"))'.dependencies]

README.md

@@ -99,8 +99,8 @@ I would like to express my gratitude to the following authors and sources for pr
 - Hamadneh et al. for a **four-dimensional** *fractional chaotic map with constant and variable order*. [Publication](https://doi.org/10.3390/math11204332)
 
 ### Systems of Ordinary Differential Equations
-- Paul Bourke for the **Burke-Shaw** system, which is a three-dimensional chaotic system with different symmetries and bifurcations. [Website](https://paulbourke.net/fractals/burkwshaw)
-- Sambas et al. for the description of the **Genesio-Tesi** system in their work *Design, Analysis of the Genesio Tesi Chaotic System and its Electronic Experimental Implemenation* [Publication](https://paulbourke.net/fractals/burkwshaw)
+- Paul Bourke for the **Burke-Shaw** system, which is a three-dimensional chaotic system with different symmetries and bifurcations. [Website](https://paulbourke.net/fractals/burkeshaw)
+- Sambas et al. for the description of the **Genesio-Tesi** system in their work *Design, Analysis of the Genesio Tesi Chaotic System and its Electronic Experimental Implemenation* [Publication](https://www.researchgate.net/publication/303369826_Design_analysis_of_the_Genesio-Tesi_chaotic_system_and_its_electronic_experimental_implementation)
 - Zhang et al. for the *analysis of three species **Lotka-Volterra** food web models with omnivory*. [Publication](https://doi.org/10.1016/j.jmaa.2015.01.035)
 - Ababneh for a new **four-dimensional** chaotic attractor, which has a complex structure and a wide range of parameters. [Publication](https://doi.org/10.1016/j.asej.2016.08.020)
 - Wang, Feng and Chen for a new **four-dimensional** chaotic system. [Publication](https://doi.org/10.3389/fphy.2022.906138)
@@ -110,3 +110,5 @@ I would like to express my gratitude to the following authors and sources for pr
 - Gdawiec, Fariello and Santos for Algorithm 1 in *On the **quaternion** Julia sets via Picard–Mann iteration*. [Paper](https://doi.org/10.1007/s11071-023-08785-0)
 - Kumari et al. for Algorithm 3 in *A novel approach to generate Mandelbrot sets, Julia sets and **biomorphs** via viscosity approximation method*. [Paper](https://doi.org/10.1016/j.chaos.2022.112540)
 - Bankers et al. for their work *Julia and Mandelbrot Sets for Dynamics over the Hyperbolic Numbers*, which motivated me to include **Perplex** numbers in this project. Perplex (also known as hyperbolic) numbers are a variation of complex numbers that encode geometric properties of the Minkowski space. [Paper](https://doi.org/10.3390/fractalfract3010006)
+
+See my crate [perplex_num](https://github.com/tomtuamnuq/perplex_num) for additional information.

assets/manifest.json

@@ -1,6 +1,6 @@
 {
-  "name": "RustyChaosCraftor PWA",
-  "short_name": "rusty-chaos-craftor-pwa",
+  "name": "Rusty-Chaos-Craftor",
+  "short_name": "Chaos Craftor",
   "icons": [
     {
       "src": "./icon-256.png",

assets/sw.js

@@ -1,3 +1,4 @@
+// progressive web application cache
 var cacheName = 'rusty-chaos-craftor-pwa';
 var filesToCache = [
   './',

src/chaos/benchmark.rs

@@ -1,13 +1,12 @@
-use std::{
-    sync::{Arc, Mutex},
-    thread,
-};
-// TODO use wasm threads
 use super::{
     data::{ChaosData, ChaosDataVec, InitialDistributionConfig, ValidStateCheck},
     execution::*,
 };
 use anyhow::Error;
+use std::{
+    sync::{Arc, Mutex},
+    thread,
+};
 use web_time::{Duration, Instant};
 pub struct ChaosInitSchema {
     pub num_samples: usize,
@@ -138,10 +137,11 @@ fn chaos_benchmark_run(
         ChaosDataVec::State4(data) => evaluate_chaos_data(data),
         ChaosDataVec::ParticleXY(data) => evaluate_chaos_data(data),
         ChaosDataVec::ParticleXYZ(data) => evaluate_chaos_data(data),
-        ChaosDataVec::FractalComplex(data) => evaluate_chaos_data(data), // TODO specific for fractal - num iterations
-        ChaosDataVec::FractalDual(data) => evaluate_chaos_data(data), // TODO specific for fractal - num iterations
-        ChaosDataVec::FractalPerplex(data) => evaluate_chaos_data(data), // TODO specific for fractal - num iterations
-        ChaosDataVec::FractalQuaternion(data) => evaluate_chaos_data(data), // TODO specific for fractal - num iterations
+        // TODO evaluate number of iterations for fractals
+        ChaosDataVec::FractalComplex(data) => evaluate_chaos_data(data),
+        ChaosDataVec::FractalDual(data) => evaluate_chaos_data(data),
+        ChaosDataVec::FractalPerplex(data) => evaluate_chaos_data(data),
+        ChaosDataVec::FractalQuaternion(data) => evaluate_chaos_data(data),
     };
     Ok(ChaosBenchmarkRun {
         runtime: elapsed,

src/chaos/data/initial_distribution.rs

@@ -196,14 +196,11 @@ impl InitialDistributionVariant {
                 num_points,
                 rng,
             ),
-            InitialDistributionVariant::Exponential(d) => {
-                // TODO check d
-                data_gen_from_distribution(
-                    rand_distr::Exp::new(d.lambda.to_owned()).unwrap(),
-                    num_points,
-                    rng,
-                )
-            }
+            InitialDistributionVariant::Exponential(d) => data_gen_from_distribution(
+                rand_distr::Exp::new(d.lambda.to_owned()).unwrap(),
+                num_points,
+                rng,
+            ),
             InitialDistributionVariant::LogNormal(d) => data_gen_from_distribution(
                 rand_distr::LogNormal::new(d.mean.to_owned(), d.std_dev.to_owned()).unwrap(),
                 num_points,

src/chaos/fractal/fractal_conf.rs

@@ -871,7 +871,6 @@ impl Default for MandelbrotBiomorphComplex {
 }
 impl Default for MandelbrotBiomorphDual {
     fn default() -> Self {
-        // TODO Dual
         Self {
             r: DEFAULT_BIOMORPH_R,
             m_re: -0.1,
@@ -946,7 +945,6 @@ impl Default for JuliaBiomorphComplex {
 }
 impl Default for JuliaBiomorphDual {
     fn default() -> Self {
-        // TODO Dual
         Self {
             r: DEFAULT_BIOMORPH_R,
             c_re: -0.01,

src/chaos/fractal/julia.rs

@@ -52,7 +52,6 @@ impl<E: AlgebraElement> JuliaPicard<E> {
 }
 
 impl<E: AlgebraElement> FractalGenerator for JuliaPicard<E> {
-    // TODO add DOI
     type Element = E;
     fn is_set_element(&self, fractal: &mut FractalData<Self::Element>) -> bool {
         self.escape.check_escape(fractal)

src/chaos/functions/discrete_maps.rs

@@ -596,7 +596,7 @@ impl ChaosDescription for Zaslavskii {
     }
     fn reference(&self) -> &'static str {
         "https://wikipedia.org/wiki/Zaslavskii_map"
-    } // TODO http://www.scholarpedia.org/article/Zaslavsky_map
+    }
 }
 impl ChaosFormula for Zaslavskii {
     fn formula(&self) -> &[&'static str] {

src/gui/plot/plot_colors.rs

@@ -23,7 +23,7 @@ pub enum SeriesColors {
     BlackWhite,
     Bone,
     Copper,
-    // TODO DerivedColorMap(Vec<(f64, RGBColor)>),
+    // DerivedColorMap(Vec<(f64, RGBColor)>) possible as well
     #[default]
     MandelbrotHSL,
     ViridisRGB,