rssn 0.2.9

A comprehensive scientific computing library for Rust, aiming for feature parity with NumPy and SymPy.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
//! # Numerical Fractal Geometry and Chaos Theory
//!
//! This module provides numerical tools for exploring fractal geometry and chaotic systems.
//! It includes functions for generating fractal images, simulating famous attractors,
//! computing fractal dimensions, and analyzing chaotic dynamics through Lyapunov exponents.
//!
//! ## Features
//!
//! ### Fractal Generation
//! - **Mandelbrot Set**: `generate_mandelbrot_set` - Classic escape-time fractal
//! - **Julia Set**: `generate_julia_set` - Related to Mandelbrot with fixed parameter c
//! - **Burning Ship**: `generate_burning_ship` - Variant with absolute value operations
//! - **Multibrot**: `generate_multibrot` - Generalized Mandelbrot with power d
//! - **Newton Fractal**: `generate_newton_fractal` - Fractal from Newton's method
//!
//! ### Strange Attractors
//! - **Lorenz Attractor**: `generate_lorenz_attractor` - Atmospheric convection model
//! - **Rossler Attractor**: `generate_rossler_attractor` - Simpler chaotic flow
//! - **Henon Map**: `generate_henon_map` - Discrete chaotic map
//! - **Tinkerbell Map**: `generate_tinkerbell_map` - 2D discrete dynamical system
//!
//! ### Chaotic Maps
//! - **Logistic Map**: `logistic_map_iterate` - Population dynamics model
//! - **Bifurcation Diagram**: `logistic_bifurcation` - Visualize route to chaos
//!
//! ### Dimension Estimation
//! - **Box-counting Dimension**: `box_counting_dimension` - Estimate fractal dimension
//! - **Correlation Dimension**: `correlation_dimension` - Statistical dimension estimate
//!
//! ### Chaos Analysis
//! - **Lyapunov Exponent**: `lyapunov_exponent_logistic` - Measure of chaos
//! - **Orbit Analysis**: `orbit_density` - Distribution of orbits in phase space
//!
//! ## Examples
//!
//! ### Generating a Mandelbrot Set
//! ```
//! use rssn::numerical::fractal_geometry_and_chaos::generate_mandelbrot_set;
//!
//! let data = generate_mandelbrot_set(100, 100, (-2.0, 1.0), (-1.5, 1.5), 100);
//!
//! assert_eq!(data.len(), 100);
//!
//! assert_eq!(data[0].len(), 100);
//! ```
//!
//! ### Simulating the Lorenz Attractor
//! ```
//! use rssn::numerical::fractal_geometry_and_chaos::generate_lorenz_attractor;
//!
//! let trajectory = generate_lorenz_attractor((1.0, 1.0, 1.0), 0.01, 1000);
//!
//! assert_eq!(trajectory.len(), 1000);
//! ```

use num_complex::Complex;
use serde::Deserialize;
use serde::Serialize;

// ============================================================================
// Common Types
// ============================================================================

/// A 2D point in the plane
pub type Point2D = (f64, f64);

/// A 3D point in space
pub type Point3D = (f64, f64, f64);

/// Result of a fractal computation with escape time data
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct FractalData {
    /// Width of the image
    pub width: usize,
    /// Height of the image
    pub height: usize,
    /// Escape time data (row-major order)
    pub data: Vec<u32>,
    /// Maximum iterations used
    pub max_iter: u32,
}

impl FractalData {
    /// Creates a new `FractalData` with given dimensions
    #[must_use]
    pub fn new(
        width: usize,
        height: usize,
        max_iter: u32,
    ) -> Self {
        Self {
            width,
            height,
            data: vec![0; width * height],
            max_iter,
        }
    }

    /// Gets the escape time at a specific pixel
    #[must_use]
    pub fn get(
        &self,
        x: usize,
        y: usize,
    ) -> Option<u32> {
        if x < self.width && y < self.height {
            Some(self.data[y * self.width + x])
        } else {
            None
        }
    }

    /// Sets the escape time at a specific pixel
    pub fn set(
        &mut self,
        x: usize,
        y: usize,
        value: u32,
    ) {
        if x < self.width && y < self.height {
            self.data[y * self.width + x] = value;
        }
    }
}

// ============================================================================
// Mandelbrot Set
// ============================================================================

