qubit_function/functions/function/
rc_conditional_function.rs

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

qubit_function/functions/function/
rc_conditional_function.rs
