sklears_core/

macros.rs

/// Advanced macro definitions for sklears-core
///
/// This module provides powerful declarative macros for common patterns in machine learning code,
/// validation, builder patterns, code generation utilities, and advanced ML algorithm scaffolding.
///
/// ## Key Features
/// - **Dataset Creation**: Quick dataset macros for testing and prototyping
/// - **Type System Helpers**: Trait bound definitions and complex type constraints
/// - **Configuration Management**: Parameter mapping and validation macros
/// - **Code Generation**: Boilerplate reduction for ML algorithms
/// - **Testing Infrastructure**: Comprehensive test suite generation
/// - **Performance Optimizations**: SIMD and parallel processing macros
///
/// Creates a quick dataset for testing and demonstration purposes
///
/// # Examples
/// ```ignore
/// use sklears_core::quick_dataset;
/// // SciRS2 Policy: Using scirs2_core::ndarray (COMPLIANT)
/// use scirs2_core::ndarray::{arr1, arr2};
///
/// let dataset = quick_dataset!(
///     data: arr2(&[[1.0, 2.0], [3.0, 4.0], [5.0, 6.0]]),
///     target: arr1(&[0.0, 1.0, 0.0])
/// );
/// ```
#[macro_export]
macro_rules! quick_dataset {
    (data: $data:expr, target: $target:expr) => {
        $crate::dataset::Dataset::builder()
            .data($data)
            .target($target)
            .build()
    };
    (data: $data:expr) => {
        $crate::dataset::Dataset::builder().data($data).build()
    };
}

/// Helper macro for creating trait bound combinations commonly used in ML
///
/// # Examples
/// ```rust,ignore
/// use sklears_core::define_ml_float_bounds;
///
/// define_ml_float_bounds!(FloatBounds);
///
/// fn process_data<T: FloatBounds>(data: T) -> T {
///     data
/// }
/// ```
#[macro_export]
macro_rules! define_ml_float_bounds {
    ($name:ident) => {
        trait $name:
            Float + NumCast + Copy + Clone + Send + Sync + std::fmt::Debug
        {
        }
        impl<T> $name for T where
            T: Float
                + NumCast
                + Copy
                + Clone
                + Send
                + Sync
                + std::fmt::Debug
        {
        }
    };
}

/// Creates a simple parameter mapping for algorithm configurations
///
/// # Examples
/// ```
/// use sklears_core::parameter_map;
///
/// let params = parameter_map! {
///     alpha: 1.0,
///     max_iter: 1000.0,
///     tol: 1e-6
/// };
/// ```
#[macro_export]
macro_rules! parameter_map {
    ($($param:ident: $value:expr),* $(,)?) => {
        {
            let mut params = std::collections::HashMap::new();
            $(
                params.insert(stringify!($param).to_string(), $value);
            )*
            params
        }
    };
}

/// Helper macro for creating default trait implementations
///
/// # Examples
/// ```
/// use sklears_core::impl_default_config;
///
/// struct MyConfig {
///     alpha: f64,
///     max_iter: usize,
/// }
///
/// impl_default_config! {
///     MyConfig {
///         alpha: 1.0,
///         max_iter: 100,
///     }
/// }
/// ```
#[macro_export]
macro_rules! impl_default_config {
    ($struct_name:ident { $($field:ident: $default:expr),* $(,)? }) => {
        impl Default for $struct_name {
            fn default() -> Self {
                Self {
                    $($field: $default,)*
                }
            }
        }
    };
}

/// Implements standard machine learning traits for an estimator
///
/// This macro generates boilerplate implementations for common ML traits
#[macro_export]
macro_rules! impl_ml_traits {
    ($estimator:ident) => {
        impl $crate::traits::Estimator for $estimator {
            type Config = ();

            fn name(&self) -> &str {
                stringify!($estimator)
            }
        }
    };
    ($estimator:ident, config: $config:ty) => {
        impl $crate::traits::Estimator for $estimator {
            type Config = $config;

            fn name(&self) -> &str {
                stringify!($estimator)
            }
        }
    };
}

