fix typo in docstrings

Author: ytdHuang

docs/src/users_guide/plotting_the_bloch_sphere.md

@@ -174,7 +174,7 @@ At the end of the last section we saw that the colors and marker shapes of the d
 |:----------|:----------------|:--------------------|
 | `b.points` | Points to plot on the Bloch sphere (3D coordinates) | `Vector{Matrix{Float64}}()` (empty) |
 | `b.vectors` | Vectors to plot on the Bloch sphere | `Vector{Vector{Float64}}()` (empty) |
-| `b.lines` | Lines to draw on the sphere (points, style, properties) | `Vector{Tuple{Vector{Vector{Float64}},String}}()` (empty) |
+| `b.lines` | Lines to draw on the sphere with each line given as `([start_pt, end_pt], line_format)` | `Vector{Tuple{Vector{Vector{Float64}},String}}()` (empty) |
 | `b.arcs` | Arcs to draw on the sphere | `Vector{Vector{Vector{Float64}}}()` (empty) |
 
 ### Properties
@@ -195,7 +195,7 @@ At the end of the last section we saw that the colors and marker shapes of the d
 | `b.sphere_alpha` | Transparency of sphere surface | `"#FFDDDD"` |
 | `b.vector_color` | Colors for vectors | `["green", "#CC6600", "blue", "red"]` |
 | `b.vector_width` | Width of vectors | `0.025` |
-| `b.vector_arrowsize` | Arrow size parameters as (head length, head width, stem width) | `[0.07, 0.08, 0.08]` |
+| `b.vector_arrowsize` | Arrow size parameters as `[head_length, head_width, stem_width]` | `[0.07, 0.08, 0.08]` |
 | `b.view` | Azimuthal and elevation viewing angles in degrees | `[30, 30]` |
 | `b.xlabel` | Labels for x-axis | `[L"x", ""]` (``+x`` and ``-x``) |
 | `b.xlpos` | Positions of x-axis labels | `[1.2, -1.2]` |

ext/QuantumToolboxMakieExt.jl

@@ -349,10 +349,10 @@ function QuantumToolbox.render(b::Bloch; location = nothing)
     _add_labels!(b, lscene)
 
     # plot data fields in Bloch
-    _plot_points!(b, lscene)
+    _plot_vectors!(b, lscene)
     _plot_lines!(b, lscene)
     _plot_arcs!(b, lscene)
-    _plot_vectors!(b, lscene)
+    _plot_points!(b, lscene) # plot points at the end so that they will be on the very top (front) figure layer.
 
     return fig, lscene
 end
@@ -523,6 +523,7 @@ Plot all quantum state points on the Bloch sphere.
 Handles both scatter points and line traces based on style specifications.
 """
 function _plot_points!(b::Bloch, lscene)
+    isempty(b.points) && return nothing
     for k in 1:length(b.points)
         pts = b.points[k]
         style = b.point_style[k]
@@ -596,6 +597,7 @@ Draw all connecting lines between points on the Bloch sphere.
 Processes line style specifications and color mappings.
 """
 function _plot_lines!(b::Bloch, lscene)
+    isempty(b.lines) && return nothing
     color_map =
         Dict("k" => :black, "r" => :red, "g" => :green, "b" => :blue, "c" => :cyan, "m" => :magenta, "y" => :yellow)
     for (line, fmt) in b.lines
@@ -628,6 +630,7 @@ Draw circular arcs connecting points on the Bloch sphere surface.
 Calculates great circle arcs between specified points.
 """
 function _plot_arcs!(b::Bloch, lscene)
+    isempty(b.arcs) && return nothing
     for arc_pts in b.arcs
         length(arc_pts) >= 2 || continue
         v1 = normalize(arc_pts[1])
@@ -657,22 +660,17 @@ Draw vectors from origin representing quantum states.
 Scales vectors appropriately and adds `3D` arrow markers.
 """
 function _plot_vectors!(b::Bloch, lscene)
-    isempty(b.vectors) && return
-    arrowsize_vec = Vec3f(b.vector_arrowsize...)
-    r = 1.0
+    isempty(b.vectors) && return nothing
     for (i, v) in enumerate(b.vectors)
         color = get(b.vector_color, i, RGBAf(0.2, 0.5, 0.8, 0.9))