/// Generates the data for a Mandelbrot set image.
///
/// The Mandelbrot set is a fractal defined by the iteration `z = z*z + c`.
/// Points `c` for which the iteration remains bounded form the set.
/// This function computes the escape time for each point in a given region.
///
/// # Arguments
/// * `width`, `height` - The dimensions of the output image.
/// * `x_range`, `y_range` - The region in the complex plane to plot.
/// * `max_iter` - The maximum number of iterations per point.
///
/// # Returns
/// A 2D vector where each element is the number of iterations it took for that point to escape.
///
/// # Example
/// ```
/// use rssn::numerical::fractal_geometry_and_chaos::generate_mandelbrot_set;
///
/// let data = generate_mandelbrot_set(100, 100, (-2.5, 1.0), (-1.5, 1.5), 50);
///
/// assert_eq!(data.len(), 100);
/// ```
#[must_use]
pub fn generate_mandelbrot_set(
    width: usize,
    height: usize,
    x_range: (f64, f64),
    y_range: (f64, f64),
    max_iter: u32,
) -> Vec<Vec<u32>> {
    let mut data = vec![vec![0; width]; height];

    let x_scale = (x_range.1 - x_range.0) / width as f64;

    let y_scale = (y_range.1 - y_range.0) / height as f64;

    for (r, row) in data.iter_mut().enumerate() {
        for (c, val) in row.iter_mut().enumerate() {
            let x0 = (c as f64).mul_add(x_scale, x_range.0);

            let y0 = (r as f64).mul_add(y_scale, y_range.0);

            let mut z = Complex::new(0.0, 0.0);

            let c_val = Complex::new(x0, y0);

            let mut iter = 0;

            while z.norm_sqr() <= 4.0 && iter < max_iter {
                z = z * z + c_val;

                iter += 1;
            }

            *val = iter;
        }
    }

    data
}

/// Computes the escape time for a single point in the Mandelbrot set.
///
/// # Arguments
/// * `c_real` - Real part of the complex number c
/// * `c_imag` - Imaginary part of the complex number c
/// * `max_iter` - Maximum iterations
///
/// # Returns
/// The number of iterations before escape, or `max_iter` if the point is in the set.
#[must_use]
pub fn mandelbrot_escape_time(
    c_real: f64,
    c_imag: f64,
    max_iter: u32,
) -> u32 {
    let c = Complex::new(c_real, c_imag);

    let mut z = Complex::new(0.0, 0.0);

    let mut iter = 0;

    while z.norm_sqr() <= 4.0 && iter < max_iter {
        z = z * z + c;

        iter += 1;
    }

    iter
}

// ============================================================================
// Julia Set
// ============================================================================

/// Generates the data for a Julia set image.
///
/// The Julia set is defined by iterating `z = z*z + c` for a fixed c parameter.
/// Unlike the Mandelbrot set, c is constant and z varies.
///
/// # Arguments
/// * `width`, `height` - The dimensions of the output image.
/// * `x_range`, `y_range` - The region in the complex plane to plot.
/// * `c` - The constant c parameter `(real, imaginary)`.
/// * `max_iter` - The maximum number of iterations per point.
///
/// # Returns
/// A 2D vector where each element is the escape time.
///
/// # Example
/// ```
/// use rssn::numerical::fractal_geometry_and_chaos::generate_julia_set;
///
/// // Julia set for c = -0.4 + 0.6i
/// let data = generate_julia_set(100, 100, (-2.0, 2.0), (-2.0, 2.0), (-0.4, 0.6), 50);
///
/// assert_eq!(data.len(), 100);
/// ```
#[must_use]
pub fn generate_julia_set(
    width: usize,
    height: usize,
    x_range: (f64, f64),
    y_range: (f64, f64),
    c: (f64, f64),
    max_iter: u32,
) -> Vec<Vec<u32>> {
    let mut data = vec![vec![0; width]; height];

    let c_val = Complex::new(c.0, c.1);

    let x_scale = (x_range.1 - x_range.0) / width as f64;

    let y_scale = (y_range.1 - y_range.0) / height as f64;

    for (r, row) in data.iter_mut().enumerate() {
        for (col, val) in row.iter_mut().enumerate() {
            let x0 = (col as f64).mul_add(x_scale, x_range.0);

            let y0 = (r as f64).mul_add(y_scale, y_range.0);

            let mut z = Complex::new(x0, y0);

            let mut iter = 0;

            while z.norm_sqr() <= 4.0 && iter < max_iter {
                z = z * z + c_val;

                iter += 1;
            }

            *val = iter;
        }
    }

    data
}

/// Computes the escape time for a single point in a Julia set.
#[must_use]
pub fn julia_escape_time(
    z_real: f64,
    z_imag: f64,
    c_real: f64,
    c_imag: f64,
    max_iter: u32,
) -> u32 {
    let c = Complex::new(c_real, c_imag);

    let mut z = Complex::new(z_real, z_imag);

    let mut iter = 0;

    while z.norm_sqr() <= 4.0 && iter < max_iter {
        z = z * z + c;

        iter += 1;
    }

    iter
}

// ============================================================================
// Burning Ship Fractal
// ============================================================================

