# Copyright 2024 Moth Quantum
#
# 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 abc import ABC, abstractmethod
import numpy as np
import qiskit
[docs]
class Scheme(ABC):
"""
Abstract base class for Quantum Audio Schemes.
This class defines the bare minimum interface that any specific modulation
scheme must follow. Subclasses should provide implementations
of the `encode` and `decode` methods according to the specifics of their
modulation schemes.
"""
[docs]
@abstractmethod
def encode(self, data: np.ndarray) -> qiskit.QuantumCircuit:
"""Encode the input data using the scheme.
Args:
data: A `numpy` array containing the data to be encoded.
Returns:
A `qiskit.QuantumCircuit` representing the encoded data.
"""
pass
[docs]
@abstractmethod
def decode(self, circuit: qiskit.QuantumCircuit) -> np.ndarray:
"""Decode the quantum circuit using the scheme.
Args:
circuit: A `qiskit.QuantumCircuit` that contains the encoded data.
Returns:
A `numpy` array containing the decoded data.
"""
pass
def __str__(self) -> str:
"""Return a string representation of the modulation scheme."""
return f"{self.name} ({self.__class__.__name__})"