Skip to content

Commit

Permalink
Deprecated num_to_latex_ket
Browse files Browse the repository at this point in the history
Replace "numbers_to_latex_terms" with "_numbers_to_latex_terms"
  • Loading branch information
Slope86 authored Apr 26, 2023
1 parent 8c47489 commit 10ee59d
Showing 1 changed file with 20 additions and 2 deletions.
22 changes: 20 additions & 2 deletions qiskit/visualization/state_visualization.py
Original file line number Diff line number Diff line change
Expand Up @@ -1341,6 +1341,24 @@ def numbers_to_latex_terms(numbers: List[complex], decimals: int = 10) -> List[s
return terms


def _numbers_to_latex_terms(numbers: List[complex], decimals: int = 10) -> List[str]:
"""Convert a list of numbers to latex formatted terms
The first non-zero term is treated differently. For this term a leading + is suppressed.
Args:
numbers: List of numbers to format
decimals: Number of decimal places to round to (default: 10).
Returns:
List of formatted terms
"""
first_term = True
terms = []
for number in numbers:
term = _num_to_latex(number, decimals=decimals, first_term=first_term, coefficient=True)
terms.append(term)
first_term = False
return terms


def _state_to_latex_ket(
data: List[complex], max_size: int = 12, prefix: str = "", decimals: int = 10
) -> str:
Expand All @@ -1367,10 +1385,10 @@ def ket_name(i):
nonzero_indices = (
nonzero_indices[: max_size // 2] + [0] + nonzero_indices[-max_size // 2 + 1 :]
)
latex_terms = numbers_to_latex_terms(data[nonzero_indices], decimals)
latex_terms = _numbers_to_latex_terms(data[nonzero_indices], decimals)
nonzero_indices[max_size // 2] = None
else:
latex_terms = numbers_to_latex_terms(data[nonzero_indices], decimals)
latex_terms = _numbers_to_latex_terms(data[nonzero_indices], decimals)

latex_str = ""
for idx, ket_idx in enumerate(nonzero_indices):
Expand Down

0 comments on commit 10ee59d

Please sign in to comment.