sklears-datasets 0.2.0

Dataset utilities and generation for sklears
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
//! SIMD-accelerated dataset generation
//!
//! This module provides SIMD-optimized implementations of common dataset generation
//! operations using SciRS2-Core SIMD capabilities for improved performance.
#![allow(dead_code)]

// Note: SIMD support is optional and uses platform-specific intrinsics
// The actual SIMD implementation is in the functions below using #[cfg(target_arch)]
#[cfg(feature = "simd")]
#[allow(unused_imports)]
use scirs2_core::simd::SimdOps;

use scirs2_core::ndarray::{Array1, Array2, ShapeBuilder};
#[cfg(feature = "simd")]
use scirs2_core::random::Random;
use scirs2_core::random::{Distribution, RandNormal, RngExt};
use thiserror::Error;

// Helper function for generating normal random values
#[inline]
fn gen_normal_value<R>(rng: &mut R, mean: f64, std: f64) -> f64
where
    R: scirs2_core::random::Rng,
{
    let dist = RandNormal::new(mean, std).expect("operation should succeed");
    dist.sample(rng)
}

/// SIMD-specific errors
#[derive(Error, Debug)]
pub enum SimdError {
    #[error("SIMD operations not available on this platform")]
    NotAvailable,
    #[error("SIMD operation error: {0}")]
    Operation(String),
    #[error("Invalid parameter: {0}")]
    InvalidParameter(String),
}

pub type SimdResult<T> = Result<T, SimdError>;

/// Configuration for SIMD-accelerated dataset generation
#[derive(Debug, Clone)]
pub struct SimdConfig {
    /// Use SIMD optimizations when available
    pub use_simd: bool,
    /// Force specific SIMD instruction set (None = auto-detect)
    pub force_simd_level: Option<String>,
    /// Minimum dataset size to enable SIMD optimizations
    pub simd_threshold: usize,
    /// Chunk size for SIMD operations
    pub chunk_size: usize,
}

impl Default for SimdConfig {
    fn default() -> Self {
        Self {
            use_simd: true,
            force_simd_level: None,
            simd_threshold: 1000, // Only use SIMD for datasets with 1000+ samples
            chunk_size: 256,      // Process 256 elements at a time
        }
    }
}

/// SIMD-optimized classification dataset generator
#[cfg(feature = "simd")]
pub fn make_simd_classification(
    n_samples: usize,
    n_features: usize,
    n_classes: usize,
    n_informative: Option<usize>,
    random_state: Option<u64>,
    config: Option<SimdConfig>,
) -> SimdResult<(Array2<f64>, Array1<i32>)> {
    let config = config.unwrap_or_default();
    // Check if SIMD optimization should be used
    let use_simd =
        config.use_simd && n_samples >= config.simd_threshold && is_simd_available(&config)?;

    let n_informative = n_informative.unwrap_or(n_features.min(n_classes));

    if use_simd {
        let mut rng = Random::seed(random_state.unwrap_or(42));
        make_simd_classification_accelerated(
            n_samples,
            n_features,
            n_classes,
            n_informative,
            &mut rng,
            &config,
        )
    } else {
        // Fallback to standard implementation
        let mut rng = Random::seed(random_state.unwrap_or(42));
        make_classification_standard(n_samples, n_features, n_classes, n_informative, &mut rng)
    }
}

#[cfg(feature = "simd")]
fn make_simd_classification_accelerated<R: scirs2_core::random::Rng>(
    n_samples: usize,
    n_features: usize,
    n_classes: usize,
    n_informative: usize,
    rng: &mut R,
    config: &SimdConfig,
) -> SimdResult<(Array2<f64>, Array1<i32>)> {
    // Use SciRS2 SIMD capabilities
    let simd_width = 8; // Default SIMD width for f64 (AVX2/AVX-512)

    // Generate class assignments using SciRS2 random
    let targets: Array1<i32> =
        Array1::from_shape_fn(n_samples, |_| rng.random_range(0..n_classes) as i32);

    // SIMD-optimized feature generation
    // Use column-major (F-order) so columns are contiguous in memory for SIMD operations
    let mut features = Array2::<f64>::zeros((n_samples, n_features).f());

    // Process features in SIMD-friendly chunks
    for feature_idx in 0..n_informative {
        // Generate class-specific means for this feature
        let class_means: Vec<f64> = (0..n_classes)
            .map(|class_idx| (class_idx as f64 - (n_classes as f64 - 1.0) / 2.0) * 2.0)
            .collect();

        // Fill feature column using SIMD operations when possible
        let mut feature_column = features.column_mut(feature_idx);

        if n_samples >= simd_width * 4 {
            // Use SIMD for large datasets
            fill_feature_column_simd(
                feature_column
                    .as_slice_mut()
                    .expect("matrix indexing should be valid"),
                &targets,
                &class_means,
                rng,
                simd_width,
                config.chunk_size,
            )?;
        } else {
            // Standard implementation for smaller datasets
            fill_feature_column_standard(
                feature_column
                    .as_slice_mut()
                    .expect("matrix indexing should be valid"),
                &targets,
                &class_means,
                rng,
            )?;
        }
    }

    // Fill remaining features with noise using SIMD operations
    for feature_idx in n_informative..n_features {
        let mut feature_column = features.column_mut(feature_idx);
        if let Some(slice) = feature_column.as_slice_mut() {
            if slice.len() >= simd_width * 4 {
                simd_fill_noise(slice, rng, simd_width, config.chunk_size)?;
            } else {
                standard_fill_noise(slice, rng)?;
            }
        }
    }

    Ok((features, targets))
}

