[ITensorMPS] Rename randomMPS to random_mps (#1446)

NDTensors/test/ITensors/TestITensorDMRG/dmrg.jl

@@ -1,4 +1,4 @@
-using ITensors: MPO, OpSum, dmrg, randomMPS, siteinds
+using ITensors: MPO, OpSum, dmrg, random_mps, siteinds
 using Random: Random
 using Test: @test
 include("../../NDTensorsTestUtils/NDTensorsTestUtils.jl")
@@ -19,7 +19,7 @@ function test_dmrg(
 
   Random.seed!(1234)
   init = j -> isodd(j) ? "↑" : "↓"
-  psi0 = dev(randomMPS(elt, sites, init; linkdims=4))
+  psi0 = dev(random_mps(elt, sites, init; linkdims=4))
   H = dev(MPO(elt, os, sites))
 
   nsweeps = 3

docs/src/MPSandMPO.md

@@ -12,9 +12,9 @@ MPO
 ```@docs
 MPS(::Int)
 MPS(::Type{<:Number}, ::Vector{<:Index})
-randomMPS(sites::Vector{<:Index})
-randomMPS(::Type{<:Number}, sites::Vector{<:Index})
-randomMPS(::Vector{<:Index}, ::Any)
+random_mps(sites::Vector{<:Index})
+random_mps(::Type{<:Number}, sites::Vector{<:Index})
+random_mps(::Vector{<:Index}, ::Any)
 MPS(::Vector{<:Index}, ::Any)
 MPS(::Type{<:Number}, ::Vector{<:Index}, ::Any)
 MPS(::Vector{<:Pair{<:Index}})

docs/src/Observer.md

@@ -184,7 +184,7 @@ let
     a += 0.5,"S-",n,"S+",n+1
   end
   H = MPO(a,s)
-  psi0 = randomMPS(s;linkdims=4)
+  psi0 = random_mps(s;linkdims=4)
 
   nsweeps = 5
   cutoff = 1E-8

docs/src/examples/DMRG.md

@@ -47,7 +47,7 @@ The random starting wavefunction `psi0` must be defined in the same Hilbert spac
 as the Hamiltonian, so we construct it using the same collection of site indices:
 
 ```julia
-psi0 = randomMPS(sites;linkdims=2)
+psi0 = random_mps(sites;linkdims=2)
 ```
 
 Here we have made a random MPS of bond dimension 2. We could have used a random product
@@ -85,7 +85,7 @@ let
   maxdim = [10,20,100,100,200] # gradually increase states kept
   cutoff = [1E-10] # desired truncation error
 
-  psi0 = randomMPS(sites;linkdims=2)
+  psi0 = random_mps(sites;linkdims=2)
 
   energy,psi = dmrg(H,psi0;nsweeps,maxdim,cutoff)
 
@@ -158,7 +158,7 @@ let
   maxdim = [10,10,20,40,80,100,140,180,200]
   cutoff = [1E-8]
 
-  psi0 = randomMPS(sites;linkdims=4)
+  psi0 = random_mps(sites;linkdims=4)
 
   energy,psi = dmrg(H,psi0;nsweeps,maxdim,cutoff)
 
@@ -238,7 +238,7 @@ let
   # Initialize wavefunction to a random MPS
   # of bond-dimension 10 with same quantum
   # numbers as `state`
-  psi0 = randomMPS(sites,state;linkdims=20)
+  psi0 = random_mps(sites,state;linkdims=20)
 
   nsweeps = 10
   maxdim = [20,60,100,100,200,400,800]
@@ -328,15 +328,15 @@ let
   #
   # Compute the ground state psi0
   #
-  psi0_init = randomMPS(sites;linkdims=2)
+  psi0_init = random_mps(sites;linkdims=2)
   energy0,psi0 = dmrg(H,psi0_init;nsweeps,maxdim,cutoff,noise)
 
   println()
 
   #
   # Compute the first excited state psi1
   #
-  psi1_init = randomMPS(sites;linkdims=2)
+  psi1_init = random_mps(sites;linkdims=2)
   energy1,psi1 = dmrg(H,[psi0],psi1_init;nsweeps,maxdim,cutoff,noise,weight)
 
   # Check psi1 is orthogonal to psi0
@@ -357,7 +357,7 @@ let
   #
   # Compute the second excited state psi2
   #
-  psi2_init = randomMPS(sites;linkdims=2)
+  psi2_init = random_mps(sites;linkdims=2)
   energy2,psi2 = dmrg(H,[psi0,psi1],psi2_init;nsweeps,maxdim,cutoff,noise,weight)
 
   # Check psi2 is orthogonal to psi0 and psi1
@@ -429,7 +429,7 @@ let
     a += 0.5,"S-",n,"S+",n+1
   end
   H = MPO(a,s)
-  psi0 = randomMPS(s;linkdims=4)
+  psi0 = random_mps(s;linkdims=4)
 
   nsweeps = 5
   maxdim = [10,20,80,160]
@@ -523,7 +523,7 @@ let
     a += 0.5,"S-",n,"S+",n+1
   end
   H = MPO(a,s)
-  psi0 = randomMPS(s;linkdims=4)
+  psi0 = random_mps(s;linkdims=4)
 
   nsweeps = 5
   maxdim = [10,20,80,160]

docs/src/examples/MPSandMPO.md

@@ -88,7 +88,7 @@ let # hide
 N = 10
 s = siteinds(2,N)
 chi = 4
-psi = randomMPS(s;linkdims=chi)
+psi = random_mps(s;linkdims=chi)
 
 # Make an array of integers of the element we
 # want to obtain
@@ -143,7 +143,7 @@ using ITensors, ITensorMPS
 N = 10
 chi = 4
 sites = siteinds("S=1/2",N)
-psi = randomMPS(sites;linkdims=chi)
+psi = random_mps(sites;linkdims=chi)
 magz = expect(psi,"Sz")
 for (j,mz) in enumerate(magz)
     println("$j $mz")
@@ -362,7 +362,7 @@ N = 10 # number of sites
 d = 3  # dimension of each site
 chi = 16 # bond dimension of the MPS
 s = siteinds(d,N)
-psi = randomMPS(s;linkdims=chi)
+psi = random_mps(s;linkdims=chi)
 ```
 
 We can now draw some samples from this MPS as

docs/src/faq/DMRG.md

@@ -91,7 +91,7 @@ When DMRG is failing to converge, here are some of the steps you can take to imp
   up on the left-hand side only, it can take DMRG a very long time to converge.
 
 * Try using a random MPS with a modestly large bond dimension. ITensor offers a function
-  called [`randomMPS`](@ref) which can be used to make random MPS in both the quantum number (QN)
+  called [`random_mps`](@ref) which can be used to make random MPS in both the quantum number (QN)
   conserving and non-QN conserving cases. Because random MPS have properties
   which are "typical" of most ground states, they can be good initial states for DMRG.
 

docs/src/index.md

@@ -294,7 +294,7 @@ let
   H = MPO(os,sites)
 
   # Create an initial random matrix product state
-  psi0 = randomMPS(sites)
+  psi0 = random_mps(sites)
 
   # Plan to do 5 passes or 'sweeps' of DMRG,
   # setting maximum MPS internal dimensions

docs/src/tutorials/DMRG.md

@@ -38,7 +38,7 @@ let
   end
   H = MPO(os,sites)
 
-  psi0 = randomMPS(sites;linkdims=10)
+  psi0 = random_mps(sites;linkdims=10)
 
   nsweeps = 5
   maxdim = [10,20,100,100,200]
@@ -92,7 +92,7 @@ physical indices given by the array `sites`.
 The line
 
 ```julia
-psi0 = randomMPS(sites;linkdims=10)
+psi0 = random_mps(sites;linkdims=10)
 ```
 
 constructs an MPS `psi0` which has the physical indices `sites` and a bond dimension of 10.

docs/src/tutorials/QN_DMRG.md

@@ -81,7 +81,7 @@ To make change (2), instead of constructing the initial MPS `psi0` to be an arbi
 So we will replace the line
 
 ```julia
-psi0 = randomMPS(sites;linkdims=10)
+psi0 = random_mps(sites;linkdims=10)
 ```
 
 by the lines

ext/ITensorsPackageCompilerExt/precompile_itensors.jl

@@ -1,4 +1,4 @@
-using ITensors.ITensorMPS: MPO, OpSum, dmrg, randomMPS, siteinds
+using ITensors.ITensorMPS: MPO, OpSum, dmrg, random_mps, siteinds
 
 # TODO: This uses all of the tests to make
 # precompile statements, but takes a long time
@@ -19,7 +19,7 @@ function main(; N, dmrg_kwargs)
   for conserve_qns in (false, true)
     sites = siteinds("S=1", N; conserve_qns)
     H = MPO(opsum, sites)
-    ψ0 = randomMPS(sites, j -> isodd(j) ? "↑" : "↓"; linkdims=2)
+    ψ0 = random_mps(sites, j -> isodd(j) ? "↑" : "↓"; linkdims=2)
     dmrg(H, ψ0; outputlevel=0, dmrg_kwargs...)
   end
   return nothing

src/lib/ITensorMPS/examples/autodiff/mps_autodiff.jl

@@ -31,7 +31,7 @@ h = 0.5
 
 # Loss function only works with `Vector{ITensor}`,
 # extract with `ITensors.data`.
-ψ0 = ITensors.data(randomMPS(s; linkdims=10))
+ψ0 = ITensors.data(random_mps(s; linkdims=10))
 H = ITensors.data(MPO(ising(n; J, h), s))
 
 loss(ψ) = loss(H, ψ)

src/lib/ITensorMPS/examples/dmrg/1d_heisenberg.jl

@@ -23,7 +23,7 @@ let
   H = MPO(os, sites)
 
   # Create an initial random matrix product state
-  psi0 = randomMPS(sites; linkdims=10)
+  psi0 = random_mps(sites; linkdims=10)
 
   # Plan to do 5 DMRG sweeps:
   nsweeps = 5

src/lib/ITensorMPS/examples/dmrg/1d_heisenberg_conserve_spin.jl

@@ -24,7 +24,7 @@ let
   H = MPO(os, sites)
 
   state = [isodd(n) ? "Up" : "Dn" for n in 1:N]
-  psi0 = randomMPS(sites, state; linkdims=10)
+  psi0 = random_mps(sites, state; linkdims=10)
 
   # Plan to do 5 DMRG sweeps:
   nsweeps = 5

src/lib/ITensorMPS/examples/dmrg/1d_hubbard_extended.jl

@@ -54,7 +54,7 @@ let
   # Initialize wavefunction to be bond
   # dimension 10 random MPS with number
   # of particles the same as `state`
-  psi0 = randomMPS(sites, state; linkdims=10)
+  psi0 = random_mps(sites, state; linkdims=10)
 
   # Check total number of particles:
   @show flux(psi0)

src/lib/ITensorMPS/examples/dmrg/1d_ising_with_observer.jl

@@ -23,7 +23,7 @@ end
 let
   N = 100
   sites = siteinds("S=1/2", N)
-  psi0 = randomMPS(sites; linkdims=10)
+  psi0 = random_mps(sites; linkdims=10)
 
   # define parameters for DMRG sweeps
   nsweeps = 15

src/lib/ITensorMPS/examples/dmrg/2d_heisenberg_conserve_spin.jl

@@ -22,7 +22,7 @@ let
   # Initialize wavefunction to a random MPS
   # of bond-dimension 10 with same quantum
   # numbers as `state`
-  psi0 = randomMPS(sites, state; linkdims=20)
+  psi0 = random_mps(sites, state; linkdims=20)
 
   nsweeps = 10
   maxdim = [20, 60, 100, 100, 200, 400, 800]

src/lib/ITensorMPS/examples/dmrg/2d_hubbard_conserve_momentum.jl

@@ -79,7 +79,7 @@ function main(;
   display(state)
 
   psi0 = if random_init
-    randomMPS(itensor_rng, sites, state; linkdims=2)
+    random_mps(itensor_rng, sites, state; linkdims=2)
   else
     MPS(sites, state)
   end

src/lib/ITensorMPS/examples/dmrg/2d_hubbard_conserve_particles.jl

@@ -30,7 +30,7 @@ function main(; Nx=6, Ny=3, U=4.0, t=1.0)
   # Initialize wavefunction to a random MPS
   # of bond-dimension 10 with same quantum
   # numbers as `state`
-  psi0 = randomMPS(sites, state)
+  psi0 = random_mps(sites, state)
 
   energy, psi = dmrg(H, psi0; nsweeps, maxdim, cutoff, noise)
   @show t, U

src/lib/ITensorMPS/examples/dmrg/threaded_blocksparse/2d_hubbard_conserve_momentum.jl

@@ -58,7 +58,7 @@ function main(;
   end
   display(state)
 
-  psi0 = randomMPS(sites, state; linkdims=10)
+  psi0 = random_mps(sites, state; linkdims=10)
 
   energy, psi = @time dmrg(H, psi0; nsweeps, maxdim, cutoff, noise, outputlevel)
 

src/lib/ITensorMPS/examples/dmrg/write_to_disk/1d_heisenberg.jl

@@ -21,7 +21,7 @@ let
   H = MPO(os, sites)
 
   state = [isodd(n) ? "Up" : "Dn" for n in 1:N]
-  psi0 = randomMPS(sites, state; linkdims=10)
+  psi0 = random_mps(sites, state; linkdims=10)
 
   # Plan to do 5 DMRG sweeps:
   nsweeps = 5

src/lib/ITensorMPS/examples/exact_diagonalization/exact_diagonalization.jl

@@ -30,7 +30,7 @@ function main(n; blas_num_threads=Sys.CPU_THREADS, fuse=true, binary=true)
   s = siteinds("S=1/2", n; conserve_qns=true)
   H = MPO(heisenberg(n), s)
   initstate(j) = isodd(j) ? "↑" : "↓"
-  ψ0 = randomMPS(s, initstate; linkdims=10)
+  ψ0 = random_mps(s, initstate; linkdims=10)
 
   edmrg, ψdmrg = dmrg(H, ψ0; nsweeps=10, cutoff=1e-6)
 

src/lib/ITensorMPS/examples/finite_temperature/metts.jl

@@ -51,7 +51,7 @@ function main(; N=10, cutoff=1E-8, δτ=0.1, beta=2.0, NMETTS=3000, Nwarm=10)
   Ry_gates = ops([("Ry", n, (θ=π / 2,)) for n in 1:N], s)
 
   # Arbitrary initial state
-  psi = randomMPS(s)
+  psi = random_mps(s)
 
   # Make H for measuring the energy
   terms = OpSum()

src/lib/ITensorMPS/examples/mps_mpo_algebra/mps_density_matrix.jl

@@ -4,7 +4,7 @@ N = 4
 nmps = 3
 cutoff = 1e-8
 s = siteinds("S=1/2", N)
-ψs = [randomMPS(s; linkdims=2) for _ in 1:nmps]
+ψs = [random_mps(s; linkdims=2) for _ in 1:nmps]
 ρs = [outer(ψ, ψ; cutoff) for ψ in ψs]
 ρ = sum(ρs; cutoff)