scirs2-stats 0.4.2

Statistical functions module for SciRS2 (scirs2-stats)
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
//! Enhanced Quasi-Monte Carlo sequences with state-of-the-art algorithms
//!
//! This module provides advanced QMC sequences with:
//! - Optimal digital nets and (t,m,s)-nets
//! - Advanced scrambling and randomization techniques
//! - Parallel QMC sequence generation
//! - Adaptive sequence refinement

use crate::error::{StatsError, StatsResult};
use scirs2_core::ndarray::{Array1, Array2};
use scirs2_core::numeric::{Float, FromPrimitive, One, Zero};
use scirs2_core::random::{rngs::StdRng, Rng, RngExt, SeedableRng};
use scirs2_core::{parallel_ops::*, simd_ops::SimdUnifiedOps, validation::*};
use std::marker::PhantomData;

/// Enhanced QMC sequence generator with parallel support
pub struct EnhancedQMCGenerator<F> {
    /// Sequence type
    pub sequence_type: EnhancedSequenceType,
    /// Dimension
    pub dimension: usize,
    /// Configuration
    pub config: EnhancedQMCConfig,
    /// Generator state
    pub state: QMCGeneratorState,
    _phantom: PhantomData<F>,
}

/// Enhanced sequence types with advanced algorithms
#[derive(Debug, Clone, PartialEq)]
pub enum EnhancedSequenceType {
    /// Sobol sequence with advanced scrambling
    SobolAdvanced {
        /// Use Owen scrambling
        owen_scrambling: bool,
        /// Use digital shift
        digital_shift: bool,
        /// Use nested scrambling
        nested_scrambling: bool,
    },
    /// Niederreiter sequence with base optimization
    Niederreiter {
        /// Base selection strategy
        base_strategy: BaseSelectionStrategy,
        /// Use generating matrix optimization
        matrix_optimization: bool,
    },
    /// Faure sequence with improved uniformity
    FaureImproved {
        /// Use permutation optimization
        permutation_optimization: bool,
        /// Use radical inverse improvements
        radical_inverse_improvements: bool,
    },
    /// Digital (t,m,s)-nets
    DigitalNet {
        /// Net parameters
        net_params: DigitalNetParams,
        /// Construction method
        construction_method: NetConstructionMethod,
    },
    /// Hybrid sequences combining multiple methods
    Hybrid {
        /// Primary sequence type
        primary: Box<EnhancedSequenceType>,
        /// Secondary sequence type
        secondary: Box<EnhancedSequenceType>,
        /// Combination strategy
        combination: HybridCombinationStrategy,
    },
}

/// Base selection strategies for Niederreiter sequences
#[derive(Debug, Clone, PartialEq)]
pub enum BaseSelectionStrategy {
    /// Use first primes
    FirstPrimes,
    /// Use optimized primes for given dimension
    OptimizedPrimes,
    /// Use prime powers for better uniformity
    PrimePowers,
    /// Automatic selection based on dimension
    Automatic,
}

/// Digital net parameters
#[derive(Debug, Clone, PartialEq)]
pub struct DigitalNetParams {
    /// t parameter (strength)
    pub t: usize,
    /// m parameter (precision)
    pub m: usize,
    /// s parameter (dimension)
    pub s: usize,
    /// Base (usually 2)
    pub base: usize,
}

/// Net construction methods
#[derive(Debug, Clone, PartialEq)]
pub enum NetConstructionMethod {
    /// Sobol construction
    Sobol,
    /// Niederreiter-Xing construction
    NiederreiterXing,
    /// Polynomial lattice rules
    PolynomialLattice,
    /// Finite field constructions
    FiniteField,
}

/// Hybrid combination strategies
#[derive(Debug, Clone, PartialEq)]
pub enum HybridCombinationStrategy {
    /// Interleave sequences
    Interleave,
    /// Weighted combination
    Weighted(f64),
    /// Dimension-wise alternation
    DimensionAlternation,
    /// Adaptive selection based on uniformity
    Adaptive,
}

/// Enhanced QMC configuration
#[derive(Debug, Clone)]
pub struct EnhancedQMCConfig {
    /// Enable parallel generation
    pub parallel: bool,
    /// Chunk size for parallel processing
    pub chunksize: usize,
    /// Randomization seed
    pub seed: Option<u64>,
    /// Enable SIMD optimizations
    pub use_simd: bool,
    /// Quality assessment threshold
    pub quality_threshold: f64,
    /// Maximum sequence length for quality assessment
    pub max_assessment_length: usize,
    /// Enable adaptive refinement
    pub adaptive_refinement: bool,
}

