fixing documentation for CUTEst functions

Author: arnavk23

docs/src/reference.md

@@ -4,3 +4,9 @@
 
 ```@index
 ```
+
+```@docs
+CUTEst.cons_coord
+CUTEst.cons_coord!
+CUTEst.consjac
+```

src/julia_interface.jl

@@ -26,7 +26,11 @@ end
 
 Prepare output by copying from source to target, using workspace for type conversion if needed.
 """
-@inline function prepare_output!(workspace::Vector{T}, target::AbstractVector{S}, source::AbstractVector{T}) where {T, S}
+@inline function prepare_output!(
+  workspace::Vector{T},
+  target::AbstractVector{S},
+  source::AbstractVector{T},
+) where {T, S}
   if S === T && typeof(target) <: Vector{T}
     target .= source
   else
@@ -75,9 +79,9 @@ end
 
 function NLPModels.grad!(nlp::CUTEstModel{T}, x::AbstractVector, g::AbstractVector) where {T}
   @lencheck nlp.meta.nvar x g
-  
+
   x_prepared = prepare_input!(nlp.input_workspace, x)
-  
+
   if typeof(g) <: Vector{T}
     grad!(nlp, x_prepared, g)
   else
@@ -222,7 +226,7 @@ function cons_coord!(
   @lencheck nlp.meta.nvar x
   @lencheck nlp.meta.ncon c
   @lencheck nlp.meta.nnzj rows cols vals
-  
+
   nnzj = nlp.meta.nnzj
   if length(nlp.jac_coord_rows) < nnzj
     resize!(nlp.jac_coord_rows, nnzj)
@@ -232,11 +236,16 @@ function cons_coord!(
   if length(nlp.cons_vals) < nlp.meta.ncon
     resize!(nlp.cons_vals, nlp.meta.ncon)
   end
-  
-  cons_coord!(nlp, Vector{T}(x), view(nlp.cons_vals, 1:nlp.meta.ncon), 
-              view(nlp.jac_coord_rows, 1:nnzj), view(nlp.jac_coord_cols, 1:nnzj), 
-              view(nlp.jac_coord_vals, 1:nnzj))
-  
+
+  cons_coord!(
+    nlp,
+    Vector{T}(x),
+    view(nlp.cons_vals, 1:nlp.meta.ncon),
+    view(nlp.jac_coord_rows, 1:nnzj),
+    view(nlp.jac_coord_cols, 1:nnzj),
+    view(nlp.jac_coord_vals, 1:nnzj),
+  )
+
   rows .= view(nlp.jac_coord_rows, 1:nnzj)
   cols .= view(nlp.jac_coord_cols, 1:nnzj)
   vals .= view(nlp.jac_coord_vals, 1:nnzj)
@@ -262,7 +271,7 @@ Usage:
 """
 function cons_coord(nlp::CUTEstModel{T}, x::StrideOneVector{T}) where {T}
   @lencheck nlp.meta.nvar x
-  
+
   nnzj = nlp.meta.nnzj
   if length(nlp.jac_coord_rows) < nnzj
     resize!(nlp.jac_coord_rows, nnzj)
@@ -272,16 +281,21 @@ function cons_coord(nlp::CUTEstModel{T}, x::StrideOneVector{T}) where {T}
   if length(nlp.cons_vals) < nlp.meta.ncon
     resize!(nlp.cons_vals, nlp.meta.ncon)
   end
-  
-  cons_coord!(nlp, x, view(nlp.cons_vals, 1:nlp.meta.ncon), 
-              view(nlp.jac_coord_rows, 1:nnzj), view(nlp.jac_coord_cols, 1:nnzj), 
-              view(nlp.jac_coord_vals, 1:nnzj))
-  
+
+  cons_coord!(
+    nlp,
+    x,
+    view(nlp.cons_vals, 1:nlp.meta.ncon),
+    view(nlp.jac_coord_rows, 1:nnzj),
+    view(nlp.jac_coord_cols, 1:nnzj),
+    view(nlp.jac_coord_vals, 1:nnzj),
+  )
+
   c = copy(view(nlp.cons_vals, 1:nlp.meta.ncon))
   rows = copy(view(nlp.jac_coord_rows, 1:nnzj))
   cols = copy(view(nlp.jac_coord_cols, 1:nnzj))
   vals = copy(view(nlp.jac_coord_vals, 1:nnzj))
-  
+
   return c, rows, cols, vals
 end
 
