modify the format of the file

Author: AnshMNSoni

quantum/grover_search_algorithm.py

@@ -1,34 +1,65 @@
+"""
+Grover's Search Algorithm implementation using Qiskit.
+
+Grover's algorithm is a quantum algorithm for searching an unsorted database
+with quadratic speedup over classical algorithms.
+
+Wikipedia:
+https://en.wikipedia.org/wiki/Grover%27s_algorithm
+"""
+
+from typing import Dict
 from qiskit import QuantumCircuit, transpile
 from qiskit_aer import AerSimulator
 
-# Number of qubits
-n = 2
 
-# Create Quantum Circuit
-qc = QuantumCircuit(n, n)
+def grover_search(shots: int = 1024) -> Dict[str, int]:
+    """
+    Runs Grover's search algorithm for 2 qubits and returns measurement results.
+
+    The oracle marks the |11> state.
+
+    Args:
+        shots (int): Number of simulation shots.
+
+    Returns:
+        Dict[str, int]: Measurement counts.
+
+    Example:
+    >>> result = grover_search(100)
+    >>> isinstance(result, dict)
+    True
+    """
+
+    n = 2
+    qc = QuantumCircuit(n, n)
+
+    # Initialize superposition
+    qc.h(range(n))
+
+    # Oracle marking |11>
+    qc.cz(0, 1)
 
-# Step 1: Initialize in superposition
-qc.h(range(n))
+    # Diffuser
+    qc.h(range(n))
+    qc.x(range(n))
+    qc.h(1)
+    qc.cx(0, 1)
+    qc.h(1)
+    qc.x(range(n))
+    qc.h(range(n))
 
-# -------- ORACLE (marks |11>) --------
-qc.cz(0, 1)
+    # Measurement
+    qc.measure(range(n), range(n))
 
-# -------- DIFFUSER --------
-qc.h(range(n))
-qc.x(range(n))
-qc.h(1)
-qc.cx(0, 1)
-qc.h(1)
-qc.x(range(n))
-qc.h(range(n))
+    # Run on simulator
+    backend = AerSimulator()
+    compiled = transpile(qc, backend)
+    result = backend.run(compiled, shots=shots).result()
+    counts = result.get_counts()
 
-# Measure
-qc.measure(range(n), range(n))
+    return counts
 
-# Run on simulator
-backend = AerSimulator()
-compiled_circuit = transpile(qc, backend)
-result = backend.run(compiled_circuit, shots=1024).result()
-counts = result.get_counts()
 
-print("Measurement Result:", counts)
+if __name__ == "__main__":
+    print(grover_search())