/// Generates the Burning Ship fractal.
///
/// Similar to the Mandelbrot set but uses absolute values:
/// `z = (|Re(z)| + i|Im(z)|)^2 + c`
///
/// The resulting fractal resembles a burning ship.
///
/// # Arguments
/// * `width`, `height` - The dimensions of the output image.
/// * `x_range`, `y_range` - The region in the complex plane to plot.
/// * `max_iter` - The maximum number of iterations per point.
///
/// # Returns
/// A 2D vector where each element is the escape time.
#[must_use]
pub fn generate_burning_ship(
    width: usize,
    height: usize,
    x_range: (f64, f64),
    y_range: (f64, f64),
    max_iter: u32,
) -> Vec<Vec<u32>> {
    let mut data = vec![vec![0; width]; height];

    let x_scale = (x_range.1 - x_range.0) / width as f64;

    let y_scale = (y_range.1 - y_range.0) / height as f64;

    for (r, row) in data.iter_mut().enumerate() {
        for (col, val) in row.iter_mut().enumerate() {
            let cx = (col as f64).mul_add(x_scale, x_range.0);

            let cy = (r as f64).mul_add(y_scale, y_range.0);

            let mut zx = 0.0;

            let mut zy = 0.0;

            let mut iter = 0;

            while zx * zx + zy * zy <= 4.0 && iter < max_iter {
                let xtemp = zx * zx - zy * zy + cx;

                zy = (2.0 * zx.abs()).mul_add(zy.abs(), cy);

                zx = xtemp;

                iter += 1;
            }

            *val = iter;
        }
    }

    data
}

// ============================================================================
// Multibrot Set
// ============================================================================

/// Generates the Multibrot set with exponent d.
///
/// The Multibrot set is a generalization where `z = z^d + c`.
/// d=2 gives the standard Mandelbrot set.
///
/// # Arguments
/// * `width`, `height` - The dimensions of the output image.
/// * `x_range`, `y_range` - The region in the complex plane to plot.
/// * `d` - The exponent (power).
/// * `max_iter` - The maximum number of iterations per point.
///
/// # Returns
/// A 2D vector where each element is the escape time.
#[must_use]
pub fn generate_multibrot(
    width: usize,
    height: usize,
    x_range: (f64, f64),
    y_range: (f64, f64),
    d: f64,
    max_iter: u32,
) -> Vec<Vec<u32>> {
    let mut data = vec![vec![0; width]; height];

    let x_scale = (x_range.1 - x_range.0) / width as f64;

    let y_scale = (y_range.1 - y_range.0) / height as f64;

    for (r, row) in data.iter_mut().enumerate() {
        for (col, val) in row.iter_mut().enumerate() {
            let x0 = (col as f64).mul_add(x_scale, x_range.0);

            let y0 = (r as f64).mul_add(y_scale, y_range.0);

            let mut z = Complex::new(0.0, 0.0);

            let c_val = Complex::new(x0, y0);

            let mut iter = 0;

            // Escape radius depends on d
            let escape_radius = 2.0_f64.max(c_val.norm().powf(1.0 / (d - 1.0)));

            while z.norm() <= escape_radius && iter < max_iter {
                z = z.powf(d) + c_val;

                iter += 1;
            }

            *val = iter;
        }
    }

    data
}

// ============================================================================
// Newton Fractal
// ============================================================================

/// Generates a Newton fractal for `z^3 - 1 = 0`.
///
/// Newton's method applied to finding roots of `f(z) = z^3 - 1` produces
/// a fractal pattern. Each pixel is colored based on which root it converges to.
///
/// # Arguments
/// * `width`, `height` - The dimensions of the output image.
/// * `x_range`, `y_range` - The region in the complex plane to plot.
/// * `max_iter` - The maximum number of iterations per point.
/// * `tolerance` - The convergence tolerance.
///
/// # Returns
/// A 2D vector where each element indicates which root (0, 1, or 2) was reached,
/// or 3 if no convergence.
#[must_use]
pub fn generate_newton_fractal(
    width: usize,
    height: usize,
    x_range: (f64, f64),
    y_range: (f64, f64),
    max_iter: u32,
    tolerance: f64,
) -> Vec<Vec<u32>> {
    let mut data = vec![vec![0; width]; height];

    // Roots of z^3 - 1 = 0
    let roots = [
        Complex::new(1.0, 0.0),
        Complex::new(-0.5, 3.0_f64.sqrt() / 2.0),
        Complex::new(-0.5, -3.0_f64.sqrt() / 2.0),
    ];

    let x_scale = (x_range.1 - x_range.0) / width as f64;

    let y_scale = (y_range.1 - y_range.0) / height as f64;

    for (r, row) in data.iter_mut().enumerate() {
        for (col, val) in row.iter_mut().enumerate() {
            let x0 = (col as f64).mul_add(x_scale, x_range.0);

            let y0 = (r as f64).mul_add(y_scale, y_range.0);

            let mut z = Complex::new(x0, y0);

            let mut root_index = 3u32; // No root found
            for _ in 0..max_iter {
                // f(z) = z^3 - 1
                // f'(z) = 3z^2
                let z2 = z * z;

                let z3 = z2 * z;

                let f = z3 - Complex::new(1.0, 0.0);

                let df = Complex::new(3.0, 0.0) * z2;

                if df.norm() < 1e-10 {
                    break;
                }

                z -= f / df;

                // Check if close to any root
                for (i, &root) in roots.iter().enumerate() {
                    if (z - root).norm() < tolerance {
                        root_index = i as u32;

                        break;
                    }
                }

                if root_index < 3 {
                    break;
                }
            }

            *val = root_index;
        }
    }

    data
}

