Skip to content

Implement default jac_lin* API to patch 0.22 #522

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Implement default jac_lin* API to patch 0.22 #522

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
92c5ecc
Implement default jac_lin API to make 0.22 less breaking
tmigot Nov 21, 2025
5bb8281
up
tmigot Nov 21, 2025
d3afe1a
comment warning
tmigot Nov 21, 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
49 changes: 22 additions & 27 deletions src/nlp/api.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -316,10 +316,10 @@ overwriting `vals`.
"""
function jac_lin_coord! end

@deprecate jac_lin_coord!(nlp::AbstractNLPModel, x::AbstractVector, vals::AbstractVector) jac_lin_coord!(
nlp,
vals,
)
function jac_lin_coord!(nlp::AbstractNLPModel, vals::AbstractVector)
# @warn "Calling deprecated method jac_lin_coord!(nlp, x, vals). Use jac_lin_coord!(nlp, vals) instead."
return jac_lin_coord!(nlp, nlp.meta.x0, vals)
end

"""
vals = jac_lin_coord(nlp)
Expand Down Expand Up @@ -446,20 +446,20 @@ function jprod_lin(nlp::AbstractNLPModel{T, S}, v::AbstractVector) where {T, S}
return jprod_lin!(nlp, v, Jv)
end

@deprecate jprod_lin(nlp::AbstractNLPModel, x::AbstractVector, v::AbstractVector) jprod_lin(nlp, v)

"""
Jv = jprod_lin!(nlp, v, Jv)

Evaluate ``J(x)v``, the linear Jacobian-vector product at `x` in place.
"""
function jprod_lin! end

@deprecate jprod_lin(nlp::AbstractNLPModel, x::AbstractVector, v::AbstractVector) jprod_lin(nlp, v)
@deprecate jprod_lin!(
nlp::AbstractNLPModel,
x::AbstractVector,
v::AbstractVector,
Jv::AbstractVector,
) jprod_lin!(nlp, v, Jv)
function jprod_lin!(nlp::AbstractNLPModel, v::AbstractVector, Jv::AbstractVector)
# @warn "Calling deprecated method jprod_lin!(nlp, x, v, Jv). Use jprod_lin!(nlp, v, Jv) instead."
jprod_lin!(nlp, nlp.meta.x0, v, Jv)
return Jv
end

"""
Jv = jprod_lin!(nlp, rows, cols, vals, v, Jv)
Expand Down Expand Up @@ -593,23 +593,23 @@ function jtprod_lin(nlp::AbstractNLPModel{T, S}, v::AbstractVector) where {T, S}
return jtprod_lin!(nlp, v, Jtv)
end

@deprecate jtprod_lin(nlp::AbstractNLPModel, x::AbstractVector, v::AbstractVector) jtprod_lin(
nlp,
v,
)

"""
Jtv = jtprod_lin!(nlp, v, Jtv)

Evaluate ``J(x)^Tv``, the linear transposed-Jacobian-vector product at `x` in place.
"""
function jtprod_lin! end

@deprecate jtprod_lin(nlp::AbstractNLPModel, x::AbstractVector, v::AbstractVector) jtprod_lin(
nlp,
v,
)
@deprecate jtprod_lin!(
nlp::AbstractNLPModel,
x::AbstractVector,
v::AbstractVector,
Jtv::AbstractVector,
) jtprod_lin!(nlp, v, Jtv)
function jtprod_lin!(nlp::AbstractNLPModel, v::AbstractVector, Jtv::AbstractVector)
# @warn "Calling deprecated method jtprod_lin!(nlp, x, v, Jtv). Use jtprod_lin!(nlp, v, Jtv) instead."
jtprod_lin!(nlp, nlp.meta.x0, v, Jtv)
return Jtv
end

"""
Jtv = jtprod_lin!(nlp, rows, cols, vals, v, Jtv)
Expand Down Expand Up @@ -813,12 +813,7 @@ function jac_lin_op!(
return LinearOperator{T}(nlp.meta.nlin, nlp.meta.nvar, false, false, prod!, ctprod!, ctprod!)
end

@deprecate jac_lin_op!(
nlp::AbstractNLPModel,
x::AbstractVector,
Jv::AbstractVector,
Jtv::AbstractVector,
) jac_lin_op!(nlp, Jv, Jtv)
@deprecate jac_lin_op!(nlp::AbstractNLPModel, x::AbstractVector, Jv::AbstractVector, Jtv::AbstractVector) jac_lin_op!(nlp, Jv, Jtv)

"""
J = jac_lin_op!(nlp, rows, cols, vals, Jv, Jtv)
Expand Down
Loading