-        vec = Vec3f(v...)
-        length = norm(vec)
-        max_length = r * 0.90
-        vec = length > max_length ? (vec/length) * max_length : vec
+        vec = 0.92 * Vec3f(v...) # multiply by 0.92 so that the point edge of the arrow represents the actual position
         arrows!(
             lscene,
             [Point3f(0, 0, 0)],
             [vec],
             color = color,
             linewidth = b.vector_width,
-            arrowsize = arrowsize_vec,
+            arrowsize = Vec3f(b.vector_arrowsize...),
             arrowcolor = color,
             rasterize = 3,
         )

src/visualization.jl

@@ -74,7 +74,7 @@ A structure representing a Bloch sphere visualization for quantum states. Availa
 ## Data storage
 - `points::Vector{Matrix{Float64}}`: Points to plot on the Bloch sphere (3D coordinates)
 - `vectors::Vector{Vector{Float64}}}`: Vectors to plot on the Bloch sphere
-- `lines::Vector{Tuple{Vector{Vector{Float64}},String,Dict{Any,Any}}}`: Lines to draw on the sphere (points, style, properties)
+- `lines::Vector{Tuple{Vector{Vector{Float64}},String}}`: Lines to draw on the sphere with each line given as `([start_pt, end_pt], line_format)`
 - `arcs::Vector{Vector{Vector{Float64}}}}`: Arcs to draw on the sphere
 
 ## Style properties
@@ -100,9 +100,9 @@ A structure representing a Bloch sphere visualization for quantum states. Availa
 
 ## Vector properties
 
-- `vector_color`::Vector{String}: Colors for vectors
-- `vector_width`::Float64: Width of vectors
-- `vector_arrowsize`::Vector{Float64}: Arrow size parameters as [head length, head width, stem width]
+- `vector_color::Vector{String}`: Colors for vectors
+- `vector_width::Float64`: Width of vectors
+- `vector_arrowsize::Vector{Float64}`: Arrow size parameters as `[head_length, head_width, stem_width]`
 
 ## Layout properties
 
@@ -203,29 +203,29 @@ Add a single point to the Bloch sphere visualization.
 
 # Arguments
 - `b::Bloch`: The Bloch sphere object to modify
-- `pnt::Vector{Float64}`: A 3D point to add
+- `pnt::Vector{<:Real}`: A 3D point to add
 - `meth::Symbol=:s`: Display method (`:s` for single point, `:m` for multiple, `:l` for line)
 - `color`: Color of the point (defaults to first default color if nothing)
 - `alpha=1.0`: Transparency (`1.0` means opaque and `0.0` means transparent)
 """
-function add_points!(b::Bloch, pnt::Vector{Float64}; meth::Symbol = :s, color = nothing, alpha = 1.0)
+function add_points!(b::Bloch, pnt::Vector{<:Real}; meth::Symbol = :s, color = nothing, alpha = 1.0)
     return add_points!(b, reshape(pnt, 3, 1); meth, color, alpha)
 end
-function add_points!(b::Bloch, pnts::Vector{Vector{Float64}}; meth::Symbol = :s, color = nothing, alpha = 1.0)
+function add_points!(b::Bloch, pnts::Vector{Vector{<:Real}}; meth::Symbol = :s, color = nothing, alpha = 1.0)
     return add_points!(b, Matrix(hcat(pnts...)'); meth, color, alpha)
 end
 
 @doc raw"""
-    add_points!(b::Bloch, pnts::Matrix{Float64}; meth::Symbol = :s, color = nothing, alpha = 1.0)
+    add_points!(b::Bloch, pnts::Matrix{<:Real}; meth::Symbol = :s, color = nothing, alpha = 1.0)
 
 Add multiple points to the Bloch sphere visualization.
 
 # Arguments
 
 - `b::Bloch`: The Bloch sphere object to modify
-- `pnts::Matrix{Float64}`: `3×N` matrix of points (each column is a point)
+- `pnts::Matrix{<:Real}`: `3×N` matrix of points (each column is a point)
 - `meth::Symbol=:s`: Display method (`:s` for single point, `:m` for multiple, `:l` for line)
-- `color`: Color of the points (defaults to first default color if nothing)
+- `color`: Color of the points (defaults to first default color if `nothing`)
 - `alpha=1.0`: Transparency (`1.0` means opaque and `0.0` means transparent)
 ```
 """