// ============================================================================
// Lorenz Attractor
// ============================================================================

/// Generates the points for a Lorenz attractor simulation.
///
/// The Lorenz attractor is a set of chaotic solutions for a simplified model of atmospheric
/// convection. This function numerically integrates the Lorenz system of differential equations
/// to produce a sequence of points that trace out the attractor.
///
/// The system is defined by:
/// - dx/dt = σ(y - x)
/// - dy/dt = x(ρ - z) - y
/// - dz/dt = xy - βz
///
/// Uses standard parameters: σ = 10, ρ = 28, β = 8/3
///
/// # Arguments
/// * `start_point` - The initial `(x, y, z)` coordinates.
/// * `dt` - The time step for the integration.
/// * `num_steps` - The number of integration steps to perform.
///
/// # Returns
/// A `Vec` of `(f64, f64, f64)` tuples representing the trajectory of the attractor.
///
/// # Example
/// ```
/// use rssn::numerical::fractal_geometry_and_chaos::generate_lorenz_attractor;
///
/// let points = generate_lorenz_attractor((0.1, 0.0, 0.0), 0.01, 1000);
///
/// assert_eq!(points.len(), 1000);
/// ```
#[must_use]
pub fn generate_lorenz_attractor(
    start_point: (f64, f64, f64),
    dt: f64,
    num_steps: usize,
) -> Vec<(f64, f64, f64)> {
    generate_lorenz_attractor_custom(start_point, dt, num_steps, 10.0, 28.0, 8.0 / 3.0)
}

/// Generates a Lorenz attractor with custom parameters.
///
/// # Arguments
/// * `start_point` - The initial `(x, y, z)` coordinates.
/// * `dt` - The time step for the integration.
/// * `num_steps` - The number of integration steps.
/// * `sigma`, `rho`, `beta` - The Lorenz system parameters.
///
/// # Returns
/// A `Vec` of `(f64, f64, f64)` tuples representing the trajectory.
#[must_use]
pub fn generate_lorenz_attractor_custom(
    start_point: (f64, f64, f64),
    dt: f64,
    num_steps: usize,
    sigma: f64,
    rho: f64,
    beta: f64,
) -> Vec<(f64, f64, f64)> {
    let mut points = Vec::with_capacity(num_steps);

    let (mut x, mut y, mut z) = start_point;

    for _ in 0..num_steps {
        let dx = sigma * (y - x);

        let dy = x.mul_add(rho - z, -y);

        let dz = x.mul_add(y, -(beta * z));

        x += dx * dt;

        y += dy * dt;

        z += dz * dt;

        points.push((x, y, z));
    }

    points
}

// ============================================================================
// Rossler Attractor
// ============================================================================

/// Generates the Rossler attractor.
///
/// The Rossler attractor is a system of three non-linear ordinary differential equations
/// that exhibits chaotic dynamics. It is simpler than the Lorenz system.
///
/// The system is defined by:
/// - dx/dt = -y - z
/// - dy/dt = x + ay
/// - dz/dt = b + z(x - c)
///
/// Common parameter values: a = 0.2, b = 0.2, c = 5.7
///
/// # Arguments
/// * `start_point` - The initial `(x, y, z)` coordinates.
/// * `dt` - The time step for the integration.
/// * `num_steps` - The number of integration steps.
/// * `a`, `b`, `c` - The Rossler system parameters.
///
/// # Returns
/// A `Vec` of `(f64, f64, f64)` tuples representing the trajectory.
#[must_use]
pub fn generate_rossler_attractor(
    start_point: (f64, f64, f64),
    dt: f64,
    num_steps: usize,
    a: f64,
    b: f64,
    c: f64,
) -> Vec<(f64, f64, f64)> {
    let mut points = Vec::with_capacity(num_steps);

    let (mut x, mut y, mut z) = start_point;

    for _ in 0..num_steps {
        let dx = -y - z;

        let dy = a.mul_add(y, x);

        let dz = z.mul_add(x - c, b);

        x += dx * dt;

        y += dy * dt;

        z += dz * dt;

        points.push((x, y, z));
    }

    points
}

// ============================================================================
// Henon Map
// ============================================================================

