add partial trace to docs

dev-ket · Jun 7, 2024 · f088294 · f088294
1 parent 8890926
commit f088294
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 3 deletions.
diff --git a/docs/src/api.md b/docs/src/api.md
@@ -10,6 +10,7 @@ shift
 clock
 gell_mann
 gell_mann!
+partial_trace
 cleanup!
 ```
 
@@ -76,4 +77,6 @@ anti_isotropic
 ```@docs
 Ket._partition
 Ket._fiducial_WH
+Ket._idx
+Ket._tidx
 ```
diff --git a/src/partial_tra.jl b/src/partial_tra.jl
@@ -39,8 +39,7 @@ function _idx(tidx::Vector{<:Integer}, dims::Vector{<:Integer})
 end
 
 """
-    partial_trace(X::AbstractMatrix, remove::AbstractVector, dims::
-AbstractVector)
+    partial_trace(X::AbstractMatrix, remove::Vector, dims::Vector)
 
 Takes the partial trace of matrix `X` with subsystem dimensions `dims` over the subsystems in `remove`.
 """
@@ -93,5 +92,10 @@ function partial_trace(X::AbstractMatrix{T}, remove::Vector{<:Integer}, dims::Ve
     end
     return Y
 end
-partial_trace(X::AbstractMatrix, sys::Integer, dims::Vector{<:Integer}) = partial_trace(X, [sys], dims)
+"""
+    partial_trace(X::AbstractMatrix, remove::Integer, dims::Vector)
+
+Takes the partial trace of matrix `X` with subsystem dimensions `dims` over the subsystem `remove`.
+"""
+partial_trace(X::AbstractMatrix, remove::Integer, dims::Vector{<:Integer}) = partial_trace(X, [remove], dims)
 export partial_trace