Skip to content

Commit 2f07e48

Browse files
committed
Fix doctest errors
1 parent c9bf435 commit 2f07e48

File tree

3 files changed

+15
-16
lines changed

3 files changed

+15
-16
lines changed

docs/src/AdvancedUsageGuide.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -756,8 +756,8 @@ Advanced users might notice something strange about the definition
756756
of the ITensor type, that it is often not "type stable". Some of
757757
this is by design. The definition for ITensor is:
758758
```julia
759-
mutable struct ITensor{N}
760-
inds::IndexSet{N}
759+
mutable struct ITensor
760+
inds::IndexSet
761761
store::TensorStorage
762762
end
763763
```
@@ -774,7 +774,7 @@ julia> A = randomITensor(i, i');
774774
julia> @code_warntype A[i=>1, i'=>2]
775775
Variables
776776
#self#::Core.Compiler.Const(getindex, false)
777-
T::ITensor{1}
777+
T::ITensor
778778
ivs::Tuple{Pair{Index{Int64},Int64}}
779779
p::Tuple{Union{Nothing, Int64}}
780780
vals::Tuple{Any}
@@ -789,7 +789,7 @@ Body::Number
789789
%7 = Base.broadcasted(ITensors.val, ivs)::Base.Broadcast.Broadcasted{Base.Broadcast.Style{Tuple},Nothing,typeof(val),Tuple{Tuple{Pair{Index{Int64},Int64}}}}
790790
%8 = Base.materialize(%7)::Tuple{Int64}
791791
│ (vals = (%6)(%8, p))
792-
%10 = Core.tuple(T)::Tuple{ITensor{1}}
792+
%10 = Core.tuple(T)::Tuple{ITensor}
793793
%11 = Core._apply_iterate(Base.iterate, Base.getindex, %10, vals)::Number
794794
%12 = Core.typeassert(%11, ITensors.Number)::Number
795795
└── return %12

docs/src/ITensorType.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,17 +53,17 @@ delta(::Type{<:Number}, ::QN, ::ITensors.Indices)
5353
## Convert to Array
5454

5555
```@docs
56-
Array{ElT, N}(::ITensor{N}, ::Vararg{Index, N}) where {ElT, N}
56+
Array{ElT, N}(::ITensor, ::Vararg{Index, N}) where {ElT, N}
5757
array(::ITensor)
58-
matrix(::ITensor{2})
59-
vector(::ITensor{1})
58+
matrix(::ITensor)
59+
vector(::ITensor)
6060
```
6161

6262
## Getting and setting elements
6363

6464
```@docs
6565
getindex(::ITensor, ::Any...)
66-
getindex(::ITensor{N}, ::Vararg{Int,N}) where {N}
66+
getindex(::ITensor, ::Vararg{Int,N}) where {N}
6767
setindex!(::ITensor, ::Number, ::Any...)
6868
setindex!(::ITensor, ::Number, ::Int...)
6969
```

docs/src/index.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -299,7 +299,7 @@ It originates in physics with the purpose of finding
299299
eigenvectors of Hamiltonian (energy) matrices which model
300300
the behavior of quantum systems.
301301

302-
```jldoctest; output=false, filter=[r"After sweep [1-5] energy=\-[0-9]{3}\.[0-9]{10,16} maxlinkdim=[0-9]{1,3} time=[0-9]{1,2}\.[0-9]{3}", r"Final energy = \-138\.[0-9]{10,16}"]
302+
```jldoctest; output=false, filter=[r"After sweep [1-5] energy=\-[0-9]{3}\.[0-9]{10,16} maxlinkdim=[0-9]{1,3} maxerr=[0-9]{1,2}\.[0-9]{1,3}E\-[0-9]{1,2} time=[0-9]{1,2}\.[0-9]{3}", r"Final energy = \-138\.[0-9]{10,16}"]
303303
using ITensors
304304
let
305305
# Create 100 spin-one indices
@@ -347,11 +347,10 @@ sweeps = Sweeps
347347
4 cutoff=1.0E-10, maxdim=100, mindim=1, noise=0.0E+00
348348
5 cutoff=1.0E-10, maxdim=200, mindim=1, noise=0.0E+00
349349
350-
After sweep 1 energy=-137.845841178879 maxlinkdim=9 time=8.538
351-
After sweep 2 energy=-138.935378608196 maxlinkdim=20 time=0.316
352-
After sweep 3 energy=-138.940079710492 maxlinkdim=88 time=1.904
353-
After sweep 4 energy=-138.940086018149 maxlinkdim=100 time=4.179
354-
After sweep 5 energy=-138.940086075413 maxlinkdim=96 time=4.184
355-
Final energy = -138.94008607296038
350+
After sweep 1 energy=-137.954199761732 maxlinkdim=9 maxerr=2.43E-16 time=9.356
351+
After sweep 2 energy=-138.935058943878 maxlinkdim=20 maxerr=4.97E-06 time=0.671
352+
After sweep 3 energy=-138.940080155429 maxlinkdim=92 maxerr=1.00E-10 time=4.522
353+
After sweep 4 energy=-138.940086009318 maxlinkdim=100 maxerr=1.05E-10 time=11.644
354+
After sweep 5 energy=-138.940086058840 maxlinkdim=96 maxerr=1.00E-10 time=12.771
355+
Final energy = -138.94008605883985
356356
```
357-

0 commit comments

Comments
 (0)