/// Creates a test suite for an estimator implementation
///
/// This generates comprehensive tests including property-based testing
#[macro_export]
macro_rules! estimator_test_suite {
    ($estimator:ident) => {
        #[allow(non_snake_case)]
        #[cfg(test)]
        mod tests {
            use super::*;
            use $crate::test_utilities::*;

            #[test]
            fn test_estimator_creation() {
                let estimator = $estimator::new();
                assert_eq!(estimator.name(), stringify!($estimator));
            }

            #[test]
            fn test_estimator_clone() {
                let estimator = $estimator::new();
                let cloned = estimator.clone();
                assert_eq!(estimator.name(), cloned.name());
            }
        }
    };
}

/// Advanced macro for creating ML estimators with builder pattern and validation
///
/// This macro generates comprehensive boilerplate code for ML estimators including:
/// - Builder pattern implementation
/// - Parameter validation
/// - Standard trait implementations
/// - Error handling
///
/// # Examples
/// ```rust,ignore
/// use sklears_core::define_estimator;
///
/// define_estimator! {
///     name: LinearRegression,
///     config: LinearRegressionConfig {
///         fit_intercept: bool = true,
///         regularization: f64 = 0.0
///     },
///     features: [Fit, Predict],
///     validation: {
///         regularization >= 0.0
///     }
/// }
/// ```
#[macro_export]
macro_rules! define_estimator {
    (
        name: $name:ident,
        config: $config:ident {
            $(
                $field:ident: $type:ty = $default:expr
            ),* $(,)?
        },
        features: [$($trait:ident),* $(,)?],
        validation: {
            $(
                $validation:expr
            ),* $(,)?
        }
    ) => {
        /// Auto-generated configuration struct
        #[derive(Debug, Clone, PartialEq)]
        pub struct $config {
            $(
                pub $field: $type,
            )*
        }

        impl Default for $config {
            fn default() -> Self {
                Self {
                    $(
                        $field: $default,
                    )*
                }
            }
        }

        /// Auto-generated builder struct
        #[derive(Debug, Clone)]
        pub struct $name<State = $crate::types::const_generic::FixedFeatures<f64, 1>> {
            config: $config,
            _state: std::marker::PhantomData<State>,
        }

        impl Default for $name {
            fn default() -> Self {
                Self::new()
            }
        }

        impl $name {
            /// Create a new estimator with default configuration
            pub fn new() -> Self {
                Self {
                    config: $config::default(),
                    _state: std::marker::PhantomData,
                }
            }

            /// Create a builder for configuring the estimator
            pub fn builder() -> $name<()> {
                $name {
                    config: $config::default(),
                    _state: std::marker::PhantomData,
                }
            }

            $(
                /// Set parameter
                pub fn $field(mut self, value: $type) -> Self {
                    self.config.$field = value;
                    self
                }
            )*

            /// Validate the configuration
            pub fn validate(&self) -> $crate::error::Result<()> {
                $(
                    if !($validation) {
                        return Err($crate::error::SklearsError::InvalidInput(
                            format!("Validation failed: {}", stringify!($validation))
                        ));
                    }
                )*
                Ok(())
            }

            /// Get the estimator name
            pub fn name(&self) -> &'static str {
                stringify!($name)
            }
        }

        impl $crate::traits::Estimator for $name {
            type Config = $config;

            fn name(&self) -> &'static str {
                stringify!($name)
            }

            fn config(&self) -> &Self::Config {
                &self.config
            }
        }

        // Generate test module (simplified to avoid paste dependency)
        #[allow(non_snake_case)]
#[cfg(test)]
        mod tests {
            use super::*;

            #[test]
            fn test_default_creation() {
                let estimator = $name::default();
                assert_eq!(estimator.name(), stringify!($name));
                estimator.validate().unwrap();
            }

            #[test]
            fn test_builder_pattern() {
                let estimator = $name::builder();
                estimator.validate().unwrap();
            }
        }
    };
}

/// Macro for creating type-safe validation rules
///
/// # Examples
/// ```rust,ignore
/// use sklears_core::validation_rules;
///
/// validation_rules! {
///     positive: |x: f64| x > 0.0,
///     probability: |x: f64| x >= 0.0 && x <= 1.0,
///     non_empty: |s: &str| !s.is_empty()
/// }
/// ```
#[macro_export]
macro_rules! validation_rules {
    ($(
        $rule_name:ident: |$param:ident: $type:ty| $condition:expr
    ),* $(,)?) => {
        $(
            pub fn $rule_name($param: $type) -> bool {
                $condition
            }
        )*
    };
}

// ========== ADVANCED MACRO SYSTEM ENHANCEMENTS ==========

