Rename IterativeEigenSolvers to IterativeEigensolvers (#25089)

JuliaLang · Dec 16, 2017 · e2bac90 · e2bac90 · nanosoldier · Dec 16, 2017
1 parent ff0e1f7
commit e2bac90
Show file tree

Hide file tree

Showing 12 changed files with 23 additions and 19 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -770,6 +770,9 @@ Deprecated or removed
     `isdigit`, `isxdigit`, `isnumber`, `isalnum`, `iscntrl`, `ispunct`, `isspace`,
     `isprint`, `isgraph`, `lowercase`, `uppercase`, `titlecase`, `lcfirst` and `ucfirst`.
 
+  * The functions `eigs` and `svds` have been moved to the `IterativeEigensolvers` standard
+    library module ([#24714]).
+
   * `isnumber` has been deprecated in favor of `isnumeric`, `is_assigned_char`
     in favor of `isassigned` and `normalize_string` in favor of `normalize`, all three
     in the new `Unicode` standard library module ([#25021]).
@@ -1760,5 +1763,6 @@ Command-line option changes
 [#24396]: https://github.com/JuliaLang/julia/issues/24396
 [#24413]: https://github.com/JuliaLang/julia/issues/24413
 [#24653]: https://github.com/JuliaLang/julia/issues/24653
+[#24714]: https://github.com/JuliaLang/julia/issues/24714
 [#24869]: https://github.com/JuliaLang/julia/issues/24869
 [#25021]: https://github.com/JuliaLang/julia/issues/25021
diff --git a/base/deprecated.jl b/base/deprecated.jl
@@ -1312,8 +1312,8 @@ export conv, conv2, deconv, filt, filt!, xcorr
 @eval @deprecate_moved $(Symbol("@dateformat_str")) "Dates" true true
 @deprecate_moved now "Dates" true true
 
-@deprecate_moved eigs "IterativeEigenSolvers" true true
-@deprecate_moved svds "IterativeEigenSolvers" true true
+@deprecate_moved eigs "IterativeEigensolvers" true true
+@deprecate_moved svds "IterativeEigensolvers" true true
 
 # PR #21709
 @deprecate cov(x::AbstractVector, corrected::Bool) cov(x, corrected=corrected)

diff --git a/base/sparse/linalg.jl b/base/sparse/linalg.jl
@@ -1011,7 +1011,7 @@ end
 
 chol(A::SparseMatrixCSC) = error("Use cholfact() instead of chol() for sparse matrices.")
 lu(A::SparseMatrixCSC) = error("Use lufact() instead of lu() for sparse matrices.")
-eig(A::SparseMatrixCSC) = error("Use IterativeEigenSolvers.eigs() instead of eig() for sparse matrices.")
+eig(A::SparseMatrixCSC) = error("Use IterativeEigensolvers.eigs() instead of eig() for sparse matrices.")
 
 function Base.cov(X::SparseMatrixCSC, vardim::Int=1; corrected::Bool=true)
     a, b = size(X)

diff --git a/base/sysimg.jl b/base/sysimg.jl
@@ -479,8 +479,8 @@ Base.require(:CRC32c)
 Base.require(:Dates)
 Base.require(:DelimitedFiles)
 Base.require(:FileWatching)
-Base.require(:IterativeEigenSolvers)
 Base.require(:Logging)
+Base.require(:IterativeEigensolvers)
 Base.require(:Mmap)
 Base.require(:Profile)
 Base.require(:SharedArrays)

diff --git a/doc/make.jl b/doc/make.jl
@@ -30,7 +30,7 @@ if Sys.iswindows()
     cp_q("../stdlib/FileWatching/docs/src/index.md",          "src/stdlib/filewatching.md")
     cp_q("../stdlib/CRC32c/docs/src/index.md",                "src/stdlib/crc32c.md")
     cp_q("../stdlib/Dates/docs/src/index.md",                 "src/stdlib/dates.md")
-    cp_q("../stdlib/IterativeEigenSolvers/docs/src/index.md", "src/stdlib/iterativeeigensolvers.md")
+    cp_q("../stdlib/IterativeEigensolvers/docs/src/index.md", "src/stdlib/iterativeeigensolvers.md")
     cp_q("../stdlib/Unicode/docs/src/index.md",               "src/stdlib/unicode.md")
     cp_q("../stdlib/Distributed/docs/src/index.md",           "src/stdlib/distributed.md")
 else
@@ -43,7 +43,7 @@ else
     symlink_q("../../../stdlib/FileWatching/docs/src/index.md",          "src/stdlib/filewatching.md")
     symlink_q("../../../stdlib/CRC32c/docs/src/index.md",                "src/stdlib/crc32c.md")
     symlink_q("../../../stdlib/Dates/docs/src/index.md",                 "src/stdlib/dates.md")
-    symlink_q("../../../stdlib/IterativeEigenSolvers/docs/src/index.md", "src/stdlib/iterativeeigensolvers.md")
+    symlink_q("../../../stdlib/IterativeEigensolvers/docs/src/index.md", "src/stdlib/iterativeeigensolvers.md")
     symlink_q("../../../stdlib/Unicode/docs/src/index.md",               "src/stdlib/unicode.md")
     symlink_q("../../../stdlib/Distributed/docs/src/index.md",           "src/stdlib/distributed.md")
 end
@@ -160,12 +160,12 @@ const PAGES = [
 ]
 
 using DelimitedFiles, Test, Mmap, SharedArrays, Profile, Base64, FileWatching, CRC32c,
-      Dates, IterativeEigenSolvers, Unicode, Distributed
+      Dates, IterativeEigensolvers, Unicode, Distributed
 
 makedocs(
     build     = joinpath(pwd(), "_build/html/en"),
     modules   = [Base, Core, BuildSysImg, DelimitedFiles, Test, Mmap, SharedArrays, Profile,
-                 Base64, FileWatching, Dates, IterativeEigenSolvers, Unicode, Distributed],
+                 Base64, FileWatching, Dates, IterativeEigensolvers, Unicode, Distributed],
     clean     = false,
     doctest   = "doctest" in ARGS,
     linkcheck = "linkcheck" in ARGS,

diff --git a/...b/IterativeEigenSolvers/docs/src/index.md → ...b/IterativeEigensolvers/docs/src/index.md b/...b/IterativeEigenSolvers/docs/src/index.md → ...b/IterativeEigensolvers/docs/src/index.md
@@ -50,7 +50,7 @@ the following keyword arguments are supported:
 
 We can see the various keywords in action in the following examples:
 ```jldoctest
-julia> using IterativeEigenSolvers
+julia> using IterativeEigensolvers
 
 julia> A = Diagonal(1:4);
 
@@ -165,7 +165,7 @@ final residual vector `resid`.
 
 We can see the various keywords in action in the following examples:
 ```jldoctest
-julia> using IterativeEigenSolvers
+julia> using IterativeEigensolvers
 
 julia> A = sparse(1.0I, 4, 4); B = Diagonal(1:4);
 
@@ -203,7 +203,7 @@ julia> λ
 
 
 ```@docs
-IterativeEigenSolvers.eigs(::Any)
-IterativeEigenSolvers.eigs(::Any, ::Any)
-IterativeEigenSolvers.svds
+IterativeEigensolvers.eigs(::Any)
+IterativeEigensolvers.eigs(::Any, ::Any)
+IterativeEigensolvers.svds
 ```
diff --git a/...EigenSolvers/src/IterativeEigenSolvers.jl → ...Eigensolvers/src/IterativeEigensolvers.jl b/...EigenSolvers/src/IterativeEigenSolvers.jl → ...Eigensolvers/src/IterativeEigensolvers.jl
@@ -5,7 +5,7 @@ __precompile__(true)
 """
 Arnoldi and Lanczos iteration for computing eigenvalues
 """
-module IterativeEigenSolvers
+module IterativeEigensolvers
 
 using Base.LinAlg: BlasFloat, BlasInt, SVD, checksquare, mul!, Adjoint, Transpose
 
@@ -29,7 +29,7 @@ final residual vector `resid`.
 
 # Examples
 ```jldoctest
-julia> using IterativeEigenSolvers
+julia> using IterativeEigensolvers
 
 julia> A = Diagonal(1:4);
 

diff --git a/stdlib/IterativeEigenSolvers/src/arpack.jl → stdlib/IterativeEigensolvers/src/arpack.jl b/stdlib/IterativeEigenSolvers/src/arpack.jl → stdlib/IterativeEigensolvers/src/arpack.jl
diff --git a/...b/IterativeEigenSolvers/src/deprecated.jl → ...b/IterativeEigensolvers/src/deprecated.jl b/...b/IterativeEigenSolvers/src/deprecated.jl → ...b/IterativeEigensolvers/src/deprecated.jl
@@ -1,6 +1,6 @@
 # This file is a part of Julia. License is MIT: https://julialang.org/license
 
-@eval IterativeEigenSolvers begin
+@eval IterativeEigensolvers begin
     Base.A_mul_B!(y::StridedVector{T}, A::AtA_or_AAt{T}, x::StridedVector{T}) where {T} = Base.LinAlg.mul!(y, A, x)
     Base.A_mul_B!(y::StridedVector{T}, A::SVDAugmented{T}, x::StridedVector{T}) where {T} = Base.LinAlg.mul!(y, A, x)
 end
diff --git a/...ib/IterativeEigenSolvers/test/runtests.jl → ...ib/IterativeEigensolvers/test/runtests.jl b/...ib/IterativeEigenSolvers/test/runtests.jl → ...ib/IterativeEigensolvers/test/runtests.jl
@@ -1,6 +1,6 @@
 # This file is a part of Julia. License is MIT: https://julialang.org/license
 
-using IterativeEigenSolvers
+using IterativeEigensolvers
 using Test
 
 @testset "eigs" begin

diff --git a/test/choosetests.jl b/test/choosetests.jl
@@ -177,7 +177,7 @@ function choosetests(choices = [])
     end
 
     # The shift and invert solvers need SuiteSparse for sparse input
-    Base.USE_GPL_LIBS || filter!(x->x != "IterativeEigenSolvers", STDLIBS)
+    Base.USE_GPL_LIBS || filter!(x->x != "IterativeEigensolvers", STDLIBS)
 
     filter!(x -> !(x in skip_tests), tests)
 

diff --git a/test/compile.jl b/test/compile.jl
@@ -219,7 +219,7 @@ try
                                # plus modules included in the system image
                                Dict(s => Base.module_uuid(Base.root_module(s)) for s in
                                     [:Base64, :CRC32c, :Dates, :DelimitedFiles, :FileWatching,
-                                     :IterativeEigenSolvers, :Logging, :Mmap, :Profile, :SharedArrays,
+                                     :IterativeEigensolvers, :Logging, :Mmap, :Profile, :SharedArrays,
                                      :SuiteSparse, :Test, :Unicode, :Distributed]))
         @test discard_module.(deps) == deps1