/// Generates the Henon map trajectory.
///
/// The Henon map is a discrete-time dynamical system that exhibits chaotic behavior.
///
/// The map is:
/// - x_{n+1} = 1 - a*`x_n^2` + `y_n`
/// - y_{n+1} = b*`x_n`
///
/// Classic parameter values: a = 1.4, b = 0.3
///
/// # Arguments
/// * `start_point` - The initial `(x, y)` coordinates.
/// * `num_steps` - The number of iterations.
/// * `a`, `b` - The Henon map parameters.
///
/// # Returns
/// A `Vec` of `(f64, f64)` tuples representing the trajectory.
#[must_use]
pub fn generate_henon_map(
    start_point: (f64, f64),
    num_steps: usize,
    a: f64,
    b: f64,
) -> Vec<(f64, f64)> {
    let mut points = Vec::with_capacity(num_steps);

    let (mut x, mut y) = start_point;

    for _ in 0..num_steps {
        let x_new = (a * x).mul_add(-x, 1.0) + y;

        let y_new = b * x;

        x = x_new;

        y = y_new;

        points.push((x, y));
    }

    points
}

// ============================================================================
// Tinkerbell Map
// ============================================================================

/// Generates the Tinkerbell map trajectory.
///
/// The Tinkerbell map is a two-dimensional iterated map:
/// - x_{n+1} = `x_n^2` - `y_n^2` + `ax_n` + `by_n`
/// - y_{n+1} = `2x_n`*`y_n` + `cx_n` + `dy_n`
///
/// Classic parameter values: a = 0.9, b = -0.6013, c = 2.0, d = 0.5
///
/// # Arguments
/// * `start_point` - The initial `(x, y)` coordinates.
/// * `num_steps` - The number of iterations.
/// * `a`, `b`, `c`, `d` - The map parameters.
///
/// # Returns
/// A `Vec` of `(f64, f64)` tuples representing the trajectory.
#[must_use]
pub fn generate_tinkerbell_map(
    start_point: (f64, f64),
    num_steps: usize,
    a: f64,
    b: f64,
    c: f64,
    d: f64,
) -> Vec<(f64, f64)> {
    let mut points = Vec::with_capacity(num_steps);

    let (mut x, mut y) = start_point;

    for _ in 0..num_steps {
        let x_new = b.mul_add(y, a.mul_add(x, x.mul_add(x, -(y * y))));

        let y_new = d.mul_add(y, (2.0 * x).mul_add(y, c * x));

        x = x_new;

        y = y_new;

        points.push((x, y));
    }

    points
}

// ============================================================================
// Logistic Map
// ============================================================================

/// Iterates the logistic map.
///
/// The logistic map is defined by: x_{n+1} = r * `x_n` * (1 - `x_n`)
///
/// It is a classic example of how complex behavior can arise from simple nonlinear
/// dynamical equations. For r between 0 and 4, the dynamics range from stable
/// fixed points to period doubling to chaos.
///
/// # Arguments
/// * `x0` - Initial value (should be between 0 and 1).
/// * `r` - The growth rate parameter.
/// * `num_steps` - The number of iterations.
///
/// # Returns
/// A `Vec` of x values representing the orbit.
#[must_use]
pub fn logistic_map_iterate(
    x0: f64,
    r: f64,
    num_steps: usize,
) -> Vec<f64> {
    let mut orbit = Vec::with_capacity(num_steps + 1);

    let mut x = x0;

    orbit.push(x);

    for _ in 0..num_steps {
        x = r * x * (1.0 - x);

        orbit.push(x);
    }

    orbit
}

/// Generates data for a bifurcation diagram of the logistic map.
///
/// For each value of r, the map is iterated and the final values after
/// discarding transients are recorded.
///
/// # Arguments
/// * `r_range` - The range of r values `(r_min, r_max)`.
/// * `num_r_values` - Number of r values to sample.
/// * `transient` - Number of initial iterations to discard.
/// * `num_points` - Number of points to record after transient.
/// * `x0` - Initial x value.
///
/// # Returns
/// A `Vec` of `(r, x)` pairs for plotting the bifurcation diagram.
#[must_use]
pub fn logistic_bifurcation(
    r_range: (f64, f64),
    num_r_values: usize,
    transient: usize,
    num_points: usize,
    x0: f64,
) -> Vec<(f64, f64)> {
    let mut data = Vec::with_capacity(num_r_values * num_points);

    let r_step = (r_range.1 - r_range.0) / (num_r_values as f64 - 1.0);

    for i in 0..num_r_values {
        let r = (i as f64).mul_add(r_step, r_range.0);

        let mut x = x0;

        // Discard transient
        for _ in 0..transient {
            x = r * x * (1.0 - x);
        }

        // Record points
        for _ in 0..num_points {
            x = r * x * (1.0 - x);

            data.push((r, x));
        }
    }

    data
}

// ============================================================================
// Lyapunov Exponent
// ============================================================================

