Skip to content

Add backwards-compat fallbacks for old jac_lin* signatures #515

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
arnavk23 wants to merge 3 commits into from
Closed

Add backwards-compat fallbacks for old jac_lin* signatures #515

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8ffc12a
Add backwards-compat fallbacks for old jac_lin* signatures; add CHANG…
arnavk23 Nov 18, 2025
f86cdc0
Delete CHANGELOG.md
arnavk23 Nov 18, 2025
f3c91e3
Update api.jl
arnavk23 Nov 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
117 changes: 103 additions & 14 deletions src/nlp/api.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
using Base: @deprecate

function _has_external_method(f, tt::Type)
if !Base.hasmethod(f, tt)
return false
end

ml = methods(f, tt)
for m in ml.ms
if m.module !== @__MODULE__
return true
end
end
return false
end

export obj, grad, grad!, objgrad, objgrad!, objcons, objcons!
export cons, cons!, cons_lin, cons_lin!, cons_nln, cons_nln!
export jth_con, jth_congrad, jth_congrad!, jth_sparse_congrad
Expand Down Expand Up @@ -238,6 +252,9 @@ Return the structure of the linear constraints Jacobian in sparse coordinate for
"""
function jac_lin_structure! end

@deprecate jac_lin_structure!(nlp::AbstractNLPModel, x::AbstractVector, rows::AbstractVector, cols::AbstractVector) jac_lin_structure!(nlp, rows, cols)
@deprecate jac_lin_structure(nlp::AbstractNLPModel, x::AbstractVector) jac_lin_structure(nlp)

"""
(rows,cols) = jac_nln_structure(nlp)