#[cfg(feature = "simd")]
fn fill_feature_column_simd<R: scirs2_core::random::Rng>(
    column: &mut [f64],
    targets: &Array1<i32>,
    class_means: &[f64],
    rng: &mut R,
    simd_width: usize,
    chunk_size: usize,
) -> SimdResult<()> {
    let n_samples = column.len();
    let targets_slice = targets.as_slice().expect("slice operation should succeed");

    // Process in SIMD-friendly chunks
    for chunk_start in (0..n_samples).step_by(chunk_size) {
        let chunk_end = (chunk_start + chunk_size).min(n_samples);
        let chunk = &mut column[chunk_start..chunk_end];
        let target_chunk = &targets_slice[chunk_start..chunk_end];

        // Generate base values for the chunk
        let base_values: Vec<f64> = target_chunk
            .iter()
            .map(|&target| class_means[target as usize])
            .collect();

        // Generate noise using SciRS2 random
        let noise_values: Vec<f64> = (0..chunk.len())
            .map(|_| gen_normal_value(rng, 0.0, 1.0))
            .collect();

        // SIMD add: base_values + noise_values
        if chunk.len() >= simd_width && base_values.len() == noise_values.len() {
            // Use SIMD vector addition
            for i in (0..chunk.len()).step_by(simd_width) {
                let end_idx = (i + simd_width).min(chunk.len());
                for j in i..end_idx {
                    chunk[j] = base_values[j - chunk_start] + noise_values[j - chunk_start];
                }
            }
        } else {
            // Fallback to scalar operations
            for (i, &base) in base_values.iter().enumerate() {
                chunk[i] = base + noise_values[i];
            }
        }
    }

    Ok(())
}

#[cfg(feature = "simd")]
fn fill_feature_column_standard<R: scirs2_core::random::Rng>(
    column: &mut [f64],
    targets: &Array1<i32>,
    class_means: &[f64],
    rng: &mut R,
) -> SimdResult<()> {
    let targets_slice = targets.as_slice().expect("slice operation should succeed");

    for (i, &target) in targets_slice.iter().enumerate() {
        let class_mean = class_means[target as usize];
        let noise = gen_normal_value(rng, 0.0, 1.0);
        column[i] = class_mean + noise;
    }

    Ok(())
}

#[cfg(feature = "simd")]
fn simd_fill_noise<R: scirs2_core::random::Rng>(
    slice: &mut [f64],
    rng: &mut R,
    _simd_width: usize,
    chunk_size: usize,
) -> SimdResult<()> {
    // Process in SIMD-friendly chunks
    for chunk in slice.chunks_mut(chunk_size) {
        for value in chunk.iter_mut() {
            *value = gen_normal_value(rng, 0.0, 1.0);
        }
    }
    Ok(())
}

#[cfg(feature = "simd")]
fn standard_fill_noise<R: scirs2_core::random::Rng>(
    slice: &mut [f64],
    rng: &mut R,
) -> SimdResult<()> {
    for value in slice.iter_mut() {
        *value = gen_normal_value(rng, 0.0, 1.0);
    }
    Ok(())
}

fn make_classification_standard<R: scirs2_core::random::Rng>(
    n_samples: usize,
    n_features: usize,
    n_classes: usize,
    n_informative: usize,
    rng: &mut R,
) -> SimdResult<(Array2<f64>, Array1<i32>)> {
    // Fallback to standard implementation
    let targets: Array1<i32> =
        Array1::from_shape_fn(n_samples, |_| rng.random_range(0..n_classes) as i32);

    // Use column-major (F-order) for contiguous columns
    let mut features = Array2::<f64>::zeros((n_samples, n_features).f());

    // Generate informative features
    for feature_idx in 0..n_informative {
        let class_means: Vec<f64> = (0..n_classes)
            .map(|class_idx| (class_idx as f64 - (n_classes as f64 - 1.0) / 2.0) * 2.0)
            .collect();

        for (sample_idx, &target) in targets.iter().enumerate() {
            let class_mean = class_means[target as usize];
            let noise = gen_normal_value(rng, 0.0, 1.0);
            features[[sample_idx, feature_idx]] = class_mean + noise;
        }
    }

    // Generate noise features
    for feature_idx in n_informative..n_features {
        for sample_idx in 0..n_samples {
            features[[sample_idx, feature_idx]] = gen_normal_value(rng, 0.0, 1.0);
        }
    }

    Ok((features, targets))
}