/// Computes the Lyapunov exponent for the logistic map.
///
/// The Lyapunov exponent λ measures the rate of separation of infinitesimally
/// close trajectories. For the logistic map:
/// λ = lim (1/n) * sum(ln|r(1-2x_i)|)
///
/// Positive λ indicates chaos.
///
/// # Arguments
/// * `r` - The growth rate parameter.
/// * `x0` - Initial value.
/// * `transient` - Number of iterations to discard.
/// * `num_iterations` - Number of iterations for averaging.
///
/// # Returns
/// The estimated Lyapunov exponent.
#[must_use]
pub fn lyapunov_exponent_logistic(
    r: f64,
    x0: f64,
    transient: usize,
    num_iterations: usize,
) -> f64 {
    let mut x = x0;

    // Discard transient
    for _ in 0..transient {
        x = r * x * (1.0 - x);
    }

    // Compute average
    let mut sum = 0.0;

    for _ in 0..num_iterations {
        // Derivative of f(x) = rx(1-x) is f'(x) = r(1-2x)
        let deriv = r * 2.0f64.mul_add(-x, 1.0);

        if deriv.abs() > 0.0 {
            sum += deriv.abs().ln();
        }

        x = r * x * (1.0 - x);
    }

    sum / num_iterations as f64
}

/// Computes the largest Lyapunov exponent for a 3D flow (e.g., Lorenz system).
///
/// Uses the method of tracking the evolution of a small perturbation.
///
/// # Arguments
/// * `start_point` - Initial point `(x, y, z)`.
/// * `dt` - Time step.
/// * `num_steps` - Number of integration steps.
/// * `sigma`, `rho`, `beta` - Lorenz system parameters.
///
/// # Returns
/// The estimated largest Lyapunov exponent.
#[must_use]
pub fn lyapunov_exponent_lorenz(
    start_point: (f64, f64, f64),
    dt: f64,
    num_steps: usize,
    sigma: f64,
    rho: f64,
    beta: f64,
) -> f64 {
    let (mut x, mut y, mut z) = start_point;

    let mut sum = 0.0;

    // Initial perturbation vector (normalized)
    let eps = 1e-8;

    let mut dx = eps;

    let mut dy = 0.0;

    let mut dz = 0.0;

    for _ in 0..num_steps {
        // Evolve the main trajectory
        let dx_main = sigma * (y - x);

        let dy_main = x.mul_add(rho - z, -y);

        let dz_main = x.mul_add(y, -(beta * z));

        x += dx_main * dt;

        y += dy_main * dt;

        z += dz_main * dt;

        // Evolve the perturbation using linearized equations
        let ddx = sigma * (dy - dx);

        let ddy = dx * (rho - z) - x * dz - dy;

        let ddz = beta.mul_add(-dz, dx * y + x * dy);

        dx += ddx * dt;

        dy += ddy * dt;

        dz += ddz * dt;

        // Compute and accumulate the growth rate
        let norm = (dx * dx + dy * dy + dz * dz).sqrt();

        if norm > 0.0 {
            sum += norm.ln();

            // Renormalize
            dx /= norm;

            dy /= norm;

            dz /= norm;

            dx *= eps;

            dy *= eps;

            dz *= eps;
        }
    }

    sum / (num_steps as f64 * dt) - eps.ln() / dt
}

// ============================================================================
// Dimension Estimation
// ============================================================================

/// Estimates the box-counting (Minkowski) dimension from a set of 2D points.
///
/// The box-counting dimension is estimated by:
/// D = lim(ε→0) [log(N(ε)) / log(1/ε)]
///
/// where N(ε) is the number of boxes of side ε needed to cover the set.
///
/// # Arguments
/// * `points` - A slice of 2D points.
/// * `num_scales` - Number of different box sizes to use.
///
/// # Returns
/// An estimate of the box-counting dimension.
#[must_use]
pub fn box_counting_dimension(
    points: &[(f64, f64)],
    num_scales: usize,
) -> f64 {
    if points.is_empty() || num_scales < 2 {
        return 0.0;
    }

    // Find bounding box
    let mut x_min = f64::MAX;

    let mut x_max = f64::MIN;

    let mut y_min = f64::MAX;

    let mut y_max = f64::MIN;

    for &(x, y) in points {
        x_min = x_min.min(x);

        x_max = x_max.max(x);

        y_min = y_min.min(y);

        y_max = y_max.max(y);
    }

    let extent = (x_max - x_min).max(y_max - y_min);

    if extent <= 0.0 {
        return 0.0;
    }

    // Collect (log(1/eps), log(N)) pairs
    let mut log_inv_eps = Vec::with_capacity(num_scales);

    let mut log_n = Vec::with_capacity(num_scales);

    for scale_idx in 0..num_scales {
        let num_boxes = 1 << (scale_idx + 1); // 2, 4, 8, 16, ...
        let eps = extent / f64::from(num_boxes);

        // Count occupied boxes using a hash set
        let mut occupied = std::collections::HashSet::new();

        for &(x, y) in points {
            let bx = ((x - x_min) / eps).floor() as i64;

            let by = ((y - y_min) / eps).floor() as i64;

            occupied.insert((bx, by));
        }

        let n = occupied.len();

        if n > 0 && eps > 0.0 {
            log_inv_eps.push((1.0 / eps).ln());

            log_n.push((n as f64).ln());
        }
    }

    // Linear regression to find slope
    if log_inv_eps.len() < 2 {
        return 0.0;
    }

    linear_regression_slope(&log_inv_eps, &log_n)
}

