Merge pull request #5 from JuliaOptimizationVariationalAnalysis/auto-juliaformatter-pr

[AUTO] JuliaFormatter.jl run

Author: tmigot

docs/make.jl

@@ -1,24 +1,27 @@
 using VariationalInequalitySolver
 using Documenter
 
-DocMeta.setdocmeta!(VariationalInequalitySolver, :DocTestSetup, :(using VariationalInequalitySolver); recursive=true)
+DocMeta.setdocmeta!(
+  VariationalInequalitySolver,
+  :DocTestSetup,
+  :(using VariationalInequalitySolver);
+  recursive = true,
+)
 
 makedocs(;
-    modules=[VariationalInequalitySolver],
-    authors="Tangi Migot [email protected]",
-    repo="https://github.com/JuliaOptimizationVariationalAnalysis/VariationalInequalitySolver.jl/blob/{commit}{path}#{line}",
-    sitename="VariationalInequalitySolver.jl",
-    format=Documenter.HTML(;
-        prettyurls=get(ENV, "CI", "false") == "true",
-        canonical="https://JuliaOptimizationVariationalAnalysis.github.io/VariationalInequalitySolver.jl",
-        assets=String[],
-    ),
-    pages=[
-        "Home" => "index.md",
-    ],
+  modules = [VariationalInequalitySolver],
+  authors = "Tangi Migot [email protected]",
+  repo = "https://github.com/JuliaOptimizationVariationalAnalysis/VariationalInequalitySolver.jl/blob/{commit}{path}#{line}",
+  sitename = "VariationalInequalitySolver.jl",
+  format = Documenter.HTML(;
+    prettyurls = get(ENV, "CI", "false") == "true",
+    canonical = "https://JuliaOptimizationVariationalAnalysis.github.io/VariationalInequalitySolver.jl",
+    assets = String[],
+  ),
+  pages = ["Home" => "index.md"],
 )
 
 deploydocs(;
-    repo="github.com/JuliaOptimizationVariationalAnalysis/VariationalInequalitySolver.jl",
-    devbranch="main",
+  repo = "github.com/JuliaOptimizationVariationalAnalysis/VariationalInequalitySolver.jl",
+  devbranch = "main",
 )

src/VariationalInequalitySolver.jl

@@ -2,8 +2,17 @@ module VariationalInequalitySolver
 
 using FastClosures, LinearAlgebra, Logging, NLPModels, Stopping
 
-import NLPModels: residual!, jac_structure_residual!, jac_coord_residual!, jprod_residual!, jtprod_residual!, jac_op_residual!, hess_structure_residual!, hess_coord_residual!, hprod_residual!, hess_op_residual!
-
+import NLPModels:
+  residual!,
+  jac_structure_residual!,
+  jac_coord_residual!,
+  jprod_residual!,
+  jtprod_residual!,
+  jac_op_residual!,
+  hess_structure_residual!,
+  hess_coord_residual!,
+  hprod_residual!,
+  hess_op_residual!
 
 abstract type AbstractVIModel{T, S} end
 
@@ -29,12 +38,23 @@ mutable struct NLSVIModel{S, T, NLP <: AbstractNLSModel{T, S}} <: AbstractVIMode
     @lencheck nls.nls_meta.nequ nls.meta.x0 #test that nls.meta.nvar == nls.nls_meta.nequ
     return new{S, T, typeof(nls)}(
       VIMeta{T, S}(nls.meta.x0, nls.meta.nvar, nls.nls_meta.nnzj, nls.nls_meta.nnzh),
-      nls
+      nls,
     )
   end
 end
 
-for meth in [:residual!, :jac_structure_residual!, :jac_coord_residual!, :jprod_residual!, :jtprod_residual!, :jac_op_residual!, :hess_structure_residual!, :hess_coord_residual!, :hprod_residual!, :hess_op_residual!]
+for meth in [
+  :residual!,
+  :jac_structure_residual!,
+  :jac_coord_residual!,
+  :jprod_residual!,
+  :jtprod_residual!,
+  :jac_op_residual!,
+  :hess_structure_residual!,
+  :hess_coord_residual!,
+  :hprod_residual!,
+  :hess_op_residual!,
+]
   @eval begin
     $meth(model::NLSVIModel, args...; kwargs...) = $meth(model.nls, args...; kwargs...)
   end

src/model/api.jl

