cirq.Circuit.to_text_diagram_drawer

Circuit.to_text_diagram_drawer(*, use_unicode_characters: bool = True, qubit_namer: Optional[Callable[cirq.ops.raw_types.Qid, str]] = None, transpose: bool = False, precision: Optional[int] = 3, qubit_order: Union[cirq.ops.qubit_order.QubitOrder, Iterable[cirq.ops.raw_types.Qid]] = <cirq.ops.qubit_order.QubitOrder object>, get_circuit_diagram_info: Optional[Callable[[cirq.ops.raw_types.Operation, cirq.protocols.circuit_diagram_info.CircuitDiagramInfoArgs], cirq.protocols.circuit_diagram_info.CircuitDiagramInfo]] = None) → cirq.circuits.text_diagram_drawer.TextDiagramDrawer[source]

Returns a TextDiagramDrawer with the circuit drawn into it.

Parameters:
  • use_unicode_characters – Determines if unicode characters are allowed (as opposed to ascii-only diagrams).
  • qubit_namer – Names qubits in diagram. Defaults to str.
  • transpose – Arranges qubit wires vertically instead of horizontally.
  • precision – Number of digits to use when representing numbers.
  • qubit_order – Determines how qubits are ordered in the diagram.
  • get_circuit_diagram_info – Gets circuit diagram info. Defaults to protocol with fallback.
Returns:

The TextDiagramDrawer instance.