complex-bessel 0.2.0

Pure Rust implementation of complex Bessel functions (J, Y, I, K, H, Airy) based on Amos Algorithm 644
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
//! Region 1 uniform asymptotic expansion for the K function + analytic continuation.
//!
//! Translation of Fortran ZUNK1 from TOMS 644 / SLATEC (zbsubs.f lines 5732-6158).
//! Computes K(fnu,z) and its analytic continuation from the right half plane
//! to the left half plane using the uniform asymptotic expansion.

#![allow(clippy::too_many_arguments)]

use num_complex::Complex;

use crate::algo::constants::PI;
use crate::algo::s1s2::zs1s2;
use crate::algo::uchk::zuchk;
use crate::algo::unik::{UnikCache, zunik};
use crate::machine::BesselFloat;
use crate::types::{IkFlag, Scaling, SumOption};
use crate::utils::{mul_add, reciprocal_z, zabs};

/// Compute K(fnu,z) via Region 1 uniform asymptotic expansion + analytic continuation.
///
/// Equivalent to Fortran ZUNK1 in TOMS 644 (zbsubs.f lines 5732-6158).
///
/// # Parameters
/// - `z`: complex argument
/// - `fnu`: starting order v >= 0
/// - `kode`: scaling mode
/// - `mr`: analytic continuation direction (0 = none, +/-1 = left half plane)
/// - `y`: output slice for sequence members
/// - `tol`, `elim`, `alim`: machine-derived thresholds
///
/// # Returns
/// `nz` where nz = -1 indicates overflow.
pub(crate) fn zunk1<T: BesselFloat>(
    z: Complex<T>,
    fnu: T,
    kode: Scaling,
    mr: i32,
    y: &mut [Complex<T>],
    tol: T,
    elim: T,
    alim: T,
) -> i32 {
    let n = y.len();
    let zero = T::zero();
    let one = T::one();
    let czero = Complex::new(zero, zero);
    let pi_t = T::from_f64(PI);

    y.fill(czero);
    let mut kdflg: usize = 1;
    let mut nz: i32 = 0;

    // -- 3-level scaling (Fortran lines 5769-5779) --
    let cscl = one / tol;
    let crsc = tol;
    let cssr = [cscl, one, crsc];
    let csrr = [crsc, one, cscl];
    let bry = [
        T::from_f64(1.0e3) * T::MACH_TINY / tol,
        one / (T::from_f64(1.0e3) * T::MACH_TINY / tol),
        T::MACH_HUGE,
    ];

    // -- Reflect to right half plane (Fortran lines 5780-5784) --
    let zr = if z.re >= zero { z } else { -z };

    // -- Phase 1: K function computation (Fortran lines 5786-5865) --
    let mut j: usize = 1; // Fortran J starts at 2, first flip gives 1 -> Rust: start 1, first flip gives 0
    let mut phi_arr = [czero; 2];
    let mut zeta1_arr = [czero; 2];
    let mut zeta2_arr = [czero; 2];
    let mut sum_arr = [czero; 2];
    let mut init_arr = [0usize; 2];
    let mut caches: [Option<UnikCache<T>>; 3] = [None, None, None];
    let mut cy = [czero; 2];
    let mut kflag: usize = 2;

    let mut i_exit: usize = n; // 1-based Fortran I at loop exit (set to N by default)
    let mut fn_at_exit = fnu;

    for i in 0..n {
        // J flip-flop (Fortran: J = 3 - J) -> Rust: j = 1 - j
        j = 1 - j;
        let fn_val = fnu + T::from_f64(i as f64);

        // Fresh ZUNIK call with IKFLG=2 (K function), IPMTR=0
        let result = zunik(zr, fn_val, IkFlag::K, SumOption::Full, tol, None);
        phi_arr[j] = result.phi;
        zeta1_arr[j] = result.zeta1;
        zeta2_arr[j] = result.zeta2;
        sum_arr[j] = result.sum;
        init_arr[j] = result.cache.init;
        caches[j] = Some(result.cache);

        // Compute S1 exponent (Fortran lines 5797-5808)
        let s1_exp = if kode == Scaling::Exponential {
            let st = zr + result.zeta2;
            let rast = fn_val / zabs(st);
            result.zeta1 - st.conj() * (rast * rast)
        } else {
            result.zeta1 - result.zeta2
        };

        let mut rs1 = s1_exp.re;

        // -- Overflow/underflow test (Fortran lines 5814-5864) --
        if rs1.abs() > elim {
            // label 60: underflow or overflow
            if rs1 > zero {
                return -1; // label 300: overflow
            }
            if z.re < zero {
                return -1; // label 300
            }
            // Underflow
            kdflg = 1;
            y[i] = czero;
            nz += 1;
            if i > 0 && y[i - 1] == czero {
                // already zeroed
            } else if i > 0 {
                y[i - 1] = czero;
                nz += 1;
            }
            continue;
        }

        if kdflg == 1 {
            kflag = 2;
        }
        if rs1.abs() >= alim {
            // Refine test (Fortran lines 5820-5825)
            let aphi = zabs(result.phi);
            rs1 = rs1 + aphi.ln();
            if rs1.abs() > elim {
                // label 60
                if rs1 > zero {
                    return -1;
                }
                if z.re < zero {
                    return -1;
                }
                kdflg = 1;
                y[i] = czero;
                nz += 1;
                if i > 0 && y[i - 1] != czero {
                    y[i - 1] = czero;
                    nz += 1;
                }
                continue;
            }
            if kdflg == 1 {
                kflag = 1;
            }
            if rs1 >= zero && kdflg == 1 {
                kflag = 3;
            }
        }

        // -- Scale and store (Fortran lines 5831-5848) --
        let s2_raw = result.phi * result.sum;
        let s1_scaled = s1_exp.exp() * cssr[kflag - 1];
        let s2 = s2_raw * s1_scaled;

        if kflag == 1 && zuchk(s2, bry[0], tol) {
            // label 60: underflow
            if rs1 > zero {
                return -1;
            }
            if z.re < zero {
                return -1;
            }
            kdflg = 1;
            y[i] = czero;
            nz += 1;
            if i > 0 && y[i - 1] != czero {
                y[i - 1] = czero;
                nz += 1;
            }
            continue;
        }

        // label 50
        cy[kdflg - 1] = s2;
        y[i] = s2 * csrr[kflag - 1];

        if kdflg == 2 {
            i_exit = i + 1; // Fortran 1-based I
            fn_at_exit = fn_val;
            break;
        }
        kdflg = 2;
    }
    // If loop completed without early exit: i_exit = N (Fortran), fn_at_exit = fnu + N - 1

    if i_exit == n {
        fn_at_exit = fnu + T::from_f64((n - 1) as f64);
    }

    // -- Compute RZ and CK (Fortran lines 5868-5874) --
    let rz = reciprocal_z(zr);
    let mut ck = rz * fn_at_exit;

    let ib = i_exit + 1; // Fortran IB = I + 1 (1-based index of next item)

    // -- Test last member and forward recurrence (Fortran lines 5876-5961) --
    if ib <= n {
        // Test last member for underflow (Fortran lines 5881-5921)
        let fn_last = fnu + T::from_f64((n - 1) as f64); // Fortran line 5881
        let ipard = if mr != 0 {
            SumOption::Full
        } else {
            SumOption::SkipSum
        };
        let result_last = zunik(zr, fn_last, IkFlag::K, ipard, tol, None);
        caches[2] = Some(result_last.cache);

        let s1_last = if kode == Scaling::Exponential {
            let st = zr + result_last.zeta2;
            let rast = fn_last / zabs(st);
            result_last.zeta1 - st.conj() * (rast * rast)
        } else {
            result_last.zeta1 - result_last.zeta2
        };

        let mut rs1 = s1_last.re;
        if rs1.abs() > elim {
            // label 95
            if rs1.abs() > zero && rs1 > zero {
                return -1;
            }
            if z.re < zero {
                return -1;
            }
            nz = n as i32;
            y.fill(czero);
            return nz;
        }
        if rs1.abs() >= alim {
            let aphi = zabs(result_last.phi);
            rs1 = rs1 + aphi.ln();
            if rs1.abs() >= elim {
                // label 95
                if rs1 > zero {
                    return -1;
                }
                if z.re < zero {
                    return -1;
                }
                nz = n as i32;
                y.fill(czero);
                return nz;
            }
        }

        // label 100: forward recurrence (Fortran lines 5925-5961)
        let mut s1 = cy[0];
        let mut s2 = cy[1];
        let mut c1r = csrr[kflag - 1];
        let mut ascle = bry[kflag - 1];

        for y_item in y.iter_mut().take(n).skip(ib - 1) {
            let prev = s2;
            s2 = mul_add(ck, prev, s1);
            s1 = prev;
            ck = ck + rz;
            let c2_scaled = s2 * c1r;
            *y_item = c2_scaled;

            if kflag >= 3 {
                continue;
            }
            let c2m = c2_scaled.re.abs().max(c2_scaled.im.abs());
            if c2m <= ascle {
                continue;
            }
            kflag += 1;
            ascle = bry[kflag - 1];
            s1 = s1 * c1r;
            s2 = c2_scaled;
            s1 = s1 * cssr[kflag - 1];
            s2 = s2 * cssr[kflag - 1];
            c1r = csrr[kflag - 1];
        }
    }

    // -- Phase 2: Analytic continuation (Fortran lines 5963-6153) --
    if mr == 0 {
        return nz;
    }

    nz = 0;
    let fmr = T::from_f64(mr as f64);
    let sgn = if fmr < zero { pi_t } else { -pi_t };
    let csgni = sgn;

    // Safety: fnu is finite and < ~1e15 per upper-interface checks
    let inu = fnu.to_i32().unwrap() as usize;
    let fnf = fnu - T::from_f64(inu as f64);
    let ifn = inu + n - 1;
    let ang = fnf * sgn;
    let mut cspn = Complex::new(ang.cos(), ang.sin());
    if ifn % 2 != 0 {
        cspn = -cspn;
    }

    let asc = bry[0];
    let mut iuf: i32 = 0;
    let mut kk = n; // 1-based index counting down
    kdflg = 1;
    let ib_ac = ib.saturating_sub(1); // Fortran: IB = IB - 1 (1-based)
    let ic = ib_ac.saturating_sub(1); // Fortran: IC = IB - 1

    let mut iflag: usize = 2;

    // Phase 2 loop: K=1..N (Fortran labels 172-270)
    let mut k_exit = n; // Fortran K at loop exit
    for k in 0..n {
        let fn_val = fnu + T::from_f64((kk - 1) as f64);

        // -- Cache reuse logic (Fortran labels 172/175/180) --
        let mut m: usize = 2; // workspace slot (0-based), default = slot 2 (Fortran M=3)
        let mut use_cache: Option<UnikCache<T>> = None;

        if n <= 2 {
            // label 172: always try to reuse
            // Copy from J slot, then flip J
            use_cache = caches[j];
            m = j;
            j = 1 - j;
        } else {
            // label 175
            if kk == n && ib_ac < n {
                // First iteration with IB < N: fresh computation (M=3)
                // (INITD=0 implicit because use_cache=None)
            } else if kk == ib_ac || kk == ic {
                // label 172: reuse cache from phase 1
                use_cache = caches[j];
                m = j;
                j = 1 - j;
            }
            // else: INITD=0, fresh computation with M=2 (slot 3)
        }

        // label 180: call ZUNIK with IKFLG=1 (I function)
        let result_i = zunik(zr, fn_val, IkFlag::I, SumOption::Full, tol, use_cache);
        let phid = result_i.phi;
        let zet1d = result_i.zeta1;
        let zet2d = result_i.zeta2;
        let sumd = result_i.sum;
        caches[m] = Some(result_i.cache);

        // Compute S1 exponent for I function (Fortran lines 6019-6030)
        let s1_exp = if kode == Scaling::Exponential {
            let st = zr + zet2d;
            let rast = fn_val / zabs(st);
            st.conj() * (rast * rast) - zet1d
        } else {
            zet2d - zet1d
        };

        let mut rs1 = s1_exp.re;

        // -- Overflow/underflow test (Fortran lines 6035-6096) --
        if rs1.abs() > elim {
            // label 260
            if rs1 > zero {
                return -1; // label 300
            }
            // Underflow: S2 = 0 (goto 230)
            let s2_i = czero;
            let c2_save = s2_i;

            // Fall through to label 230
            cy[kdflg - 1] = s2_i;
            let s2_scaled = s2_i; // already zero

            // Add I and K functions (Fortran lines 6074-6081)
            let mut s1_k = y[kk - 1]; // Y(KK), 1-based
            let mut s2_k = s2_scaled;
            if kode == Scaling::Exponential {
                let s1s2_result = zs1s2(zr, s1_k, s2_k, asc, alim, iuf);
                s1_k = s1s2_result.s1;
                s2_k = s1s2_result.s2;
                nz += s1s2_result.nz;
                iuf = s1s2_result.iuf;
            }
            y[kk - 1] = mul_add(cspn, s1_k, s2_k);
            kk -= 1;
            cspn = -cspn;

            if c2_save == czero {
                kdflg = 1;
            } else if kdflg == 2 {
                k_exit = k + 1;
                break;
            } else {
                kdflg = 2;
            }
            continue;
        }

        if kdflg == 1 {
            iflag = 2;
        }
        if rs1.abs() >= alim {
            // Refine (Fortran lines 6042-6047)
            let aphi = zabs(phid);
            rs1 = rs1 + aphi.ln();
            if rs1.abs() > elim {
                // label 260
                if rs1 > zero {
                    return -1;
                }
                // S2 = 0 path
                let c2_save = czero;
                cy[kdflg - 1] = czero;
                let s2_scaled = czero;

                let mut s1_k = y[kk - 1];
                let mut s2_k = s2_scaled;
                if kode == Scaling::Exponential {
                    let s1s2_result = zs1s2(zr, s1_k, s2_k, asc, alim, iuf);
                    s1_k = s1s2_result.s1;
                    s2_k = s1s2_result.s2;
                    nz += s1s2_result.nz;
                    iuf = s1s2_result.iuf;
                }
                y[kk - 1] = mul_add(cspn, s1_k, s2_k);
                kk -= 1;
                cspn = -cspn;

                if c2_save == czero {
                    kdflg = 1;
                } else if kdflg == 2 {
                    k_exit = k + 1;
                    break;
                } else {
                    kdflg = 2;
                }
                continue;
            }
            if kdflg == 1 {
                iflag = 1;
            }
            if rs1 >= zero && kdflg == 1 {
                iflag = 3;
            }
        }

        // -- Compute I function contribution (Fortran lines 6048-6070) --
        // S2 = -CSGNI * Im(PHI*SUM) + i * CSGNI * Re(PHI*SUM)
        let ps = phid * sumd;
        let mut s2_i = Complex::new(zero, csgni) * ps;

        let s1_sc = s1_exp.exp() * cssr[iflag - 1];
        s2_i = s2_i * s1_sc;

        if iflag == 1 && zuchk(s2_i, bry[0], tol) {
            // NW != 0: set S2 to zero (Fortran lines 6062-6063)
            s2_i = czero;
        }

        // label 230
        cy[kdflg - 1] = s2_i;
        let c2_save = s2_i;
        let s2_scaled = s2_i * csrr[iflag - 1];

        // -- Add I and K functions (Fortran lines 6074-6091) --
        let mut s1_k = y[kk - 1]; // Y(KK)
        let mut s2_k = s2_scaled;

        if kode == Scaling::Exponential {
            let s1s2_result = zs1s2(zr, s1_k, s2_k, asc, alim, iuf);
            s1_k = s1s2_result.s1;
            s2_k = s1s2_result.s2;
            nz += s1s2_result.nz;
            iuf = s1s2_result.iuf;
        }

        // Y(KK) = CSPN * K_part + I_part (Fortran lines 6080-6081)
        y[kk - 1] = mul_add(cspn, s1_k, s2_k);
        kk -= 1;
        cspn = -cspn;

        // KDFLG state machine (Fortran lines 6085-6091)
        if c2_save == czero {
            kdflg = 1;
        } else if kdflg == 2 {
            k_exit = k + 1;
            break;
        } else {
            kdflg = 2;
        }
    }

    // -- Backward recurrence for remaining I terms (Fortran lines 6097-6153) --
    // Fortran: K = N after loop, or K = k_exit if early exit
    // IL = N - K (number of remaining items)
    let il = n - k_exit;
    if il == 0 {
        return nz;
    }

    // Recurrence with scaling (Fortran lines 6107-6153)
    let mut s1 = cy[0];
    let mut s2 = cy[1];
    let mut csr = csrr[iflag - 1];
    let mut ascle = bry[iflag - 1];
    let mut fn_rec = T::from_f64((inu + il) as f64);

    for _i in 0..il {
        let prev = s2;
        let cfn = fn_rec + fnf;
        s2 = s1 + rz * prev * cfn;
        s1 = prev;
        fn_rec = fn_rec - one;
        let ck_val = s2 * csr;

        // Add K function (Fortran lines 6126-6133)
        let mut c1_k = y[kk - 1]; // Y(KK)
        let mut c2_k = ck_val;

        if kode == Scaling::Exponential {
            let s1s2_result = zs1s2(zr, c1_k, c2_k, asc, alim, iuf);
            c1_k = s1s2_result.s1;
            c2_k = s1s2_result.s2;
            nz += s1s2_result.nz;
            iuf = s1s2_result.iuf;
        }

        y[kk - 1] = mul_add(cspn, c1_k, c2_k);
        kk -= 1;
        cspn = -cspn;

        if iflag >= 3 {
            continue;
        }
        let c2m = ck_val.re.abs().max(ck_val.im.abs());
        if c2m <= ascle {
            continue;
        }
        iflag += 1;
        ascle = bry[iflag - 1];
        s1 = s1 * csr;
        s2 = ck_val;
        s1 = s1 * cssr[iflag - 1];
        s2 = s2 * cssr[iflag - 1];
        csr = csrr[iflag - 1];
    }

    nz
}