qubit_function/functions/function/
rc_conditional_function.rs

1/*******************************************************************************
2 *
3 *    Copyright (c) 2025 - 2026.
4 *    Haixing Hu, Qubit Co. Ltd.
5 *
6 *    All rights reserved.
7 *
8 ******************************************************************************/
9//! Defines the `RcConditionalFunction` public type.
10
11#![allow(unused_imports)]
12
13use super::*;
14
15// ============================================================================
16// RcConditionalFunction - Rc-based Conditional Function
17// ============================================================================
18
19/// RcConditionalFunction struct
20///
21/// A single-threaded conditional function that only executes when a
22/// predicate is satisfied. Uses `RcFunction` and `RcPredicate` for shared
23/// ownership within a single thread.
24///
25/// This type is typically created by calling `RcFunction::when()` and is
26/// designed to work with the `or_else()` method to create if-then-else logic.
27///
28/// # Features
29///
30/// - **Shared Ownership**: Cloneable via `Rc`, multiple owners allowed
31/// - **Single-Threaded**: Not thread-safe, cannot be sent across threads
32/// - **Conditional Execution**: Only transforms when predicate returns `true`
33/// - **No Lock Overhead**: More efficient than `ArcConditionalFunction`
34///
35/// # Examples
36///
37/// ```rust
38/// use qubit_function::{Function, RcFunction};
39///
40/// let double = RcFunction::new(|x: &i32| x * 2);
41/// let identity = RcFunction::<i32, i32>::identity();
42/// let conditional = double.when(|x: &i32| *x > 0).or_else(identity);
43///
44/// let conditional_clone = conditional.clone();
45///
46/// assert_eq!(conditional.apply(&5), 10);
47/// assert_eq!(conditional_clone.apply(&-5), -5);
48/// ```
49///
50/// # Author
51///
52/// Haixing Hu
53pub struct RcConditionalFunction<T, R> {
54    pub(super) function: RcFunction<T, R>,
55    pub(super) predicate: RcPredicate<T>,
56}
57
58// Use macro to generate conditional function implementations
59impl_shared_conditional_function!(
60    RcConditionalFunction<T, R>,
61    RcFunction,
62    Function,
63    'static
64);
65
66// Use macro to generate conditional function clone implementations
67impl_conditional_function_clone!(RcConditionalFunction<T, R>);
68
69// Use macro to generate conditional function debug and display implementations
70impl_conditional_function_debug_display!(RcConditionalFunction<T, R>);
qubit_function/functions/function/rc_conditional_function.rs

qubit_function/functions/function/
rc_conditional_function.rs
