add instatiation example

unitaryfund · Oct 7, 2024 · 71a0a63 · 71a0a63
1 parent 8515dab
commit 71a0a63
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/mitiq/typing.py b/mitiq/typing.py
@@ -112,6 +112,11 @@ class MeasurementResult:
             ``tuple(range(self.nqubits))``, where ``self.nqubits``
             is the bitstring length deduced from ``result``.
 
+    Example:
+        >>> mr = MeasurementResult(["001", "010", "001"])
+        >>> mr.get_counts()
+        {'001': 2, '010': 1}
+
     Note:
         Use caution when selecting the default option for ``qubit_indices``,
         especially when estimating an :class:`.Observable`