@@ -699,13 +713,18 @@ function NLPModels.hess_coord!(
   @lencheck nlp.meta.nvar x
   @lencheck nlp.meta.ncon y
   @lencheck nlp.meta.nnzh vals
-  
+
   if length(nlp.hess_coord_vals) < nlp.meta.nnzh
     resize!(nlp.hess_coord_vals, nlp.meta.nnzh)
   end
-  
-  NLPModels.hess_coord!(nlp, Vector{T}(x), convert(Vector{T}, y), 
-                        view(nlp.hess_coord_vals, 1:nlp.meta.nnzh), obj_weight = obj_weight)
+
+  NLPModels.hess_coord!(
+    nlp,
+    Vector{T}(x),
+    convert(Vector{T}, y),
+    view(nlp.hess_coord_vals, 1:nlp.meta.nnzh),
+    obj_weight = obj_weight,
+  )
   vals .= view(nlp.hess_coord_vals, 1:nlp.meta.nnzh)
   return vals
 end

src/model.jl

@@ -19,10 +19,10 @@ mutable struct CUTEstModel{T} <: AbstractNLPModel{T, Vector{T}}
   jac_coord_cols::Vector{Cint}
   jac_coord_vals::Vector{T}
   hess_coord_vals::Vector{T}
-  
+
   cons_vals::Vector{T}
   cons_nln_vals::Vector{T}
-  
+
   input_workspace::Vector{T}
   output_workspace::Vector{T}
 
@@ -312,11 +312,11 @@ function CUTEstModel{T}(
   jac_coord_cols = Vector{Cint}(undef, nnzj)
   jac_coord_vals = Vector{T}(undef, nnzj)
   hess_coord_vals = Vector{T}(undef, nnzh)
-  
+
   cons_vals = Vector{T}(undef, ncon)
   nnln = count(.!linear)
   cons_nln_vals = Vector{T}(undef, nnln)
-  
+
   input_workspace = Vector{T}(undef, nvar)
   output_workspace = Vector{T}(undef, max(nvar, ncon))
 

test/test_comprehensive.jl

@@ -12,7 +12,9 @@ vals_h = Vector{Float64}(undef, nlp1.meta.nnzh)
 hess_coord!(nlp1, x0, vals_h)
 
 b_hess = @benchmark hess_coord!($nlp1, $x0, $vals_h) samples=100 evals=5
-println("hess_coord!: $(b_hess.allocs) allocations, $(BenchmarkTools.prettytime(median(b_hess).time))")
+println(
+  "hess_coord!: $(b_hess.allocs) allocations, $(BenchmarkTools.prettytime(median(b_hess).time))",
+)
 
 finalize(nlp1)
 
@@ -36,7 +38,9 @@ println("\nTesting cons_coord allocation improvements:")
 c1, rows1, cols1, vals1 = cons_coord(nlp2, x0)
 
 b_cons = @benchmark cons_coord($nlp2, $x0) samples=100 evals=5
-println("cons_coord: $(b_cons.allocs) allocations, $(BenchmarkTools.prettytime(median(b_cons).time))")
+println(
+  "cons_coord: $(b_cons.allocs) allocations, $(BenchmarkTools.prettytime(median(b_cons).time))",
+)
 println("Memory: $(BenchmarkTools.prettymemory(median(b_cons).memory))")
 println("Returned $(length(vals1)) Jacobian elements")
 
@@ -46,7 +50,9 @@ vals = Vector{Float64}(undef, nlp2.meta.nnzj)
 c_out = Vector{Float64}(undef, nlp2.meta.ncon)
 
 b_cons_inplace = @benchmark cons_coord!($nlp2, $x0, $c_out, $rows, $cols, $vals) samples=100 evals=5
-println("cons_coord!: $(b_cons_inplace.allocs) allocations, $(BenchmarkTools.prettytime(median(b_cons_inplace).time))")
+println(
+  "cons_coord!: $(b_cons_inplace.allocs) allocations, $(BenchmarkTools.prettytime(median(b_cons_inplace).time))",
+)
 
 println("\nTesting type conversion improvements:")
 x0_f32 = Float32.(x0)
@@ -61,6 +67,8 @@ y = zeros(nlp2.meta.ncon)
 hess_coord!(nlp2, x0, y, vals_h2)
 
 b_hess2 = @benchmark hess_coord!($nlp2, $x0, $y, $vals_h2) samples=100 evals=5
-println("hess_coord! (constrained): $(b_hess2.allocs) allocations, $(BenchmarkTools.prettytime(median(b_hess2).time))")
+println(
+  "hess_coord! (constrained): $(b_hess2.allocs) allocations, $(BenchmarkTools.prettytime(median(b_hess2).time))",
+)
 
 finalize(nlp2)