qubit_function/functions/stateful_mutating_function/
rc_conditional_stateful_mutating_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 `RcConditionalStatefulMutatingFunction` public type.
10
11#![allow(unused_imports)]
12
13use super::*;
14
15// ============================================================================
16// RcConditionalStatefulMutatingFunction - Rc-based Conditional Stateful Mutating Function
17// ============================================================================
18
19/// RcConditionalStatefulMutatingFunction struct
20///
21/// A single-threaded conditional function that only executes when a
22/// predicate is satisfied. Uses `RcStatefulMutatingFunction` and `RcPredicate` for shared
23/// ownership within a single thread.
24///
25/// This type is typically created by calling `RcStatefulMutatingFunction::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::{StatefulMutatingFunction, RcStatefulMutatingFunction};
39///
40/// let double = RcStatefulMutatingFunction::new(|x: &mut i32| {
41///     *x *= 2;
42///     *x
43/// });
44/// let identity = RcStatefulMutatingFunction::<i32, i32>::identity();
45/// let mut conditional = double.when(|x: &i32| *x > 0).or_else(identity);
46///
47/// let mut conditional_clone = conditional.clone();
48///
49/// let mut positive = 5;
50/// let mut negative = -5;
51/// assert_eq!(conditional.apply(&mut positive), 10);
52/// assert_eq!(conditional_clone.apply(&mut negative), -5);
53/// ```
54///
55/// # Author
56///
57/// Haixing Hu
58pub struct RcConditionalStatefulMutatingFunction<T, R> {
59    pub(super) function: RcStatefulMutatingFunction<T, R>,
60    pub(super) predicate: RcPredicate<T>,
61}
62
63// Use macro to generate conditional function implementations
64impl_shared_conditional_function!(
65    RcConditionalStatefulMutatingFunction<T, R>,
66    RcStatefulMutatingFunction,
67    StatefulMutatingFunction,
68    'static
69);
70
71// Use macro to generate conditional function clone implementations
72impl_conditional_function_clone!(RcConditionalStatefulMutatingFunction<T, R>);
73
74// Use macro to generate conditional function debug and display implementations
75impl_conditional_function_debug_display!(RcConditionalStatefulMutatingFunction<T, R>);
qubit_function/functions/stateful_mutating_function/rc_conditional_stateful_mutating_function.rs

qubit_function/functions/stateful_mutating_function/
rc_conditional_stateful_mutating_function.rs
