qubit_function/transformers/transformer/
arc_conditional_transformer.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 `ArcConditionalTransformer` public type.
12
13#![allow(unused_imports)]
14
15use super::*;
16
17// ============================================================================
18// ArcConditionalTransformer - Arc-based Conditional Transformer
19// ============================================================================
20
21/// ArcConditionalTransformer struct
22///
23/// A thread-safe conditional transformer that only executes when a predicate is
24/// satisfied. Uses `ArcTransformer` and `ArcPredicate` for shared ownership
25/// across threads.
26///
27/// This type is typically created by calling `ArcTransformer::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 `Arc`, multiple owners allowed
33/// - **Thread-Safe**: Implements `Send + Sync`, safe for concurrent use
34/// - **Conditional Execution**: Only transforms when predicate returns `true`
35/// - **Chainable**: Can add `or_else` branch to create if-then-else logic
36///
37/// # Examples
38///
39/// ```rust
40/// use qubit_function::{Transformer, ArcTransformer};
41///
42/// let double = ArcTransformer::new(|x: i32| x * 2);
43/// let identity = ArcTransformer::<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 ArcConditionalTransformer<T, R> {
53    pub(super) transformer: ArcTransformer<T, R>,
54    pub(super) predicate: ArcPredicate<T>,
55}
56
57// Implement ArcConditionalTransformer
58impl_shared_conditional_transformer!(
59    ArcConditionalTransformer<T, R>,
60    ArcTransformer,
61    Transformer,
62    into_arc,
63    Send + Sync + 'static
64);
65
66// Use macro to generate Debug and Display implementations
67impl_conditional_transformer_debug_display!(ArcConditionalTransformer<T, R>);
68
69// Implement Clone for ArcConditionalTransformer
70impl_conditional_transformer_clone!(ArcConditionalTransformer<T, R>);
qubit_function/transformers/transformer/arc_conditional_transformer.rs

qubit_function/transformers/transformer/
arc_conditional_transformer.rs
