qubit_function/functions/bi_function/arc_binary_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 `ArcBinaryFunction` public type.
10
11#![allow(unused_imports)]
12
13use super::*;
14
15/// Type alias for `ArcBiFunction<T, T, R>`
16///
17/// Represents a thread-safe binary function that takes two values of type `T`
18/// and produces a value of type `R`. Similar to Java's `BiFunction<T, T, R>`
19/// with shared, thread-safe ownership.
20///
21/// # Examples
22///
23/// ```rust
24/// use qubit_function::{ArcBinaryFunction, BiFunction};
25///
26/// let multiply: ArcBinaryFunction<i32, i32> = ArcBinaryFunction::new(|x, y| *x * *y);
27/// let multiply_clone = multiply.clone();
28/// assert_eq!(multiply.apply(&6, &7), 42);
29/// assert_eq!(multiply_clone.apply(&6, &7), 42);
30/// ```
31///
32/// # Author
33///
34/// Haixing Hu
35pub type ArcBinaryFunction<T, R> = ArcBiFunction<T, T, R>;