sklears-decomposition 0.2.0

Matrix decomposition algorithms for sklears: PCA, ICA, NMF, SVD
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

//! Matrix and tensor decomposition algorithms for dimensionality reduction
//!
//! This module provides various decomposition techniques including:
//! - PCA: Principal Component Analysis with SVD (including Randomized SVD)
//! - Incremental PCA: Memory-efficient PCA for large datasets
//! - Kernel PCA: Non-linear dimensionality reduction using kernel methods
//! - ICA: Independent Component Analysis (including constrained ICA)
//! - NMF: Non-negative Matrix Factorization
//! - Factor Analysis: Statistical model for latent variables
//! - Dictionary Learning: Sparse coding and dictionary learning
//! - Tensor Decomposition: CP (CANDECOMP/PARAFAC) and Tucker decomposition
//! - Matrix Completion: Filling missing values using low-rank matrix completion
//! - CCA: Canonical Correlation Analysis for finding linear relationships between two datasets
//! - PLS: Partial Least Squares for regression and dimensionality reduction
//! - Time Series: SSA, seasonal decomposition, and trend extraction
//! - Signal Processing: EMD, spectral decomposition, and adaptive methods
//! - Image & Computer Vision: 2D-PCA, image denoising, face recognition, texture analysis
//! - Manifold Learning: LLE, Isomap, Laplacian Eigenmaps, t-SNE, UMAP
//! - Component Selection: Cross-validation, bootstrap, information criteria, parallel analysis
//! - Quality Metrics: Goodness-of-fit statistics, reconstruction quality, interpretability measures
//! - Robust Methods: Robust PCA with L1 loss, M-estimators, outlier-resistant methods
//! - Hardware Acceleration: SIMD optimizations, parallel processing, and mixed-precision arithmetic
//! - Distributed Processing: Large-scale distributed decomposition across multiple nodes/workers
//! - Scikit-learn Compatibility: Drop-in replacements for scikit-learn transformers with full API compatibility
//! - Advanced Format Support: HDF5, sparse matrices, memory-mapped files, and compressed storage
//! - Cache Optimization: Memory-aligned data structures, tiled algorithms, and performance analysis
//! - Comprehensive Validation: Input validation, parameter checking, and result quality assessment
//! - Modular Architecture: Pluggable algorithms, preprocessing pipelines, and extensible framework
//! - Constrained Decomposition: Orthogonality, non-negativity, sparsity, and smoothness constraints
//! - Type-Safe Decomposition: Zero-cost abstractions with compile-time dimension and rank checking

// Import the s! macro from scirs2_core for array slicing
#[allow(unused_imports)]
pub use scirs2_core::s;

pub mod cache_optimization;
pub mod cca;
pub mod component_selection;
pub mod constrained_decomposition;
pub mod dictionary_learning;
pub mod distributed;
pub mod error_diagnostics;
pub mod factor_analysis;
pub mod fluent_api;
pub mod format_support;
pub mod hardware_acceleration;
pub mod ica;
pub mod image_cv;
pub mod incremental_pca;
pub mod integration;
pub mod kernel_pca;
pub mod manifold;
pub mod matrix_completion;
pub mod memory_efficiency;
pub mod modular_framework;
pub mod nmf;
pub mod online_nmf;
pub mod pca;
pub mod performance;
pub mod pls;
pub mod quality_metrics;
pub mod robust_methods;
pub mod signal_processing;
mod simd_signal;
pub mod sklearn_compat;
pub mod streaming;
pub mod tensor_decomposition;
pub mod time_series;
pub mod type_safe;
pub mod validation;
pub mod visualization;

#[cfg(test)]
pub mod property_tests;
pub use cache_optimization::*;
pub use cca::*;
pub use component_selection::*;
pub use constrained_decomposition::*;
pub use dictionary_learning::*;
pub use distributed::*;
pub use error_diagnostics::*;
pub use factor_analysis::*;
pub use fluent_api::*;
// Re-export format_support excluding SparseMatrix and MemoryMappedMatrix (conflict with integration and memory_efficiency)
#[cfg(feature = "hdf5-support")]
pub use format_support::HDF5Support;
pub use format_support::{DecompositionResults, FormatConfig, SparseFormat};
#[cfg(feature = "sparse")]
pub use format_support::{SparseDecompositionResult, SparseMatrixSupport, SparseStats};
pub use hardware_acceleration::{
    AccelerationConfig, AlignedMemoryOps, MixedPrecisionOps, ParallelDecomposition, SimdMatrixOps,
};
#[cfg(feature = "gpu")]
pub use hardware_acceleration::{GpuAcceleration, GpuDecomposition};
pub use ica::*;
pub use image_cv::*;
pub use integration::*;
// Re-export incremental_pca excluding IncrementalPcaConfig (conflicts with pca::IncrementalPcaConfig type alias)
pub use incremental_pca::IncrementalPCA;
pub use kernel_pca::{KernelApproximation, KernelFunction, KernelPCA, KernelPcaConfig};
pub use manifold::{DistanceMetric, ManifoldAlgorithm, ManifoldLearning, TrainedManifoldLearning};
pub use matrix_completion::{
    CompletionAlgorithm, LowRankMatrixRecovery, MatrixCompletion, RecoveryAlgorithm,
    TrainedLowRankMatrixRecovery, TrainedMatrixCompletion,
};
pub use memory_efficiency::*;
// Re-export modular_framework excluding DecompositionAlgorithm enum and DecompositionPipeline struct to avoid conflicts
pub use modular_framework::{
    AlgorithmCapabilities, AlgorithmCapability, AlgorithmMetadata, AlgorithmRegistry,
    ComputationalComplexity, DecompositionAlgorithm as DecompositionAlgorithmTrait,
    DecompositionComponents, DecompositionParams, DecompositionWorkflowBuilder, MatrixProperty,
    ParamValue, PostprocessingStep, PreprocessingStep, StandardizationStep, VarimaxRotationStep,
};
pub use nmf::*;
pub use online_nmf::*;
pub use pca::*;
pub use performance::*;
pub use pls::{FittedPLS, PLSAlgorithm, PartialLeastSquares};
pub use quality_metrics::*;
pub use robust_methods::{
    BreakdownPointAnalysis, BreakdownResult, LossFunction, MEstimatorDecomposition,
    MEstimatorResult, RobustConfig, RobustPCAResult,
};
pub use signal_processing::*;
// Re-export sklearn_compat with ParameterValue aliased to avoid conflict with validation
pub use sklearn_compat::{
    CrossValidation, GridSearchCV, ParameterValue as SklearnParameterValue, SklearnPCA,
    SklearnPipeline, SklearnTransformer,
};
pub use streaming::*;
pub use tensor_decomposition::{
    CPAlgorithm, CPDecomposition, TrainedCP, TrainedTucker, TuckerAlgorithm, TuckerDecomposition,
};
pub use time_series::*;
// Re-export type_safe with DecompositionPipeline aliased to avoid conflict
pub use type_safe::{
    CenteringOperation, ComponentAccess, ComponentIndex, DecompositionOperation,
    DecompositionPipeline as TypeSafeDecompositionPipeline, DecompositionState, Dimensions, Fitted,
    Rank, ScalingOperation, TypeSafeDecomposition, TypeSafeMatrix, TypeSafePCA, Untrained,
};
pub use validation::*;
pub use visualization::*;