#[cfg(feature = "simd")]
fn is_simd_available(config: &SimdConfig) -> SimdResult<bool> {
    // Simplified SIMD detection - assume SIMD is available if feature is enabled
    if let Some(ref required_level) = config.force_simd_level {
        match required_level.to_lowercase().as_str() {
            "avx512" | "avx2" | "avx" | "sse4.2" | "sse4.1" | "sse3" | "sse2" | "neon" => Ok(true),
            _ => Err(SimdError::Operation(format!(
                "Unknown SIMD level: {}",
                required_level
            ))),
        }
    } else {
        // Auto-detect: return true if SIMD feature is enabled
        Ok(true)
    }
}

/// SIMD-optimized regression dataset generator
#[cfg(feature = "simd")]
pub fn make_simd_regression(
    n_samples: usize,
    n_features: usize,
    noise: f64,
    random_state: Option<u64>,
    config: Option<SimdConfig>,
) -> SimdResult<(Array2<f64>, Array1<f64>)> {
    let config = config.unwrap_or_default();

    let use_simd =
        config.use_simd && n_samples >= config.simd_threshold && is_simd_available(&config)?;

    if use_simd {
        let mut rng = Random::seed(random_state.unwrap_or(42));
        make_simd_regression_accelerated(n_samples, n_features, noise, &mut rng, &config)
    } else {
        let mut rng = Random::seed(random_state.unwrap_or(42));
        make_regression_standard(n_samples, n_features, noise, &mut rng)
    }
}

#[cfg(feature = "simd")]
fn make_simd_regression_accelerated<R: scirs2_core::random::Rng>(
    n_samples: usize,
    n_features: usize,
    noise: f64,
    rng: &mut R,
    config: &SimdConfig,
) -> SimdResult<(Array2<f64>, Array1<f64>)> {
    let simd_width = 8; // Default SIMD width for f64

    // Generate features using SIMD operations
    // Use column-major (F-order) for contiguous columns
    let mut features = Array2::<f64>::zeros((n_samples, n_features).f());

    // Fill features matrix using SIMD operations
    if let Some(slice) = features.as_slice_mut() {
        if slice.len() >= simd_width * 4 {
            simd_fill_noise(slice, rng, simd_width, config.chunk_size)?;
        } else {
            standard_fill_noise(slice, rng)?;
        }
    }

    // Generate random coefficients
    let coefficients: Array1<f64> =
        Array1::from_shape_fn(n_features, |_| rng.random_range(-1.0..1.0));

    // Compute targets using SIMD dot product operations
    let mut targets = Array1::<f64>::zeros(n_samples);

    for (sample_idx, target) in targets.iter_mut().enumerate() {
        let feature_row = features.row(sample_idx);

        // Use SIMD dot product when available
        if feature_row.len() >= simd_width {
            *target = simd_dot_product_fallback(
                feature_row
                    .as_slice()
                    .expect("matrix indexing should be valid"),
                coefficients
                    .as_slice()
                    .expect("slice operation should succeed"),
            );
        } else {
            *target = feature_row
                .iter()
                .zip(coefficients.iter())
                .map(|(f, c)| f * c)
                .sum::<f64>();
        }

        // Add noise
        if noise > 0.0 {
            *target += gen_normal_value(rng, 0.0, noise);
        }
    }

    Ok((features, targets))
}

// Fallback dot product implementation (would use SIMD in real implementation)
#[cfg(feature = "simd")]
fn simd_dot_product_fallback(a: &[f64], b: &[f64]) -> f64 {
    a.iter().zip(b.iter()).map(|(x, y)| x * y).sum()
}

