Merge pull request #29 from ytdHuang/dev/eltype

support `Base.eltype` for `QuantumObject`
qutip · Mar 18, 2024 · c744b15 · c744b15
2 parents 09d2b0b + 8f4926c
commit c744b15
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/docs/src/api.md b/docs/src/api.md
@@ -19,6 +19,7 @@ isket
 isoper
 issuper
 size
+eltype
 length
 LinearAlgebra.tr
 LinearAlgebra.norm

diff --git a/src/quantum_object.jl b/src/quantum_object.jl
@@ -151,6 +151,13 @@ Base.size(A::QuantumObject{<:AbstractArray{T},OpType}, inds...) where {T,OpType<
 Base.getindex(A::QuantumObject{<:AbstractArray{T},OpType}, inds...) where {T,OpType<:QuantumObjectType} = getindex(A.data, inds...)
 Base.setindex!(A::QuantumObject{<:AbstractArray{T},OpType}, val, inds...) where {T,OpType<:QuantumObjectType} = setindex!(A.data, val, inds...)
 
+"""
+    eltype(A::QuantumObject)
+
+Returns the elements type of the matrix or vector corresponding to the [`QuantumObject`](@ref) `A`.
+"""
+Base.eltype(A::QuantumObject) = eltype(A.data)
+
 #    Broadcasting
 Base.broadcastable(x::QuantumObject) = x.data
 for op in (:(+), :(-), :(*), :(/), :(^))