Update

Author: odow

ext/MathOptInterfaceCliqueTreesExt.jl

@@ -11,10 +11,10 @@ import LinearAlgebra
 import MathOptInterface as MOI
 import SparseArrays
 
-MOI.Bridges.Constraint.is_defined(::MOI.Bridges.Constraint.CliqueTrees) = true
+MOI.Bridges.Constraint.is_defined(::MOI.Bridges.Constraint._CliqueTrees) = true
 
-function MOI.Bridges.Constraint.compute_sparse_sqrt(
-    ::MOI.Bridges.Constraint.CliqueTrees,
+function MOI.Bridges.Constraint._compute_sparse_sqrt(
+    ::MOI.Bridges.Constraint._CliqueTrees,
     Q::AbstractMatrix,
 )
     G = LinearAlgebra.cholesky!(

src/Bridges/Constraint/bridges/QuadtoSOCBridge.jl

@@ -60,17 +60,17 @@ end
 const QuadtoSOC{T,OT<:MOI.ModelLike} =
     SingleBridgeOptimizer{QuadtoSOCBridge{T},OT}
 
-abstract type AbstractExt end
+abstract type _AbstractExt end
 
-is_defined(::AbstractExt) = false
+is_defined(::_AbstractExt) = false
 
-struct CliqueTrees <: AbstractExt end
+struct _CliqueTrees <: _AbstractExt end
 
-struct LinearAlgebraExt <: AbstractExt end
+struct _LinearAlgebra <: _AbstractExt end
 
-is_defined(::LinearAlgebraExt) = true
+is_defined(::_LinearAlgebra) = true
 
-function compute_sparse_sqrt(::LinearAlgebraExt, Q::AbstractMatrix)
+function _compute_sparse_sqrt(::_LinearAlgebra, Q::AbstractMatrix)
     factor = LinearAlgebra.cholesky(Q; check = false)
     if !LinearAlgebra.issuccess(factor)
         return nothing
@@ -85,7 +85,7 @@ function compute_sparse_sqrt(::LinearAlgebraExt, Q::AbstractMatrix)
 end
 
 """
-    compute_sparse_sqrt(Q::AbstractMatrix)
+    _compute_sparse_sqrt(Q::AbstractMatrix)
 
 Attempts to compute a sparse square root such that `Q = A' * A`.
 
@@ -101,20 +101,20 @@ If unsuccessful, this function returns `nothing`.
 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`.
+These extension packages must be loaded before calling `_compute_sparse_sqrt`.
 
 The extensions currently supported are:
 
  * The pivoted Cholesky in `CliqueTrees.jl`
 """
-function compute_sparse_sqrt(Q::AbstractMatrix)
+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(), CliqueTrees())
+    for ext in (_LinearAlgebra(), _CliqueTrees())
         if is_defined(ext)
             try
-                if (ret = compute_sparse_sqrt(ext, Q)) !== nothing
+                if (ret = _compute_sparse_sqrt(ext, Q)) !== nothing
                     return ret
                 end
             catch
@@ -175,7 +175,7 @@ function bridge_constraint(
             MOI.ScalarAffineTerm(scale * term.coefficient, term.variable),
         ) for term in func.affine_terms
     ]
-    sqrt_ret = compute_sparse_sqrt(LinearAlgebra.Symmetric(Q))
+    sqrt_ret = _compute_sparse_sqrt(LinearAlgebra.Symmetric(Q))
     if sqrt_ret === nothing
         msg = _get_sqrt_error_message(is_defined(CliqueTrees()))
         return throw(MOI.UnsupportedConstraint{typeof(func),typeof(set)}(msg))

test/Bridges/Constraint/test_QuadtoSOCBridge.jl

@@ -341,13 +341,13 @@ function test_semidefinite_cholesky_fail()
 end
 
 function test_linear_algebra_compute_sparse_sqrt_edge_cases()
-    ext = MOI.Bridges.Constraint.LinearAlgebraExt()
+    ext = MOI.Bridges.Constraint._LinearAlgebra()
     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],
     ]
         Q = SparseArrays.sparse(A)
-        I, J, V = MOI.Bridges.Constraint.compute_sparse_sqrt(ext, Q)
+        I, J, V = MOI.Bridges.Constraint._compute_sparse_sqrt(ext, Q)
         U = zeros(eltype(A), size(A))
         for (i, j, v) in zip(I, J, V)
             U[i, j] += v
@@ -361,13 +361,13 @@ function test_linear_algebra_compute_sparse_sqrt_edge_cases()
         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.Bridges.Constraint.compute_sparse_sqrt(ext, A) === nothing
+        @test MOI.Bridges.Constraint._compute_sparse_sqrt(ext, A) === nothing
     end
     return
 end
 
 function test_clique_trees_compute_sparse_sqrt_edge_cases()
-    ext = MOI.Bridges.Constraint.CliqueTrees()
+    ext = MOI.Bridges.Constraint._CliqueTrees()
     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],
@@ -379,7 +379,7 @@ function test_clique_trees_compute_sparse_sqrt_edge_cases()
         BigFloat[1.0 1.0; 1.0 1.0],
     ]
         Q = SparseArrays.sparse(A)
-        I, J, V = MOI.Bridges.Constraint.compute_sparse_sqrt(ext, Q)
+        I, J, V = MOI.Bridges.Constraint._compute_sparse_sqrt(ext, Q)
         U = zeros(eltype(A), size(A))
         for (i, j, v) in zip(I, J, V)
             U[i, j] += v
@@ -393,7 +393,7 @@ function test_clique_trees_compute_sparse_sqrt_edge_cases()
         BigFloat[-1.0 0.0; 0.0 1.0],
     ]
         Q = SparseArrays.sparse(A)
-        @test MOI.Bridges.Constraint.compute_sparse_sqrt(ext, Q) === nothing
+        @test MOI.Bridges.Constraint._compute_sparse_sqrt(ext, Q) === nothing
     end
     return
 end
@@ -410,7 +410,7 @@ function test_compute_sparse_sqrt_edge_cases()
         BigFloat[1.0 1.0; 1.0 1.0],
     ]
         Q = SparseArrays.sparse(A)
-        I, J, V = MOI.Bridges.Constraint.compute_sparse_sqrt(Q)
+        I, J, V = MOI.Bridges.Constraint._compute_sparse_sqrt(Q)
         U = zeros(eltype(A), size(A))
         for (i, j, v) in zip(I, J, V)
             U[i, j] += v
@@ -424,7 +424,7 @@ function test_compute_sparse_sqrt_edge_cases()
         BigFloat[-1.0 0.0; 0.0 1.0],
     ]
         Q = SparseArrays.sparse(A)
-        @test MOI.Bridges.Constraint.compute_sparse_sqrt(Q) === nothing
+        @test MOI.Bridges.Constraint._compute_sparse_sqrt(Q) === nothing
     end
     return
 end
@@ -470,14 +470,14 @@ function test_clique_trees_error_message()
     return
 end
 
-struct _DummyCliqueTrees <: MOI.Bridges.Constraint.AbstractExt end
+struct _DummyCliqueTrees <: MOI.Bridges.Constraint._AbstractExt end
 
 function test_is_defined_default_fallback()
     @test !MOI.Bridges.Constraint.is_defined(_DummyCliqueTrees())
     Q = ones(2, 2)
     @test_throws(
         MethodError,
-        MOI.Bridges.Constraint.compute_sparse_sqrt(_DummyCliqueTrees(), Q),
+        MOI.Bridges.Constraint._compute_sparse_sqrt(_DummyCliqueTrees(), Q),
     )
     return
 end