@@ -438,4 +438,4 @@ function project(model::AbstractVIModel{T, S}, x::AbstractVector{T}) where {T, S
   @lencheck model.meta.nvar x
   Px = S(undef, model.meta.nvar)
   project!(model, x, Px)
-end
+end

src/projector/proj_nls.jl

@@ -11,16 +11,15 @@ mutable struct NLSProjector{T, S} <: AbstractNLSModel{T, S}
   nls_meta::NLSMeta{T, S}
   counters::NLSCounters
   d::S
-  function NLSProjector(model::AbstractNLSModel{T, S}, d::S; name = "Projection over $(model.meta.name)") where {T, S}
+  function NLSProjector(
+    model::AbstractNLSModel{T, S},
+    d::S;
+    name = "Projection over $(model.meta.name)",
+  ) where {T, S}
     nvar = length(d)
     x0 = d #fill!(S(undef, nvar), zero(T))
     meta = NLPModelMeta{T, S}(nvar, x0 = x0, name = name)
-    nls_meta = NLSMeta{T, S}(
-      nvar,
-      nvar,
-      nnzj = nvar,
-      nnzh = 0,
-    )
+    nls_meta = NLSMeta{T, S}(nvar, nvar, nnzj = nvar, nnzh = 0)
     return new{T, S}(model, meta, nls_meta, NLSCounters(), d)
   end
 end
@@ -36,14 +35,18 @@ function NLPModels.jac_structure_residual!(
   cols::AbstractVector{<:Integer},
 )
   @lencheck model.nls_meta.nnzj rows cols
-  for i=1:model.meta.nvar
+  for i = 1:(model.meta.nvar)
     rows[i] = i
     cols[i] = i
   end
   return rows, cols
 end
 
-function NLPModels.jac_coord_residual!(model::NLSProjector{T, S}, x::AbstractVector, vals::AbstractVector) where {T, S}
+function NLPModels.jac_coord_residual!(
+  model::NLSProjector{T, S},
+  x::AbstractVector,
+  vals::AbstractVector,
+) where {T, S}
   @lencheck model.meta.nvar x
   @lencheck model.nls_meta.nnzj vals
   increment!(model, :neval_jac_residual)
@@ -89,7 +92,21 @@ function NLPModels.hprod_residual!(::NLSProjector, x, i, v, Hiv)
   return Hiv
 end
 
-for meth in [:cons!, :jth_congrad!, :jth_sparse_congrad, :jac_structure!, :jac_coord!, :jprod!, :jtprod!, :jth_hess_coord!, :jth_hprod!, :ghjvprod!, :hess_structure!, :hess_coord!, :hprod!]
+for meth in [
+  :cons!,
+  :jth_congrad!,
+  :jth_sparse_congrad,
+  :jac_structure!,
+  :jac_coord!,
+  :jprod!,
+  :jtprod!,
+  :jth_hess_coord!,
+  :jth_hprod!,
+  :ghjvprod!,
+  :hess_structure!,
+  :hess_coord!,
+  :hprod!,
+]
   premeth = Symbol("NLPModels.", meth)
   @eval begin
     $premeth(model::NLSProjector, args...; kwargs...) = $meth(model.model, args...; kwargs...)

src/solvers/projectionVI.jl

@@ -1,11 +1,6 @@
 export ProjectionVI
 
-function ProjectionVI(
-  model::AbstractVIModel,
-  x0::AbstractVector;
-  rho0 :: Float64 = 0.5,
-  kwargs...
-)
+function ProjectionVI(model::AbstractVIModel, x0::AbstractVector; rho0::Float64 = 0.5, kwargs...)
   stp = GenericStopping(model, x0; kwargs...)
   return ProjectionVI(stp, rho0 = rho0)
 end
@@ -17,7 +12,7 @@ function abresidual!(model, xk, rho, Fx) # xk + rho * F(xk)
   return Fx
 end
 
-function ProjectionVI(stp::AbstractStopping; rho0 :: Float64 = 0.5)
+function ProjectionVI(stp::AbstractStopping; rho0::Float64 = 0.5)
   xk = stp.current_state.x
   xkp = similar(xk)
   rho = rho0

test/runtests.jl

@@ -10,4 +10,4 @@ Random.seed!(1234)
   xr = rand(2)
   @test project(vi, xr) == xr
   sol = ProjectionVI(vi, xr)
-end
+end