/// Creates a complete ML algorithm with all necessary boilerplate
///
/// This macro generates:
/// - Configuration struct with validation
/// - State management (trained/untrained)
/// - Builder pattern implementation
/// - Core trait implementations
/// - Basic test suite
/// - Documentation templates
///
/// # Examples
/// ```rust,ignore
/// use sklears_core::define_ml_algorithm;
///
/// define_ml_algorithm! {
///     name: LinearRegression,
///     config: {
///         fit_intercept: bool = true,
///         alpha: f64 = 1.0 => validate(|x| x >= 0.0),
///         max_iter: usize = 1000 => validate(|x| x > 0)
///     },
///     fit_fn: fit_linear_regression,
///     predict_fn: predict_linear_regression,
///     algorithm_type: supervised_regression
/// }
/// ```
#[macro_export]
macro_rules! define_ml_algorithm {
    (
        name: $name:ident,
        config: {
            $(
                $field:ident: $field_type:ty = $default:expr
                $(=> validate($validator:expr))?
            ),* $(,)?
        },
        fit_fn: $fit_fn:ident,
        predict_fn: $predict_fn:ident,
        algorithm_type: $algorithm_type:ident
    ) => {
        // Configuration struct with validation
        #[derive(Debug, Clone)]
        pub struct [<$name Config>] {
            $(
                pub $field: $field_type,
            )*
        }

        impl Default for [<$name Config>] {
            fn default() -> Self {
                Self {
                    $(
                        $field: $default,
                    )*
                }
            }
        }

        impl [<$name Config>] {
            /// Validate all configuration parameters
            pub fn validate(&self) -> $crate::error::Result<()> {
                $(
                    $(
                        if !($validator)(self.$field) {
                            return Err($crate::error::SklearsError::InvalidInput(
                                format!("Validation failed for {}: {:?}", stringify!($field), self.$field)
                            ));
                        }
                    )?
                )*
                Ok(())
            }
        }
    };
}

/// Creates comprehensive benchmarking suite for ML algorithms
///
/// # Examples
/// ```rust,ignore
/// benchmark_suite! {
///     algorithm: LinearRegression,
///     datasets: [small_dataset, medium_dataset, large_dataset],
///     metrics: [fit_time, predict_time, memory_usage],
///     iterations: 100
/// }
/// ```
#[macro_export]
macro_rules! benchmark_suite {
    (
        algorithm: $algo:ident,
        datasets: [$($dataset:ident),* $(,)?],
        metrics: [$($metric:ident),* $(,)?],
        iterations: $iters:expr
    ) => {
        #[allow(non_snake_case)]
#[cfg(test)]
        mod benchmarks {
            use super::*;
            use std::time::Instant;

            $(
                #[test]
                fn [<bench_ $algo:snake _ $dataset>]() {
                    let dataset = $dataset();
                    let mut total_fit_time = std::time::Duration::new(0, 0);
                    let mut total_predict_time = std::time::Duration::new(0, 0);

                    for _ in 0..$iters {
                        let algo = $algo::default();
                        let start = Instant::now();
                        let _ = start.elapsed(); // Placeholder for actual benchmarking
                    }

                    println!("{} benchmark completed", stringify!($algo));
                }
            )*
        }
    };
}

/// Creates SIMD-optimized operation implementations
///
/// # Examples
/// ```rust,ignore
/// simd_operations! {
///     dot_product: (a: &[f64], b: &[f64]) -> f64 {
///         simd: |a, b| simd_dot(a, b),
///         fallback: |a, b| a.iter().zip(b).map(|(x, y)| x * y).sum()
///     }
/// }
/// ```
#[macro_export]
macro_rules! simd_operations {
    ($(
        $op_name:ident: ($($param:ident: $param_type:ty),*) -> $return_type:ty {
            simd: |$($simd_param:ident),*| $simd_impl:expr,
            fallback: |$($fallback_param:ident),*| $fallback_impl:expr
        }
    ),* $(,)?) => {
        $(
            /// SIMD-optimized operation with fallback
            pub fn $op_name($($param: $param_type),*) -> $return_type {
                #[cfg(target_feature = "avx2")]
                {
                    // SIMD implementation would go here
                    $fallback_impl // Fallback for now
                }
                #[cfg(not(target_feature = "avx2"))]
                {
                    $fallback_impl
                }
            }
        )*
    };
}