/// Estimates the correlation dimension from a set of points.
///
/// The correlation dimension is estimated from the correlation integral:
/// C(r) ~ r^D
///
/// # Arguments
/// * `points` - A slice of 2D points.
/// * `num_radii` - Number of radius values to sample.
///
/// # Returns
/// An estimate of the correlation dimension.
///
/// # Panics
/// Panics if any pairwise distance between points is NaN during sorting.
#[must_use]
pub fn correlation_dimension(
    points: &[(f64, f64)],
    num_radii: usize,
) -> f64 {
    if points.len() < 2 || num_radii < 2 {
        return 0.0;
    }

    // Compute all pairwise distances
    let n = points.len();

    let mut distances: Vec<f64> = Vec::with_capacity(n * (n - 1) / 2);

    for i in 0..n {
        for j in (i + 1)..n {
            let dx = points[i].0 - points[j].0;

            let dy = points[i].1 - points[j].1;

            distances.push(dx.hypot(dy));
        }
    }

    if distances.is_empty() {
        return 0.0;
    }

    distances.sort_by(|a, b| a.partial_cmp(b).unwrap());

    let r_min = distances[0].max(1e-10);

    let r_max = distances[distances.len() - 1];

    if r_max <= r_min {
        return 0.0;
    }

    // Sample radii logarithmically
    let mut log_r = Vec::with_capacity(num_radii);

    let mut log_c = Vec::with_capacity(num_radii);

    for i in 0..num_radii {
        let log_r_val =
            r_min.ln() + (r_max.ln() - r_min.ln()) * (i as f64) / (num_radii as f64 - 1.0);

        let r = log_r_val.exp();

        // Count pairs with distance < r
        let count = distances.partition_point(|&d| d < r);

        let c_r = (2.0 * count as f64) / ((n * (n - 1)) as f64);

        if c_r > 0.0 {
            log_r.push(r.ln());

            log_c.push(c_r.ln());
        }
    }

    if log_r.len() < 2 {
        return 0.0;
    }

    linear_regression_slope(&log_r, &log_c)
}

/// Helper function for linear regression slope estimation.
pub(crate) fn linear_regression_slope(
    x: &[f64],
    y: &[f64],
) -> f64 {
    let n = x.len() as f64;

    let sum_x: f64 = x.iter().sum();

    let sum_y: f64 = y.iter().sum();

    let sum_xy: f64 = x.iter().zip(y.iter()).map(|(xi, yi)| xi * yi).sum();

    let sum_xx: f64 = x.iter().map(|xi| xi * xi).sum();

    let denom = n.mul_add(sum_xx, -(sum_x * sum_x));

    if denom.abs() < 1e-10 {
        return 0.0;
    }

    n.mul_add(sum_xy, -(sum_x * sum_y)) / denom
}

// ============================================================================
// Orbit Analysis
// ============================================================================

/// Computes the density distribution of orbit points in a 2D histogram.
///
/// # Arguments
/// * `points` - The orbit trajectory.
/// * `x_bins` - Number of bins in x direction.
/// * `y_bins` - Number of bins in y direction.
/// * `x_range` - Range for x axis.
/// * `y_range` - Range for y axis.
///
/// # Returns
/// A 2D vector of counts for each bin.
#[must_use]
pub fn orbit_density(
    points: &[(f64, f64)],
    x_bins: usize,
    y_bins: usize,
    x_range: (f64, f64),
    y_range: (f64, f64),
) -> Vec<Vec<usize>> {
    let mut density = vec![vec![0usize; x_bins]; y_bins];

    let x_scale = (x_range.1 - x_range.0) / x_bins as f64;

    let y_scale = (y_range.1 - y_range.0) / y_bins as f64;

    for &(x, y) in points {
        if x >= x_range.0 && x < x_range.1 && y >= y_range.0 && y < y_range.1 {
            let xi: usize = (((x - x_range.0) / x_scale) as i64).try_into().unwrap_or(0);

            let yi: usize = (((y - y_range.0) / y_scale) as i64).try_into().unwrap_or(0);

            if xi < x_bins && yi < y_bins {
                density[yi][xi] += 1;
            }
        }
    }

    density
}

