Skip to content

Commit

Permalink
fix docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
ytdHuang committed Jun 4, 2024
1 parent 7e63fe5 commit 0825a97
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions src/qobj/states.jl
Original file line number Diff line number Diff line change
Expand Up @@ -26,14 +26,15 @@ end
basis(N::Int, pos::Int = 0; dims::Vector{Int}=[N])
Generates a fock state like [`fock`](@ref).
It is also possible to specify the list of dimensions `dims` if different subsystems are present.
"""
basis(N::Int, pos::Int = 0; dims::Vector{Int} = [N]) = fock(N, pos, dims = dims)

@doc raw"""
coherent(N::Real, α::Number)
Generates a coherent state ``\ket{\alpha}``, which is defined as an eigenvector of the
bosonic annihilation operator ``\hat{a} \ket{\alpha} = \alpha \ket{\alpha}``.
Generates a coherent state ``\ket{\alpha}``, which is defined as an eigenvector of the bosonic annihilation operator ``\hat{a} \ket{\alpha} = \alpha \ket{\alpha}``.
"""
function coherent(N::Real, α::T) where {T<:Number}
a = destroy(N)
Expand Down

0 comments on commit 0825a97

Please sign in to comment.