qubit_function/functions/mutating_function/
arc_conditional_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 `ArcConditionalMutatingFunction` public type.
10
11#![allow(unused_imports)]
12
13use super::*;
14
15// ============================================================================
16// ArcConditionalMutatingFunction - Arc-based Conditional Mutating Function
17// ============================================================================
18
19/// ArcConditionalMutatingFunction struct
20///
21/// A thread-safe conditional function that only executes when a predicate is
22/// satisfied. Uses `ArcMutatingFunction` and `ArcPredicate` for shared ownership
23/// across threads.
24///
25/// This type is typically created by calling `ArcMutatingFunction::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 `Arc`, multiple owners allowed
31/// - **Thread-Safe**: Implements `Send + Sync`, safe for concurrent use
32/// - **Conditional Execution**: Only transforms when predicate returns `true`
33/// - **Chainable**: Can add `or_else` branch to create if-then-else logic
34///
35/// # Examples
36///
37/// ```rust
38/// use qubit_function::{MutatingFunction, ArcMutatingFunction};
39///
40/// let double = ArcMutatingFunction::new(|x: &mut i32| *x * 2);
41/// let identity = ArcMutatingFunction::<i32, i32>::identity();
42/// let conditional = double.when(|x: &i32| *x > 0).or_else(identity);
43///
44/// let conditional_clone = conditional.clone();
45///
46/// let mut positive = 5;
47/// assert_eq!(conditional.apply(&mut positive), 10);
48/// let mut negative = -5;
49/// assert_eq!(conditional_clone.apply(&mut negative), -5);
50/// ```
51///
52/// # Author
53///
54/// Haixing Hu
55pub struct ArcConditionalMutatingFunction<T, R> {
56    pub(super) function: ArcMutatingFunction<T, R>,
57    pub(super) predicate: ArcPredicate<T>,
58}
59
60// Use macro to generate conditional function implementations
61impl_shared_conditional_function!(
62    ArcConditionalMutatingFunction<T, R>,
63    ArcMutatingFunction,
64    MutatingFunction,
65    Send + Sync + 'static
66);
67
68// Use macro to generate conditional function clone implementations
69impl_conditional_function_clone!(ArcConditionalMutatingFunction<T, R>);
70
71// Use macro to generate conditional function debug and display implementations
72impl_conditional_function_debug_display!(ArcConditionalMutatingFunction<T, R>);
qubit_function/functions/mutating_function/arc_conditional_mutating_function.rs

qubit_function/functions/mutating_function/
arc_conditional_mutating_function.rs