/// Computes the entropy of an orbit from its density distribution.
///
/// Uses Shannon entropy: H = -`sum(p_i` * `log(p_i)`)
///
/// # Arguments
/// * `density` - A 2D density histogram from `orbit_density`.
///
/// # Returns
/// The Shannon entropy of the distribution.
#[must_use]
pub fn orbit_entropy(density: &[Vec<usize>]) -> f64 {
    let total: usize = density.iter().flat_map(|row| row.iter()).sum();

    if total == 0 {
        return 0.0;
    }

    let mut entropy = 0.0;

    let total_f = total as f64;

    for row in density {
        for &count in row {
            if count > 0 {
                let p = count as f64 / total_f;

                entropy -= p * p.ln();
            }
        }
    }

    entropy
}

// ============================================================================
// IFS (Iterated Function System) Numerical Implementation
// ============================================================================

/// Represents an affine transformation in 2D.
///
/// The transformation is: (x', y') = (ax + by + e, cx + dy + f)
#[derive(Debug, Clone, Copy, Serialize, Deserialize)]
pub struct AffineTransform2D {
    /// Coefficients of the transformation
    pub a: f64,
    /// Coefficient b.
    pub b: f64,
    /// Coefficient c.
    pub c: f64,
    /// Coefficient d.
    pub d: f64,
    /// Coefficient e (translation in x).
    pub e: f64,
    /// Coefficient f (translation in y).
    pub f: f64,
}

impl AffineTransform2D {
    /// Creates a new affine transformation.
    #[must_use]
    pub const fn new(
        a: f64,
        b: f64,
        c: f64,
        d: f64,
        e: f64,
        f: f64,
    ) -> Self {
        Self { a, b, c, d, e, f }
    }

    /// Applies the transformation to a point.
    #[must_use]
    pub fn apply(
        &self,
        point: (f64, f64),
    ) -> (f64, f64) {
        let (x, y) = point;

        (
            self.a.mul_add(x, self.b * y) + self.e,
            self.c.mul_add(x, self.d * y) + self.f,
        )
    }
}

/// Generates an IFS fractal using the chaos game algorithm.
///
/// # Arguments
/// * `transforms` - The affine transformations.
/// * `probabilities` - Probabilities for selecting each transformation.
/// * `start_point` - Initial point.
/// * `num_points` - Number of points to generate.
/// * `skip` - Number of initial points to skip (for convergence).
///
/// # Returns
/// A vector of 2D points on the fractal.
#[must_use]
pub fn generate_ifs_fractal(
    transforms: &[AffineTransform2D],
    probabilities: &[f64],
    start_point: (f64, f64),
    num_points: usize,
    skip: usize,
) -> Vec<(f64, f64)> {
    if transforms.is_empty() || transforms.len() != probabilities.len() {
        return vec![];
    }

    // Build cumulative probabilities
    let mut cumulative = Vec::with_capacity(probabilities.len());

    let mut sum = 0.0;

    for &p in probabilities {
        sum += p;

        cumulative.push(sum);
    }

    // Normalize
    for c in &mut cumulative {
        *c /= sum;
    }

    let mut points = Vec::with_capacity(num_points);

    let mut current = start_point;

    // Simple LCG random number generator for reproducibility
    let mut rng_state = 12345u64;

    let lcg_next = |state: &mut u64| -> f64 {
        *state = state
            .wrapping_mul(6_364_136_223_846_793_005)
            .wrapping_add(1);

        (*state >> 33) as f64 / f64::from(u32::MAX)
    };

    for i in 0..(num_points + skip) {
        let r = lcg_next(&mut rng_state);

        let idx = cumulative.iter().position(|&c| r <= c).unwrap_or(0);

        current = transforms[idx].apply(current);

        if i >= skip {
            points.push(current);
        }
    }

    points
}

/// Creates the Sierpinski triangle IFS.
#[must_use]
pub fn sierpinski_triangle_ifs() -> (Vec<AffineTransform2D>, Vec<f64>) {
    let transforms = vec![
        AffineTransform2D::new(0.5, 0.0, 0.0, 0.5, 0.0, 0.0),
        AffineTransform2D::new(0.5, 0.0, 0.0, 0.5, 0.5, 0.0),
        AffineTransform2D::new(0.5, 0.0, 0.0, 0.5, 0.25, 0.5),
    ];

    let probabilities = vec![1.0 / 3.0, 1.0 / 3.0, 1.0 / 3.0];

    (transforms, probabilities)
}

/// Creates the Barnsley fern IFS.
#[must_use]
pub fn barnsley_fern_ifs() -> (Vec<AffineTransform2D>, Vec<f64>) {
    let transforms = vec![
        AffineTransform2D::new(0.0, 0.0, 0.0, 0.16, 0.0, 0.0),
        AffineTransform2D::new(0.85, 0.04, -0.04, 0.85, 0.0, 1.6),
        AffineTransform2D::new(0.2, -0.26, 0.23, 0.22, 0.0, 1.6),
        AffineTransform2D::new(-0.15, 0.28, 0.26, 0.24, 0.0, 0.44),
    ];

    let probabilities = vec![0.01, 0.85, 0.07, 0.07];

    (transforms, probabilities)
}