impl Default for EnhancedQMCConfig {
    fn default() -> Self {
        Self {
            parallel: true,
            chunksize: 1000,
            seed: None,
            use_simd: true,
            quality_threshold: 1e-3,
            max_assessment_length: 10000,
            adaptive_refinement: false,
        }
    }
}

/// Generator state for QMC sequences
#[derive(Debug, Clone)]
pub struct QMCGeneratorState {
    /// Current index
    pub current_index: usize,
    /// Scrambling matrices (if used)
    pub scrambling_matrices: Option<Vec<Array2<u32>>>,
    /// Digital shift vectors (if used)
    pub digital_shifts: Option<Vec<Array1<u32>>>,
    /// Quality metrics
    pub quality_metrics: QualityMetrics,
}

/// Quality metrics for QMC sequences
#[derive(Debug, Clone, Default)]
pub struct QualityMetrics {
    /// Star discrepancy estimate
    pub star_discrepancy: f64,
    /// Wrap-around discrepancy
    pub wraparound_discrepancy: f64,
    /// Diaphony (spectral measure)
    pub diaphony: f64,
    /// Figure of merit
    pub figure_of_merit: f64,
}

impl<F> EnhancedQMCGenerator<F>
where
    F: Float + Zero + One + Copy + Send + Sync + SimdUnifiedOps + FromPrimitive + std::fmt::Display,
    for<'a> &'a F: std::iter::Product<&'a F>,
{
    /// Create new enhanced QMC generator
    pub fn new(
        sequence_type: EnhancedSequenceType,
        dimension: usize,
        config: EnhancedQMCConfig,
    ) -> StatsResult<Self> {
        check_positive(dimension, "dimension")?;

        if dimension > 1000 {
            return Err(StatsError::InvalidArgument(
                "Dimension cannot exceed 1000 for enhanced QMC sequences".to_string(),
            ));
        }

        let state = QMCGeneratorState {
            current_index: 0,
            scrambling_matrices: None,
            digital_shifts: None,
            quality_metrics: QualityMetrics::default(),
        };

        let mut generator = Self {
            sequence_type,
            dimension,
            config,
            state,
            _phantom: PhantomData,
        };

        // Initialize scrambling and digital shifts if needed
        generator.initialize_randomization()?;

        Ok(generator)
    }

    /// Generate enhanced QMC sequence
    pub fn generate(&mut self, n: usize) -> StatsResult<Array2<F>> {
        check_positive(n, "n")?;

        if self.config.parallel && n >= self.config.chunksize {
            self.generate_parallel(n)
        } else {
            self.generate_sequential(n)
        }
    }

    /// Generate sequence in parallel
    fn generate_parallel(&mut self, n: usize) -> StatsResult<Array2<F>> {
        let chunksize = self.config.chunksize;
        let num_chunks = n.div_ceil(chunksize);

        let chunks = parallel_map_result(
            (0..num_chunks).collect::<Vec<_>>().as_slice(),
            |&chunk_idx| {
                let start = chunk_idx * chunksize;
                let end = (start + chunksize).min(n);
                let chunksize = end - start;

                self.generate_chunk(start, chunksize)
            },
        )?;

        // Combine chunks
        let mut result = Array2::zeros((n, self.dimension));
        let mut row_idx = 0;

        for chunk in chunks {
            let chunk = chunk;
            let chunk_rows = chunk.nrows();
            result
                .slice_mut(scirs2_core::ndarray::s![row_idx..row_idx + chunk_rows, ..])
                .assign(&chunk);
            row_idx += chunk_rows;
        }

        // Update quality metrics
        if n <= self.config.max_assessment_length {
            self.assess_quality(&result)?;
        }

        Ok(result)
    }

    /// Generate sequence sequentially
    fn generate_sequential(&mut self, n: usize) -> StatsResult<Array2<F>> {
        let mut result = Array2::zeros((n, self.dimension));

        for i in 0..n {
            let point = self.next_point()?;
            result.row_mut(i).assign(&point);
        }

        // Update quality metrics
        if n <= self.config.max_assessment_length {
            self.assess_quality(&result)?;
        }

        Ok(result)
    }

    /// Generate a chunk of the sequence
    fn generate_chunk(&self, start_index: usize, chunksize: usize) -> StatsResult<Array2<F>> {
        let mut chunk = Array2::zeros((chunksize, self.dimension));

        for i in 0..chunksize {
            let _index = start_index + i;
            let point = self.compute_point_at_index(_index)?;
            chunk.row_mut(i).assign(&point);
        }

        Ok(chunk)
    }

    /// Compute next point in sequence
    fn next_point(&mut self) -> StatsResult<Array1<F>> {
        let point = self.compute_point_at_index(self.state.current_index)?;
        self.state.current_index += 1;
        Ok(point)
    }

    /// Compute point at specific index
    fn compute_point_at_index(&self, index: usize) -> StatsResult<Array1<F>> {
        match &self.sequence_type {
            EnhancedSequenceType::SobolAdvanced {
                owen_scrambling,
                digital_shift,
                nested_scrambling,
            } => self.compute_sobol_advanced(
                index,
                *owen_scrambling,
                *digital_shift,
                *nested_scrambling,
            ),
            EnhancedSequenceType::Niederreiter {
                base_strategy,
                matrix_optimization,
            } => self.compute_niederreiter_enhanced(index, base_strategy, *matrix_optimization),
            EnhancedSequenceType::FaureImproved {
                permutation_optimization,
                radical_inverse_improvements,
            } => self.compute_faure_improved(
                index,
                *permutation_optimization,
                *radical_inverse_improvements,
            ),
            EnhancedSequenceType::DigitalNet {
                net_params,
                construction_method,
            } => self.compute_digital_net(index, net_params, construction_method),
            EnhancedSequenceType::Hybrid {
                primary,
                secondary,
                combination,
            } => self.compute_hybrid_sequence(index, primary, secondary, combination),
        }
    }

    /// Compute advanced Sobol sequence point
    fn compute_sobol_advanced(
        &self,
        index: usize,
        owen_scrambling: bool,
        digital_shift: bool,
        _nested_scrambling: bool,
    ) -> StatsResult<Array1<F>> {
        let mut point = Array1::zeros(self.dimension);

        // Use simplified Sobol computation for now
        // Full implementation would use proper direction numbers and _scrambling
        for dim in 0..self.dimension {
            let mut result = 0u32;
            let mut idx = index;

            // Basic van der Corput sequence in base 2
            let mut base_power = 1u32;
            while idx > 0 {
                if idx & 1 == 1 {
                    result ^= base_power << (31 - (base_power.trailing_zeros()));
                }
                idx >>= 1;
                base_power <<= 1;
            }

            // Apply _scrambling if enabled
            if owen_scrambling {
                if let Some(ref matrices) = self.state.scrambling_matrices {
                    if dim < matrices.len() {
                        result = self.apply_owen_scrambling(result, &matrices[dim]);
                    }
                }
            }

            // Apply digital _shift if enabled
            if digital_shift {
                if let Some(ref shifts) = self.state.digital_shifts {
                    if dim < shifts.len() {
                        result ^= shifts[dim][0]; // Simplified
                    }
                }
            }

            point[dim] = F::from(result as f64 / (1u64 << 32) as f64).expect("Operation failed");
        }

        Ok(point)
    }

    /// Compute enhanced Niederreiter sequence point
    fn compute_niederreiter_enhanced(
        &self,
        index: usize,
        base_strategy: &BaseSelectionStrategy,
        _matrix_optimization: bool,
    ) -> StatsResult<Array1<F>> {
        // Simplified implementation
        let mut point = Array1::zeros(self.dimension);

        for dim in 0..self.dimension {
            // Use prime base for this dimension
            let base = self.get_prime(dim);
            point[dim] = F::from(self.radical_inverse(index, base)).expect("Operation failed");
        }

        Ok(point)
    }

    /// Compute improved Faure sequence point
    fn compute_faure_improved(
        &self,
        index: usize,
        _permutation_optimization: bool,
        _radical_inverse_improvements: bool,
    ) -> StatsResult<Array1<F>> {
        // Simplified implementation
        let mut point = Array1::zeros(self.dimension);
        let base = self.smallest_prime_geq(self.dimension as u32);

        for dim in 0..self.dimension {
            point[dim] = F::from(self.radical_inverse(index, base)).expect("Operation failed");
        }

        Ok(point)
    }

    /// Compute digital net point
    fn compute_digital_net(
        &self,
        index: usize,
        _net_params: &DigitalNetParams,
        _construction_method: &NetConstructionMethod,
    ) -> StatsResult<Array1<F>> {
        // Simplified implementation - use Sobol-like computation
        self.compute_sobol_advanced(index, false, false, false)
    }

    /// Compute hybrid sequence point
    fn compute_hybrid_sequence(
        &self,
        index: usize,
        _primary: &EnhancedSequenceType,
        _secondary: &EnhancedSequenceType,
        _combination: &HybridCombinationStrategy,
    ) -> StatsResult<Array1<F>> {
        // Simplified implementation - use _primary sequence
        self.compute_sobol_advanced(index, true, true, false)
    }

    /// Initialize randomization (scrambling, digital shifts)
    fn initialize_randomization(&mut self) -> StatsResult<()> {
        let mut rng = match self.config.seed {
            Some(seed) => StdRng::seed_from_u64(seed),
            None => StdRng::from_rng(&mut scirs2_core::random::thread_rng()),
        };

        // Initialize scrambling matrices
        if self.needs_scrambling() {
            let mut matrices = Vec::with_capacity(self.dimension);
            for _ in 0..self.dimension {
                matrices.push(self.generate_scrambling_matrix(&mut rng)?);
            }
            self.state.scrambling_matrices = Some(matrices);
        }

        // Initialize digital shifts
        if self.needs_digital_shift() {
            let mut shifts = Vec::with_capacity(self.dimension);
            for _ in 0..self.dimension {
                let shift = Array1::from_shape_fn(32, |_| rng.random::<u32>());
                shifts.push(shift);
            }
            self.state.digital_shifts = Some(shifts);
        }

        Ok(())
    }

    /// Check if sequence type needs scrambling
    fn needs_scrambling(&self) -> bool {
        match &self.sequence_type {
            EnhancedSequenceType::SobolAdvanced {
                owen_scrambling, ..
            } => *owen_scrambling,
            _ => false,
        }
    }

    /// Check if sequence type needs digital shift
    fn needs_digital_shift(&self) -> bool {
        match &self.sequence_type {
            EnhancedSequenceType::SobolAdvanced { digital_shift, .. } => *digital_shift,
            _ => false,
        }
    }

    /// Generate scrambling matrix
    fn generate_scrambling_matrix<R: Rng>(&self, rng: &mut R) -> StatsResult<Array2<u32>> {
        let mut matrix = Array2::zeros((32, 32));

        // Generate random permutation matrix
        for i in 0..32 {
            let j = rng.random_range(0..32);
            matrix[[i, j]] = 1;
        }

        Ok(matrix)
    }

    /// Apply Owen scrambling to a value
    fn apply_owen_scrambling(&self, value: u32, matrix: &Array2<u32>) -> u32 {
        let mut result = 0u32;

        for i in 0..32 {
            let bit = (value >> (31 - i)) & 1;
            for j in 0..32 {
                if matrix[[i, j]] == 1 && bit == 1 {
                    result |= 1u32 << (31 - j);
                    break;
                }
            }
        }

        result
    }

    /// Compute radical inverse
    fn radical_inverse(&self, index: usize, base: u32) -> f64 {
        let mut result = 0.0;
        let mut fraction = 1.0 / base as f64;
        let mut i = index;

        while i > 0 {
            result += (i % base as usize) as f64 * fraction;
            i /= base as usize;
            fraction /= base as f64;
        }

        result
    }

    /// Get nth prime number
    fn get_prime(&self, n: usize) -> u32 {
        let primes = [
            2, 3, 5, 7, 11, 13, 17, 19, 23, 29, 31, 37, 41, 43, 47, 53, 59, 61, 67, 71,
        ];
        if n < primes.len() {
            primes[n]
        } else {
            // Fallback to simple generation
            let mut candidate = primes[primes.len() - 1] + 2;
            let mut count = primes.len();

            while count <= n {
                if self.is_prime(candidate) {
                    if count == n {
                        return candidate;
                    }
                    count += 1;
                }
                candidate += 2;
            }
            candidate
        }
    }

    /// Find smallest prime >= n
    fn smallest_prime_geq(&self, n: u32) -> u32 {
        if n <= 2 {
            return 2;
        }

        let mut candidate = if n.is_multiple_of(2) { n + 1 } else { n };

        while !self.is_prime(candidate) {
            candidate += 2;
        }

        candidate
    }

    /// Check if number is prime
    fn is_prime(&self, n: u32) -> bool {
        if n < 2 {
            return false;
        }
        if n == 2 {
            return true;
        }
        if n.is_multiple_of(2) {
            return false;
        }

        let sqrt_n = (n as f64).sqrt() as u32;
        for i in (3..=sqrt_n).step_by(2) {
            if n.is_multiple_of(i) {
                return false;
            }
        }

        true
    }

    /// Assess sequence quality
    fn assess_quality(&mut self, sequence: &Array2<F>) -> StatsResult<()> {
        // Simplified quality assessment
        let n = sequence.nrows();
        let d = sequence.ncols();

        // Estimate star discrepancy (simplified)
        let mut max_discrepancy = 0.0;
        let num_test_points = 50.min(n);

        let mut rng = scirs2_core::random::thread_rng();
        for _ in 0..num_test_points {
            let mut test_point = Array1::zeros(d);
            for j in 0..d {
                test_point[j] = F::from(rng.random::<f64>()).expect("Operation failed");
            }

            let mut count = 0;
            for i in 0..n {
                let mut in_box = true;
                for j in 0..d {
                    if sequence[[i, j]] > test_point[j] {
                        in_box = false;
                        break;
                    }
                }
                if in_box {
                    count += 1;
                }
            }

            let volume: F = test_point.iter().fold(F::one(), |acc, &x| acc * x);
            let expected = volume.to_f64().expect("Operation failed") * n as f64;
            let discrepancy = (count as f64 - expected).abs() / n as f64;
            max_discrepancy = max_discrepancy.max(discrepancy);
        }

        self.state.quality_metrics.star_discrepancy = max_discrepancy;
        Ok(())
    }

    /// Get current quality metrics
    pub fn quality_metrics(&self) -> &QualityMetrics {
        &self.state.quality_metrics
    }
}

