diff --git a/Project.toml b/Project.toml index 3693b96bc5..1ea74639d2 100644 --- a/Project.toml +++ b/Project.toml @@ -19,13 +19,16 @@ SpecialFunctions = "276daf66-3868-5448-9aa4-cd146d93841b" Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40" [weakdeps] +CliqueTrees = "60701a23-6482-424a-84db-faee86b9b1f8" LDLFactorizations = "40e66cde-538c-5869-a4ad-c39174c6795b" [extensions] +MathOptInterfaceCliqueTreesExt = "CliqueTrees" MathOptInterfaceLDLFactorizationsExt = "LDLFactorizations" [compat] BenchmarkTools = "1" +CliqueTrees = "1.17" CodecBzip2 = "0.6, 0.7, 0.8" CodecZlib = "0.6, 0.7" ForwardDiff = "1" @@ -35,7 +38,7 @@ LDLFactorizations = "0.10" LinearAlgebra = "1" MutableArithmetics = "1" NaNMath = "0.3, 1" -OrderedCollections = "1" +OrderedCollections = "1.1" ParallelTestRunner = "2.4.1" PrecompileTools = "1" Printf = "1" @@ -45,9 +48,10 @@ Test = "1" julia = "1.10" [extras] -LDLFactorizations = "40e66cde-538c-5869-a4ad-c39174c6795b" +CliqueTrees = "60701a23-6482-424a-84db-faee86b9b1f8" JSONSchema = "7d188eb4-7ad8-530c-ae41-71a32a6d4692" +LDLFactorizations = "40e66cde-538c-5869-a4ad-c39174c6795b" ParallelTestRunner = "d3525ed8-44d0-4b2c-a655-542cee43accc" [targets] -test = ["LDLFactorizations", "JSONSchema", "ParallelTestRunner"] +test = ["CliqueTrees", "LDLFactorizations", "JSONSchema", "ParallelTestRunner"] diff --git a/ext/MathOptInterfaceCliqueTreesExt.jl b/ext/MathOptInterfaceCliqueTreesExt.jl new file mode 100644 index 0000000000..e1b34e58dd --- /dev/null +++ b/ext/MathOptInterfaceCliqueTreesExt.jl @@ -0,0 +1,33 @@ +# Copyright (c) 2017: Miles Lubin and contributors +# Copyright (c) 2017: Google Inc. +# +# Use of this source code is governed by an MIT-style license that can be found +# in the LICENSE.md file or at https://opensource.org/licenses/MIT. + +module MathOptInterfaceCliqueTreesExt + +import CliqueTrees +import LinearAlgebra +import MathOptInterface as MOI +import SparseArrays + +MOI.Utilities.is_defined(::MOI.Utilities.CliqueTreesExt) = true + +function MOI.Utilities.compute_sparse_sqrt( + ::MOI.Utilities.CliqueTreesExt, + Q::AbstractMatrix, +) + G = LinearAlgebra.cholesky!( + CliqueTrees.Multifrontal.ChordalCholesky(Q), + LinearAlgebra.RowMaximum(), + ) + U = SparseArrays.sparse(G.U) * G.P + # Verify the factorization reconstructs Q. We don't have something like + # LinearAlgebra.issuccess(G) + if !isapprox(Q, U' * U; atol = 1e-10) + return nothing + end + return SparseArrays.findnz(U) +end + +end # module diff --git a/ext/MathOptInterfaceLDLFactorizationsExt.jl b/ext/MathOptInterfaceLDLFactorizationsExt.jl index c3b5c7a31c..c1bd13ea87 100644 --- a/ext/MathOptInterfaceLDLFactorizationsExt.jl +++ b/ext/MathOptInterfaceLDLFactorizationsExt.jl @@ -11,39 +11,19 @@ import LinearAlgebra import MathOptInterface as MOI import SparseArrays -# The type signature of this function is not important, so long as it is more -# specific than the (untyped) generic fallback with the error pointing to -# LDLFactorizations.jl -function MOI.Bridges.Constraint.compute_sparse_sqrt_fallback( +MOI.Utilities.is_defined(::MOI.Utilities.LDLFactorizationsExt) = true + +function MOI.Utilities.compute_sparse_sqrt( + ::MOI.Utilities.LDLFactorizationsExt, Q::AbstractMatrix, - ::F, - ::S, -) where {F<:MOI.ScalarQuadraticFunction,S<:MOI.AbstractSet} +) n = LinearAlgebra.checksquare(Q) factor = LDLFactorizations.ldl(Q) - # Ideally we should use `LDLFactorizations.factorized(factor)` here, but it - # has some false negatives. Instead we check that the factorization appeared - # to work. This is a heuristic. There might be other cases where check is - # insufficient. - if minimum(factor.D) < 0 || any(issubnormal, factor.D) - msg = """ - Unable to transform a quadratic constraint into a SecondOrderCone - constraint because the quadratic constraint is not convex. - """ - throw(MOI.UnsupportedConstraint{F,S}(msg)) - end - # We have Q = P' * L * D * L' * P. We want to find Q = U' * U, so - # U = sqrt(D) * L' * P. First, compute L'. Note I and J are reversed: - J, I, V = SparseArrays.findnz(factor.L) - # Except L doesn't include the identity along the diagonal. Add it back. - append!(J, 1:n) - append!(I, 1:n) - append!(V, ones(n)) - # Now scale by sqrt(D) - for (k, i) in enumerate(I) - V[k] *= sqrt(factor.D[i, i]) + if !LDLFactorizations.factorized(factor) || minimum(factor.D) < 0 + return nothing end - # Finally, permute the columns of L'. The rows stay in the same order. + L = sqrt.(factor.D) * LinearAlgebra.UnitLowerTriangular(factor.L) + J, I, V = SparseArrays.findnz(SparseArrays.sparse(L)) return I, factor.P[J], V end diff --git a/src/Bridges/Constraint/bridges/QuadtoSOCBridge.jl b/src/Bridges/Constraint/bridges/QuadtoSOCBridge.jl index 437547c006..cbc328fe17 100644 --- a/src/Bridges/Constraint/bridges/QuadtoSOCBridge.jl +++ b/src/Bridges/Constraint/bridges/QuadtoSOCBridge.jl @@ -60,8 +60,8 @@ end const QuadtoSOC{T,OT<:MOI.ModelLike} = SingleBridgeOptimizer{QuadtoSOCBridge{T},OT} -function compute_sparse_sqrt_fallback(Q, ::F, ::S) where {F,S} - msg = """ +function _error_msg(::MOI.Utilities.LDLFactorizationsExt) + return """ Unable to transform a quadratic constraint into a SecondOrderCone constraint because the quadratic constraint is not strongly convex and our Cholesky decomposition failed. @@ -76,36 +76,41 @@ function compute_sparse_sqrt_fallback(Q, ::F, ::S) where {F,S} LDLFactorizations.jl is not included by default because it is licensed under the LGPL. """ - return throw(MOI.AddConstraintNotAllowed{F,S}(msg)) end -function compute_sparse_sqrt(Q, func, set) - # There's a big try-catch here because Cholesky can fail even if - # `check = false`. As one example, it currently (v1.12) fails with - # `BigFloat`. Similarly, we want to guard against errors in - # `compute_sparse_sqrt_fallback`. - # - # The try-catch isn't a performance concern because the alternative is not - # being able to reformulate the problem. - try - factor = LinearAlgebra.cholesky(Q; check = false) - if !LinearAlgebra.issuccess(factor) - return compute_sparse_sqrt_fallback(Q, func, set) - end - L, p = SparseArrays.sparse(factor.L), factor.p - # We have Q = P' * L * L' * P. We want to find Q = U' * U, so U = L' * P - # First, compute L'. Note I and J are reversed - J, I, V = SparseArrays.findnz(L) - # Then, we want to permute the columns of L'. The rows stay in the same - # order. - return I, p[J], V - catch err - if err isa MOI.AddConstraintNotAllowed - rethrow(err) - end - msg = "There was an error computing a matrix square root" - throw(MOI.UnsupportedConstraint{typeof(func),typeof(set)}(msg)) +function _error_msg(::MOI.Utilities.CliqueTreesExt) + return """ + Unable to transform a quadratic constraint into a SecondOrderCone + constraint because the quadratic constraint is not strongly convex and + our Cholesky decomposition failed. + + If the constraint is convex but not strongly convex, you can work-around + this issue by manually installing and loading `CliqueTrees.jl`: + ```julia + import Pkg; Pkg.add("CliqueTrees") + using CliqueTrees + ``` + + CliqueTrees.jl is not included by default because it contains a number of + heavy dependencies. + """ +end + +function compute_sparse_sqrt(Q, ::F, ::S) where {F,S} + if (ret = MOI.Utilities.compute_sparse_sqrt(Q)) !== nothing + return ret + elseif !MOI.Utilities.is_defined(MOI.Utilities.LDLFactorizationsExt()) + msg = _error_msg(MOI.Utilities.LDLFactorizationsExt()) + return throw(MOI.AddConstraintNotAllowed{F,S}(msg)) + elseif !MOI.Utilities.is_defined(MOI.Utilities.CliqueTreesExt()) + msg = _error_msg(MOI.Utilities.CliqueTreesExt()) + return throw(MOI.AddConstraintNotAllowed{F,S}(msg)) end + msg = """ + Unable to transform a quadratic constraint into a SecondOrderCone + constraint because the quadratic constraint is not convex. + """ + return throw(MOI.UnsupportedConstraint{F,S}(msg)) end function bridge_constraint( diff --git a/src/Utilities/Utilities.jl b/src/Utilities/Utilities.jl index 34d28429f8..505c91a79b 100644 --- a/src/Utilities/Utilities.jl +++ b/src/Utilities/Utilities.jl @@ -70,5 +70,6 @@ include("lazy_iterators.jl") include("set_dot.jl") include("distance_to_set.jl") +include("sparse_square_root.jl") end # module diff --git a/src/Utilities/sparse_square_root.jl b/src/Utilities/sparse_square_root.jl new file mode 100644 index 0000000000..1cd7182c02 --- /dev/null +++ b/src/Utilities/sparse_square_root.jl @@ -0,0 +1,72 @@ +# Copyright (c) 2017: Miles Lubin and contributors +# Copyright (c) 2017: Google Inc. +# +# Use of this source code is governed by an MIT-style license that can be found +# in the LICENSE.md file or at https://opensource.org/licenses/MIT. + +abstract type AbstractExt end + +is_defined(::AbstractExt) = false + +struct LDLFactorizationsExt <: AbstractExt end + +struct CliqueTreesExt <: AbstractExt end + +struct LinearAlgebraExt <: AbstractExt end + +is_defined(::LinearAlgebraExt) = true + +function compute_sparse_sqrt(::LinearAlgebraExt, Q::AbstractMatrix) + factor = LinearAlgebra.cholesky(Q; check = false) + if !LinearAlgebra.issuccess(factor) + return nothing + end + L, p = SparseArrays.sparse(factor.L), factor.p + # We have Q = P' * L * L' * P. We want to find Q = U' * U, so U = L' * P + # First, compute L'. Note I and J are reversed + J, I, V = SparseArrays.findnz(L) + # Then, we want to permute the columns of L'. The rows stay in the same + # order. + return I, p[J], V +end + +""" + compute_sparse_sqrt(Q::AbstractMatrix) + +Attempts to compute a sparse square root such that `Q = A' * A`. + +## Return value + +If successful, this function returns an `(I, J, V)` triplet of the sparse `A` +matrix. + +If unsuccessful, this function returns `nothing`. + +## Extensions + +By default, this function attempts to use a Cholesky decomposition. If that +fails, it may optionally use various extension packages. + +These extension packages must be loaded before calling `compute_sparse_sqrt`. + +The extensions currently supported are: + + * The LDL routine in `LDLFactorizations.jl` + * The pivoted Cholesky in `CliqueTrees.jl` +""" +function compute_sparse_sqrt(Q::AbstractMatrix) + # There's a big try-catch here because Cholesky can fail even if + # `check = false`. The try-catch isn't a performance concern because the + # alternative is not being able to reformulate the problem. + for ext in (LinearAlgebraExt(), LDLFactorizationsExt(), CliqueTreesExt()) + if is_defined(ext) + try + if (ret = compute_sparse_sqrt(ext, Q)) !== nothing + return ret + end + catch + end + end + end + return nothing +end diff --git a/test/Bridges/Constraint/test_QuadtoSOCBridge.jl b/test/Bridges/Constraint/test_QuadtoSOCBridge.jl index 9ca703a8e4..21ede98582 100644 --- a/test/Bridges/Constraint/test_QuadtoSOCBridge.jl +++ b/test/Bridges/Constraint/test_QuadtoSOCBridge.jl @@ -6,12 +6,13 @@ module TestConstraintQuadToSOC -import LinearAlgebra -import SparseArrays using Test +import CliqueTrees import LDLFactorizations +import LinearAlgebra import MathOptInterface as MOI +import SparseArrays function runtests() for name in names(@__MODULE__; all = true) @@ -383,11 +384,7 @@ function test_compute_sparse_sqrt_edge_cases() [-1.0 0.0; 0.0 1.0], # Found from test_quadratic_nonconvex_constraint_basic [0.0 -1.0; -1.0 0.0], - # Different element type. We could potentially make this work in future, - # but it first requires https://github.com/JuliaSmoothOptimizers/LDLFactorizations.jl/pull/142 BigFloat[-1.0 0.0; 0.0 1.0], - BigFloat[1.0 0.0; 0.0 2.0], - BigFloat[1.0 1.0; 1.0 1.0], ] B = SparseArrays.sparse(A) f = zero(MOI.ScalarQuadraticFunction{eltype(A)}) @@ -400,17 +397,96 @@ function test_compute_sparse_sqrt_edge_cases() return end -function test_compute_sparse_sqrt_fallback() - # Test the default fallback that is hit when LDLFactorizations isn't loaded. - # We could put the test somewhere else so it runs before this file is - # loaded, but that's pretty flakey for a long-term solution. Instead, we're - # going to abuse the lack of a strong type signature to hit it: - f = zero(MOI.ScalarAffineFunction{Float64}) - A = SparseArrays.sparse([-1.0 0.0; 0.0 1.0]) - @test_throws( - MOI.AddConstraintNotAllowed{typeof(f),MOI.GreaterThan{Float64}}, - MOI.Bridges.Constraint.compute_sparse_sqrt(A, f, MOI.GreaterThan(0.0)), - ) +function test_ldlfactorizations_compute_sparse_sqrt_edge_cases() + ext = MOI.Utilities.LDLFactorizationsExt() + for A in AbstractMatrix[ + [1.0 0.0; 0.0 2.0], + [1.0 0.0 1.0; 0.0 1.0 1.0; 1.0 1.0 3.0], + # [1.0 1.0; 1.0 1.0], + # [2.0 2.0; 2.0 2.0], + # [2.0 0.0; 0.0 0.0], + ] + I, J, V = MOI.Utilities.compute_sparse_sqrt(ext, SparseArrays.sparse(A)) + U = zeros(eltype(A), size(A)) + for (i, j, v) in zip(I, J, V) + U[i, j] += v + end + @test isapprox(A, U' * U; atol = 1e-10) + end + # Test failures + for A in Any[ + [-1.0 0.0; 0.0 1.0], + [0.0 -1.0; -1.0 0.0], + BigFloat[-1.0 0.0; 0.0 1.0], + [1.0 1.0 0.0; 1.0 1.0 0.0; 0.0 0.0 1.0], + ] + @test MOI.Utilities.compute_sparse_sqrt(ext, SparseArrays.sparse(A)) === + nothing + end + return +end + +function test_clique_trees_compute_sparse_sqrt_edge_cases() + ext = MOI.Utilities.CliqueTreesExt() + for A in AbstractMatrix[ + [1.0 0.0; 0.0 2.0], + [1.0 0.0 1.0; 0.0 1.0 1.0; 1.0 1.0 3.0], + [1.0 1.0; 1.0 1.0], + [2.0 2.0; 2.0 2.0], + [2.0 0.0; 0.0 0.0], + [1.0 1.0 0.0; 1.0 1.0 0.0; 0.0 0.0 1.0], + BigFloat[1.0 0.0; 0.0 2.0], + BigFloat[1.0 1.0; 1.0 1.0], + ] + I, J, V = MOI.Utilities.compute_sparse_sqrt(ext, SparseArrays.sparse(A)) + U = zeros(eltype(A), size(A)) + for (i, j, v) in zip(I, J, V) + U[i, j] += v + end + @test isapprox(A, U' * U; atol = 1e-10) + end + # Test failures + for A in Any[ + [-1.0 0.0; 0.0 1.0], + [0.0 -1.0; -1.0 0.0], + BigFloat[-1.0 0.0; 0.0 1.0], + ] + @test MOI.Utilities.compute_sparse_sqrt(ext, SparseArrays.sparse(A)) === + nothing + end + return +end + +function test_clique_trees_semidefinite_cholesky_fail() + inner = MOI.Utilities.Model{Float64}() + model = MOI.Bridges.Constraint.QuadtoSOC{Float64}(inner) + x = MOI.add_variables(model, 2) + f = 0.5 * x[1] * x[1] + 1.0 * x[1] * x[2] + 0.5 * x[2] * x[2] + c = MOI.add_constraint(model, f, MOI.LessThan(1.0)) + F, S = MOI.VectorAffineFunction{Float64}, MOI.RotatedSecondOrderCone + ci = only(MOI.get(inner, MOI.ListOfConstraintIndices{F,S}())) + g = MOI.get(inner, MOI.ConstraintFunction(), ci) + y = MOI.get(inner, MOI.ListOfVariableIndices()) + sum_y = 1.0 * y[1] + 1.0 * y[2] + @test isapprox(g, MOI.Utilities.vectorize([1.0, 1.0, sum_y, 0.0])) + return +end + +function test_clique_trees_early_zero_pivot() + # This matrix has an early zero pivot that causes LDLFactorizations to + # halt early, but CliqueTrees' pivoted Cholesky handles it correctly. + inner = MOI.Utilities.Model{Float64}() + model = MOI.Bridges.Constraint.QuadtoSOC{Float64}(inner) + x = MOI.add_variables(model, 3) + # (x[1] + x[2])^2 + x[3]^2 = x[1]^2 + 2*x[1]*x[2] + x[2]^2 + x[3]^2 + # Q = [1 1 0; 1 1 0; 0 0 1] + f = sum(0.5 * x[i] * x[i] for i in 1:3) + 1.0 * x[1] * x[2] + c = MOI.add_constraint(model, f, MOI.LessThan(1.0)) + F, S = MOI.VectorAffineFunction{Float64}, MOI.RotatedSecondOrderCone + ci = only(MOI.get(inner, MOI.ListOfConstraintIndices{F,S}())) + g = MOI.get(inner, MOI.ConstraintFunction(), ci) + # Verify the constraint was created successfully + @test MOI.output_dimension(g) == 5 # [1, rhs, Ux...] return end