qubit_function/transformers/transformer/
box_conditional_transformer.rs

1/*******************************************************************************
2 *
3 *    Copyright (c) 2025 - 2026.
4 *    Haixing Hu, Qubit Co. Ltd.
5 *
6 *    All rights reserved.
7 *
8 ******************************************************************************/
9//! Defines the `BoxConditionalTransformer` public type.
10
11#![allow(unused_imports)]
12
13use super::*;
14
15// ============================================================================
16// BoxConditionalTransformer - Box-based Conditional Transformer
17// ============================================================================
18
19/// BoxConditionalTransformer struct
20///
21/// A conditional transformer that only executes when a predicate is satisfied.
22/// Uses `BoxTransformer` and `BoxPredicate` for single ownership semantics.
23///
24/// This type is typically created by calling `BoxTransformer::when()` and is
25/// designed to work with the `or_else()` method to create if-then-else logic.
26///
27/// # Features
28///
29/// - **Single Ownership**: Not cloneable, consumes `self` on use
30/// - **Conditional Execution**: Only transforms when predicate returns `true`
31/// - **Chainable**: Can add `or_else` branch to create if-then-else logic
32/// - **Implements Transformer**: Can be used anywhere a `Transformer` is expected
33///
34/// # Examples
35///
36/// ## With or_else Branch
37///
38/// ```rust
39/// use qubit_function::{Transformer, BoxTransformer};
40///
41/// let double = BoxTransformer::new(|x: i32| x * 2);
42/// let negate = BoxTransformer::new(|x: i32| -x);
43/// let conditional = double.when(|x: &i32| *x > 0).or_else(negate);
44///
45/// assert_eq!(conditional.apply(5), 10); // when branch executed
46/// assert_eq!(conditional.apply(-5), 5); // or_else branch executed
47/// ```
48///
49/// # Author
50///
51/// Haixing Hu
52pub struct BoxConditionalTransformer<T, R> {
53    pub(super) transformer: BoxTransformer<T, R>,
54    pub(super) predicate: BoxPredicate<T>,
55}
56
57// Implement BoxConditionalTransformer
58impl_box_conditional_transformer!(
59    BoxConditionalTransformer<T, R>,
60    BoxTransformer,
61    Transformer
62);
63
64// Use macro to generate Debug and Display implementations
65impl_conditional_transformer_debug_display!(BoxConditionalTransformer<T, R>);
qubit_function/transformers/transformer/box_conditional_transformer.rs

qubit_function/transformers/transformer/
box_conditional_transformer.rs