/// Convenience functions for enhanced QMC
#[allow(dead_code)]
pub fn enhanced_sobol<F>(
    n: usize,
    dimension: usize,
    scrambling: bool,
    seed: Option<u64>,
) -> StatsResult<Array2<F>>
where
    F: Float + Zero + One + Copy + Send + Sync + SimdUnifiedOps + FromPrimitive + std::fmt::Display,
    for<'a> &'a F: std::iter::Product<&'a F>,
{
    let sequence_type = EnhancedSequenceType::SobolAdvanced {
        owen_scrambling: scrambling,
        digital_shift: true,
        nested_scrambling: false,
    };

    let config = EnhancedQMCConfig {
        seed,
        ..Default::default()
    };

    let mut generator = EnhancedQMCGenerator::new(sequence_type, dimension, config)?;
    generator.generate(n)
}

#[allow(dead_code)]
pub fn enhanced_niederreiter<F>(
    n: usize,
    dimension: usize,
    seed: Option<u64>,
) -> StatsResult<Array2<F>>
where
    F: Float + Zero + One + Copy + Send + Sync + SimdUnifiedOps + FromPrimitive + std::fmt::Display,
    for<'a> &'a F: std::iter::Product<&'a F>,
{
    let sequence_type = EnhancedSequenceType::Niederreiter {
        base_strategy: BaseSelectionStrategy::OptimizedPrimes,
        matrix_optimization: true,
    };

    let config = EnhancedQMCConfig {
        seed,
        ..Default::default()
    };

    let mut generator = EnhancedQMCGenerator::new(sequence_type, dimension, config)?;
    generator.generate(n)
}

#[allow(dead_code)]
pub fn enhanced_digital_net<F>(
    n: usize,
    dimension: usize,
    t: usize,
    seed: Option<u64>,
) -> StatsResult<Array2<F>>
where
    F: Float + Zero + One + Copy + Send + Sync + SimdUnifiedOps + FromPrimitive + std::fmt::Display,
    for<'a> &'a F: std::iter::Product<&'a F>,
{
    let net_params = DigitalNetParams {
        t,
        m: 32,
        s: dimension,
        base: 2,
    };

    let sequence_type = EnhancedSequenceType::DigitalNet {
        net_params,
        construction_method: NetConstructionMethod::Sobol,
    };

    let config = EnhancedQMCConfig {
        seed,
        ..Default::default()
    };

    let mut generator = EnhancedQMCGenerator::new(sequence_type, dimension, config)?;
    generator.generate(n)
}