Source code for qilisdk.noise.bit_flip

# Copyright 2026 Qilimanjaro Quantum Tech
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from __future__ import annotations

from .pauli_channel import PauliChannel
from .protocols import SupportsStaticKraus
from .utils import _check_probability




class BitFlip(PauliChannel, SupportsStaticKraus):
    """Single-qubit Pauli channel configured with a Z-axis error.

    Applies a Z error with the given probability and the identity otherwise.
    """

    def __init__(self, *, probability: float) -> None:
        """
        Args:
            probability (float): Probability of applying the Pauli-Z error.

        Raises:
            ValueError: If probability is outside [0, 1].
        """
        self._probability = _check_probability(probability, "probability")
        super().__init__(pX=probability)

    @property


    def probability(self) -> float:
        """Return the probability of applying the Pauli-Z error.

        Returns:
            float: The error probability.
        """
        return self._probability