Skip to content
This repository has been archived by the owner on Dec 18, 2021. It is now read-only.

Commit

Permalink
remove YaoBlocks from docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
GiggleLiu committed Aug 27, 2019
1 parent 551a458 commit 79e2bb8
Show file tree
Hide file tree
Showing 7 changed files with 30 additions and 30 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@ docs/build/
docs/site/
docs/src/examples/*.md
*.swp
docs/Manifest.toml
2 changes: 1 addition & 1 deletion Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ TupleTools = "9d95972d-f1c8-5527-a6e0-b4b365fa01f6"
YaoBase = "a8f54c17-34bc-5a9d-b050-f522fe3f755f"

[compat]
BitBasis = "^0.5.0"
BitBasis = "^0.6.0"
LuxurySparse = "~0.4.0"
YaoBase = "~0.11.0"
julia = "^1.0.0"
Expand Down
1 change: 0 additions & 1 deletion docs/Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,3 @@ BitBasis = "50ba71b6-fa0f-514d-ae9a-0916efc90dcf"
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
YaoArrayRegister = "e600142f-9330-5003-8abb-0ebd767abc51"
YaoBase = "a8f54c17-34bc-5a9d-b050-f522fe3f755f"
YaoBlocks = "418bc28f-b43b-5e0b-a6e7-61bbc1a2c1df"
2 changes: 1 addition & 1 deletion docs/make.jl
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
using Documenter
using YaoArrayRegister, YaoBase, YaoBlocks
using YaoArrayRegister, YaoBase

makedocs(
modules = [YaoArrayRegister],
Expand Down
4 changes: 2 additions & 2 deletions docs/src/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
```@meta
DocTestSetup = quote
using YaoBase, YaoBlocks, YaoArrayRegister
using YaoBase, YaoArrayRegister
end
```
```
4 changes: 2 additions & 2 deletions src/focus.jl
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ new merged shape and order.
# Example
```jldoctest
julia> YaoArrayRegister.contiguous_shape_order((2, 3, 4), (1, 2, 3))
```jldoctest; setup=:(using YaoArrayRegister)
julia> YaoArrayRegister.contiguous_shape_orders((2, 3, 4), (1, 2, 3))
([24], [1])
```
"""
Expand Down
46 changes: 23 additions & 23 deletions src/register.jl
Original file line number Diff line number Diff line change
Expand Up @@ -105,13 +105,13 @@ For bit string literal please read [`@bit_str`](@ref).
# Examples
```jldoctest
```jldoctest; setup=:(using YaoArrayRegister)
julia> ArrayReg(bit"1010")
ArrayReg{1,Complex{Float64},Array...}
ArrayReg{1, Complex{Float64}, Array...}
active qubits: 4/4
julia> ArrayReg(ComplexF32, bit"1010")
ArrayReg{1,Complex{Float32},Array...}
ArrayReg{1, Complex{Float32}, Array...}
active qubits: 4/4
```
"""
Expand Down Expand Up @@ -289,13 +289,13 @@ defined with [`@bit_str`](@ref). See also [`zero_state`](@ref),
# Examples
```jldoctest
```jldoctest; setup=:(using YaoArrayRegister)
julia> product_state(bit"100"; nbatch=2)
ArrayReg{2,Complex{Float64},Array...}
ArrayReg{2, Complex{Float64}, Array...}
active qubits: 3/3
julia> product_state(ComplexF32, bit"101"; nbatch=2)
ArrayReg{2,Complex{Float32},Array...}
ArrayReg{2, Complex{Float32}, Array...}
active qubits: 3/3
```
"""
Expand All @@ -309,17 +309,17 @@ See also [`zero_state`](@ref), [`rand_state`](@ref), [`uniform_state`](@ref).
# Examples
```jldoctest
```jldoctest; setup=:(using YaoArrayRegister)
julia> product_state(4, 3; nbatch=2)
ArrayReg{2,Complex{Float64},Array...}
ArrayReg{2, Complex{Float64}, Array...}
active qubits: 4/4
julia> product_state(4, 0b1001; nbatch=2)
ArrayReg{2,Complex{Float64},Array...}
ArrayReg{2, Complex{Float64}, Array...}
active qubits: 4/4
julia> product_state(ComplexF32, 4, 0b101)
ArrayReg{1,Complex{Float32},Array...}
ArrayReg{1, Complex{Float32}, Array...}
active qubits: 4/4
```
Expand All @@ -344,17 +344,17 @@ See also [`product_state`](@ref), [`rand_state`](@ref), [`uniform_state`](@ref).
# Examples
```jldoctest
```jldoctest; setup=:(using YaoArrayRegister)
julia> zero_state(4)
ArrayReg{1,Complex{Float64},Array...}
ArrayReg{1, Complex{Float64}, Array...}
active qubits: 4/4
julia> zero_state(ComplexF32, 4)
ArrayReg{1,Complex{Float32},Array...}
ArrayReg{1, Complex{Float32}, Array...}
active qubits: 4/4
julia> zero_state(ComplexF32, 4; nbatch=3)
ArrayReg{3,Complex{Float32},Array...}
ArrayReg{3, Complex{Float32}, Array...}
active qubits: 4/4
```
"""
Expand All @@ -369,17 +369,17 @@ Create a random [`ArrayReg`](@ref) with total number of qubits `n`.
# Examples
```jldoctest
```jldoctest; setup=:(using YaoArrayRegister)
julia> rand_state(4)
ArrayReg{1,Complex{Float64},Array...}
ArrayReg{1, Complex{Float64}, Array...}
active qubits: 4/4
julia> rand_state(ComplexF64, 4)
ArrayReg{1,Complex{Float64},Array...}
ArrayReg{1, Complex{Float64}, Array...}
active qubits: 4/4
julia> rand_state(ComplexF64, 4; nbatch=2)
ArrayReg{2,Complex{Float64},Array...}
ArrayReg{2, Complex{Float64}, Array...}
active qubits: 4/4
```
"""
Expand All @@ -398,13 +398,13 @@ can also be created by applying [`H`](@ref) (Hadmard gate) on ``|00⋯00⟩`` st
# Example
```jldoctest
```jldoctest; setup=:(using YaoArrayRegister)
julia> uniform_state(4; nbatch=2)
ArrayReg{2,Complex{Float64},Array...}
ArrayReg{2, Complex{Float64}, Array...}
active qubits: 4/4
julia> uniform_state(ComplexF32, 4; nbatch=2)
ArrayReg{2,Complex{Float64},Array...}
ArrayReg{2, Complex{Float64}, Array...}
active qubits: 4/4
```
"""
Expand Down Expand Up @@ -433,9 +433,9 @@ batch dimension.
# Example
```jldoctest
```jldoctest; setup=:(using YaoArrayRegister)
julia> repeat(ArrayReg{3}(bit"101"), 4)
ArrayReg{12,Complex{Float64},Array...}
ArrayReg{12, Complex{Float64}, Array...}
active qubits: 3/3
```
"""
Expand Down

0 comments on commit 79e2bb8

Please sign in to comment.