deep_causality_discovery 0.3.4

Causality discovery DSL for the DeepCausality project.
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

/*
 * SPDX-License-Identifier: MIT
 * Copyright (c) 2023 - 2026. The DeepCausality Authors and Contributors. All Rights Reserved.
 */

use crate::{FeatureSelectError, FeatureSelectorConfig};
use deep_causality_tensor::CausalTensor;

/// Defines the contract for feature selection algorithms.
///
/// This trait abstracts the process of selecting a subset of relevant features (columns)
/// from a larger dataset, which is a common step in preparing data for causal discovery.
pub trait FeatureSelector {
    /// Selects a subset of features from the input tensor.
    ///
    /// # Arguments
    ///
    /// * `tensor` - The input `CausalTensor<f64>` containing the full set of features.
    /// * `config` - A `FeatureSelectorConfig` enum containing the specific settings
    ///   for the selection algorithm (e.g., `MrmrConfig`).
    ///
    /// # Returns
    ///
    /// A `Result` containing a new `CausalTensor<f64>` with only the selected
    /// feature columns on success.
    ///
    /// # Errors
    ///
    /// Returns a `FeatureSelectError` if the selection process fails, for example if
    /// the number of requested features is invalid.
    fn select(
        &self,
        tensor: CausalTensor<Option<f64>>,
        config: &FeatureSelectorConfig,
    ) -> Result<CausalTensor<Option<f64>>, FeatureSelectError>;
}