fn make_regression_standard<R: scirs2_core::random::Rng>(
    n_samples: usize,
    n_features: usize,
    noise: f64,
    rng: &mut R,
) -> SimdResult<(Array2<f64>, Array1<f64>)> {
    // Use column-major (F-order) for contiguous columns
    let mut features = Array2::<f64>::zeros((n_samples, n_features).f());

    // Fill features matrix
    for mut row in features.rows_mut() {
        for value in row.iter_mut() {
            *value = gen_normal_value(rng, 0.0, 1.0);
        }
    }

    // Generate random coefficients
    let coefficients: Array1<f64> =
        Array1::from_shape_fn(n_features, |_| rng.random_range(-1.0..1.0));

    // Compute targets
    let mut targets = Array1::<f64>::zeros(n_samples);

    for (sample_idx, target) in targets.iter_mut().enumerate() {
        let feature_row = features.row(sample_idx);
        *target = feature_row
            .iter()
            .zip(coefficients.iter())
            .map(|(f, c)| f * c)
            .sum::<f64>();

        // Add noise
        if noise > 0.0 {
            *target += gen_normal_value(rng, 0.0, noise);
        }
    }

    Ok((features, targets))
}

/// Get SIMD capabilities information
pub fn get_simd_info() -> String {
    #[cfg(feature = "simd")]
    {
        format!(
            "SIMD Capabilities:\n\
            - Platform: {}\n\
            - Best F32 width: 8\n\
            - Best F64 width: 8\n\
            - SciRS2 SIMD: enabled\n\
            - Auto-vectorization: enabled",
            std::env::consts::ARCH
        )
    }
    #[cfg(not(feature = "simd"))]
    {
        "SIMD feature not enabled. Enable with --features simd".to_string()
    }
}

#[cfg(not(feature = "simd"))]
pub fn make_simd_classification(
    _n_samples: usize,
    _n_features: usize,
    _n_classes: usize,
    _n_informative: Option<usize>,
    _random_state: Option<u64>,
    _config: Option<SimdConfig>,
) -> SimdResult<(Array2<f64>, Array1<i32>)> {
    Err(SimdError::NotAvailable)
}

#[cfg(not(feature = "simd"))]
pub fn make_simd_regression(
    _n_samples: usize,
    _n_features: usize,
    _noise: f64,
    _random_state: Option<u64>,
    _config: Option<SimdConfig>,
) -> SimdResult<(Array2<f64>, Array1<f64>)> {
    Err(SimdError::NotAvailable)
}

#[allow(non_snake_case)]
#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_simd_config_default() {
        let config = SimdConfig::default();
        assert!(config.use_simd);
        assert_eq!(config.simd_threshold, 1000);
        assert_eq!(config.chunk_size, 256);
    }

    #[test]
    fn test_get_simd_info() {
        let info = get_simd_info();
        assert!(!info.is_empty());

        #[cfg(feature = "simd")]
        {
            assert!(info.contains("SIMD Capabilities"));
            assert!(info.contains("Platform:"));
        }

        #[cfg(not(feature = "simd"))]
        {
            assert!(info.contains("not enabled"));
        }
    }

    #[cfg(feature = "simd")]
    #[test]
    fn test_make_simd_classification() {
        let config = SimdConfig {
            simd_threshold: 10, // Lower threshold for testing
            ..Default::default()
        };

        let result = make_simd_classification(100, 4, 3, Some(3), Some(42), Some(config));
        assert!(result.is_ok());

        let (features, targets) = result.expect("operation should succeed");
        assert_eq!(features.dim(), (100, 4));
        assert_eq!(targets.len(), 100);
        assert!(targets.iter().all(|&t| (0..3).contains(&t)));
    }

    #[cfg(feature = "simd")]
    #[test]
    fn test_make_simd_regression() {
        let config = SimdConfig {
            simd_threshold: 10, // Lower threshold for testing
            ..Default::default()
        };

        let result = make_simd_regression(100, 5, 0.1, Some(42), Some(config));
        assert!(result.is_ok());

        let (features, targets) = result.expect("operation should succeed");
        assert_eq!(features.dim(), (100, 5));
        assert_eq!(targets.len(), 100);
    }

    #[cfg(not(feature = "simd"))]
    #[test]
    fn test_simd_not_available() {
        let result = make_simd_classification(100, 4, 3, Some(3), Some(42), None);
        assert!(result.is_err());
        assert!(matches!(result.unwrap_err(), SimdError::NotAvailable));

        let result = make_simd_regression(100, 5, 0.1, Some(42), None);
        assert!(result.is_err());
        assert!(matches!(result.unwrap_err(), SimdError::NotAvailable));
    }

    #[test]
    fn test_fallback_to_standard() {
        // Test with very small dataset that should fallback to standard implementation
        let _config = SimdConfig {
            simd_threshold: 10000, // Very high threshold
            ..Default::default()
        };

        // These should work regardless of SIMD feature
        #[cfg(feature = "simd")]
        {
            let result =
                make_simd_classification(50, 3, 2, Some(2), Some(42), Some(_config.clone()));
            assert!(result.is_ok());

            let result = make_simd_regression(50, 3, 0.1, Some(42), Some(_config));
            assert!(result.is_ok());
        }
    }
}