Expand Down Expand Up @@ -266,12 +283,28 @@ function jac_coord!(nlp::AbstractNLPModel, x::AbstractVector, vals::AbstractVect
@lencheck nlp.meta.nvar x
@lencheck nlp.meta.nnzj vals
increment!(nlp, :neval_jac)
if nlp.meta.nlin > 0
if nlp.meta.nlin > 0
if nlp.meta.nnln == 0
jac_lin_coord!(nlp, vals)
try
jac_lin_coord!(nlp, x, vals)
catch err
if err isa MethodError
jac_lin_coord!(nlp, vals)
else
rethrow(err)
end
end
else
lin_ind = 1:(nlp.meta.lin_nnzj)
jac_lin_coord!(nlp, view(vals, lin_ind))
try
jac_lin_coord!(nlp, x, view(vals, lin_ind))
catch err
if err isa MethodError
jac_lin_coord!(nlp, view(vals, lin_ind))
else
rethrow(err)
end
end
end
end
if nlp.meta.nnln > 0
Expand Down Expand Up @@ -328,7 +361,11 @@ Evaluate the linear constraints Jacobian in sparse coordinate format.
"""
function jac_lin_coord(nlp::AbstractNLPModel{T, S}) where {T, S}
vals = S(undef, nlp.meta.lin_nnzj)
return jac_lin_coord!(nlp, vals)
if hasmethod(jac_lin_coord!, Tuple{typeof(nlp), AbstractVector, typeof(vals)}) && !isempty(nlp.meta.x0)
return jac_lin_coord!(nlp, nlp.meta.x0, vals)
else
return jac_lin_coord!(nlp, vals)
end
end

@deprecate jac_lin_coord(nlp::AbstractNLPModel, x::AbstractVector) jac_lin_coord(nlp)
Expand Down Expand Up @@ -397,11 +434,27 @@ function jprod!(nlp::AbstractNLPModel, x::AbstractVector, v::AbstractVector, Jv:
@lencheck nlp.meta.nvar x v
@lencheck nlp.meta.ncon Jv
increment!(nlp, :neval_jprod)
if nlp.meta.nlin > 0
if nlp.meta.nlin > 0
if nlp.meta.nnln == 0
jprod_lin!(nlp, v, Jv)
try
jprod_lin!(nlp, x, v, Jv)
catch err
if err isa MethodError
jprod_lin!(nlp, v, Jv)
else
rethrow(err)
end
end
else
jprod_lin!(nlp, v, view(Jv, nlp.meta.lin))
try
jprod_lin!(nlp, x, v, view(Jv, nlp.meta.lin))
catch err
if err isa MethodError
jprod_lin!(nlp, v, view(Jv, nlp.meta.lin))
else
rethrow(err)
end
end
end
end
if nlp.meta.nnln > 0
Expand Down Expand Up @@ -443,7 +496,11 @@ Evaluate ``J(x)v``, the linear Jacobian-vector product at `x`.
function jprod_lin(nlp::AbstractNLPModel{T, S}, v::AbstractVector) where {T, S}
@lencheck nlp.meta.nvar v
Jv = S(undef, nlp.meta.nlin)
return jprod_lin!(nlp, v, Jv)
if _has_external_method(jprod_lin!, Tuple{typeof(nlp), AbstractVector, AbstractVector, typeof(Jv)}) && !isempty(nlp.meta.x0)
return jprod_lin!(nlp, nlp.meta.x0, v, Jv)
else
return jprod_lin!(nlp, v, Jv)
end
end

"""
Expand Down Expand Up @@ -543,12 +600,30 @@ function jtprod!(nlp::AbstractNLPModel, x::AbstractVector, v::AbstractVector, Jt
@lencheck nlp.meta.nvar x Jtv
@lencheck nlp.meta.ncon v
increment!(nlp, :neval_jtprod)
if nlp.meta.nnln == 0
(nlp.meta.nlin > 0) && jtprod_lin!(nlp, v, Jtv)
if nlp.meta.nnln == 0
if nlp.meta.nlin > 0
try
jtprod_lin!(nlp, x, v, Jtv)
catch err
if err isa MethodError
jtprod_lin!(nlp, v, Jtv)
else
rethrow(err)
end
end
end
elseif nlp.meta.nlin == 0
(nlp.meta.nnln > 0) && jtprod_nln!(nlp, x, v, Jtv)
elseif nlp.meta.nlin >= nlp.meta.nnln
jtprod_lin!(nlp, view(v, nlp.meta.lin), Jtv)
try
jtprod_lin!(nlp, x, view(v, nlp.meta.lin), Jtv)
catch err
if err isa MethodError
jtprod_lin!(nlp, view(v, nlp.meta.lin), Jtv)
else
rethrow(err)
end
end
if nlp.meta.nnln > 0
Jtv .+= jtprod_nln(nlp, x, view(v, nlp.meta.nln))
end
Expand Down Expand Up @@ -590,7 +665,13 @@ Evaluate ``J(x)^Tv``, the linear transposed-Jacobian-vector product at `x`.
function jtprod_lin(nlp::AbstractNLPModel{T, S}, v::AbstractVector) where {T, S}
@lencheck nlp.meta.nlin v
Jtv = S(undef, nlp.meta.nvar)
return jtprod_lin!(nlp, v, Jtv)
# Prefer downstream implementations that expect the old signature
# `jtprod_lin!(nlp, x, v, Jtv)` if they exist and an initial `x0` is available.
if _has_external_method(jtprod_lin!, Tuple{typeof(nlp), AbstractVector, AbstractVector, typeof(Jtv)}) && !isempty(nlp.meta.x0)
return jtprod_lin!(nlp, nlp.meta.x0, v, Jtv)
else
return jtprod_lin!(nlp, v, Jtv)
end
end

"""
Expand Down Expand Up @@ -793,7 +874,11 @@ function jac_lin_op!(
@lencheck nlp.meta.nlin Jv
@lencheck nlp.meta.nvar Jtv
prod! = @closure (res, v, α, β) -> begin # res = α * J * v + β * res
jprod_lin!(nlp, v, Jv)
if _has_external_method(jprod_lin!, Tuple{typeof(nlp), AbstractVector, AbstractVector, typeof(Jv)}) && !isempty(nlp.meta.x0)
jprod_lin!(nlp, nlp.meta.x0, v, Jv)
else
jprod_lin!(nlp, v, Jv)
end
if β == 0
res .= α .* Jv
else
Expand All @@ -802,7 +887,11 @@ function jac_lin_op!(
return res
end
ctprod! = @closure (res, v, α, β) -> begin
jtprod_lin!(nlp, v, Jtv)
if _has_external_method(jtprod_lin!, Tuple{typeof(nlp), AbstractVector, AbstractVector, typeof(Jtv)}) && !isempty(nlp.meta.x0)
jtprod_lin!(nlp, nlp.meta.x0, v, Jtv)
else
jtprod_lin!(nlp, v, Jtv)
end
if β == 0
res .= α .* Jtv
else
Expand Down