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