MOI to MatOI (#7)

* MOI to MatOI

* parameterize model; remove ConeData

* one more vector template for ConicForm

* in light of codecov

* update docs

* minor fix

* fix build

* fix build

* minor changes

* many minor changes

* switch to copy_to

* remove unused methods

* add suggestions

* removed unused dependencies

* fix dependencies

* coverage changes

* removed SCS specific scaling

Author: akshay326

Project.toml

@@ -14,7 +14,10 @@ MathOptInterface = "0.9"
 julia = "1"
 
 [extras]
+COSMO = "1e616198-aa4e-51ec-90a2-23f7fbd31d8d"
+ProxSDP = "65e78d25-6039-50a4-9445-38022e3d2eb3"
+SCS = "c946c3f1-0d1f-5ce8-9dea-7daa1f7e2d13"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [targets]
-test = ["Test"]
+test = ["Test","SCS","ProxSDP","COSMO"]

src/MatrixOptInterface.jl

@@ -5,6 +5,9 @@ using MathOptInterface
 const MOI = MathOptInterface
 const MOIU = MathOptInterface.Utilities
 
+const CI = MOI.ConstraintIndex
+const VI = MOI.VariableIndex
+
 # export MatrixOptimizer
 
 @enum ConstraintSense EQUAL_TO GREATER_THAN LESS_THAN INTERVAL
@@ -57,6 +60,8 @@ end
 
 @enum VariableType CONTINUOUS INTEGER BINARY
 
+include("sparse_matrix.jl")
+include("conic_form.jl")
 include("matrix_input.jl")
 include("change_form.jl")
 

src/conic_form.jl

@@ -0,0 +1,210 @@
+mutable struct ConicForm{T, AT, VT, C} <: MOI.ModelLike
+    num_rows::Vector{Int}
+    dimension::Dict{Int, Int}
+    sense::MOI.OptimizationSense
+    objective_constant::T # The objective
+    A::Union{Nothing, AT} # The constraints
+    b::VT          # `b - Ax in cones`
+    c::VT          # `sense c'x + objective_constant`
+    cone_types::C
+
+    function ConicForm{T, AT, VT}(cone_types) where {T, AT, VT}
+        model = new{T, AT, VT, typeof(cone_types)}()
+        model.cone_types = cone_types
+        model.num_rows = zeros(Int, length(cone_types))
+        model.dimension = Dict{Int, Int}()
+        model.A = nothing
+        return model
+    end
+end
+
+# The ordering of CONES matches SCS
+const CONES = Dict(
+    MOI.Zeros => 1,
+    MOI.Nonnegatives => 2,
+    MOI.SecondOrderCone => 3,
+    MOI.PositiveSemidefiniteConeTriangle => 4,
+    MOI.ExponentialCone => 5, 
+    MOI.DualExponentialCone => 6
+)
+
+_set_type(::MOI.ConstraintIndex{F,S}) where {F,S} = S
+cons_offset(conic::MOI.Zeros) = conic.dimension
+cons_offset(conic::MOI.Nonnegatives) = conic.dimension
+cons_offset(conic::MOI.SecondOrderCone) = conic.dimension
+cons_offset(conic::MOI.PositiveSemidefiniteConeTriangle) = Int64((conic.side_dimension*(conic.side_dimension+1))/2)
+
+function get_conic_form(::Type{T}, model::M, con_idx) where {T, M <: MOI.AbstractOptimizer}
+    # reorder constraints
+    cis = sort(
+        con_idx, 
+        by = x->CONES[_set_type(x)]
+    )
+
+    # extract cones
+    cones = _set_type.(cis)
+    cones = unique(cones)
+
+    conic = ConicForm{T, SparseMatrixCSRtoCSC{Int64}, Array{T, 1}}(Tuple(cones))
+
+    idxmap = MOI.copy_to(conic, model)
+
+    # fix optimization sense
+    if MOI.get(model, MOI.ObjectiveSense()) == MOI.MAX_SENSE
+        conic.c = -conic.c
+    end
+
+    return conic
+end
+
+MOI.is_empty(model::ConicForm) = model.A === nothing
+function MOI.empty!(model::ConicForm{T}) where T
+    empty!(model.dimension)
+    fill!(model.num_rows, 0)
+    model.A = nothing
+    model.sense = MOI.FEASIBILITY_SENSE
+    model.objective_constant = zero(T)
+end
+
+function _first(::Type{S}, idx::Int, ::Type{S}, args::Vararg{Type, N}) where {S, N}
+    return idx
+end
+function _first(::Type{S}, idx::Int, ::Type, args::Vararg{Type, N}) where {S, N}
+    return _first(S, idx + 1, args...)
+end
+_first(::Type, idx::Int) = nothing
+
+_findfirst(::Type{S}, sets::Tuple) where {S} = _first(S, 1, sets...)
+
+function MOI.supports_constraint(
+    model::ConicForm,
+    ::Type{MOI.VectorAffineFunction{Float64}},
+    ::Type{S}) where S <: MOI.AbstractVectorSet
+    return _findfirst(S, model.cone_types) !== nothing
+end
+
+function _allocate_variables(model::ConicForm{T, AT, VT}, vis_src, idxmap) where {T, AT, VT}
+    model.A = AT(length(vis_src))
+    for (i, vi) in enumerate(vis_src)
+        idxmap[vi] = MOI.VariableIndex(i)
+    end
+    return
+end
+
+function rows(model::ConicForm, ci::CI{MOI.VectorAffineFunction{Float64}})
+    return ci.value .+ (1:model.dimension[ci.value])
+end
+
+function MOI.set(::ConicForm, ::MOI.VariablePrimalStart,
+                 ::MOI.VariableIndex, ::Nothing)
+end
+function MOI.set(model::ConicForm, ::MOI.VariablePrimalStart,
+                 vi::MOI.VariableIndex, value::Float64)
+    model.primal[vi.value] = value
+end
+function MOI.set(::ConicForm, ::MOI.ConstraintPrimalStart,
+                 ::MOI.ConstraintIndex, ::Nothing)
+end
+function MOI.set(model::ConicForm, ::MOI.ConstraintPrimalStart,
+                 ci::MOI.ConstraintIndex, value)
+    offset = constroffset(model, ci)
+    model.slack[rows(model, ci)] .= value
+end
+function MOI.set(::ConicForm, ::MOI.ConstraintDualStart,
+                  ::MOI.ConstraintIndex, ::Nothing)
+end
+function MOI.set(model::ConicForm, ::MOI.ConstraintDualStart,
+                  ci::MOI.ConstraintIndex, value)
+    offset = constroffset(model, ci)
+    model.dual[rows(model, ci)] .= value
+end
+function MOI.set(model::ConicForm, ::MOI.ObjectiveSense, sense::MOI.OptimizationSense)
+    model.sense = sense
+end
+variable_index_value(t::MOI.ScalarAffineTerm) = t.variable_index.value
+variable_index_value(t::MOI.VectorAffineTerm) = variable_index_value(t.scalar_term)
+function MOI.set(model::ConicForm, ::MOI.ObjectiveFunction,
+                 f::MOI.ScalarAffineFunction{Float64})
+    c = Vector(sparsevec(variable_index_value.(f.terms), MOI.coefficient.(f.terms),
+                         model.A.n))
+    model.objective_constant = f.constant
+    model.c = c
+    return nothing
+end
+
+function _allocate_constraint(model::ConicForm, src, indexmap, cone_id, ci)
+    # TODO use `CanonicalConstraintFunction`
+    func = MOI.get(src, MOI.ConstraintFunction(), ci)
+    func = MOIU.is_canonical(func) ? func : MOI.Utilities.canonical(func)
+    allocate_terms(model.A, indexmap, func)
+    offset = model.num_rows[cone_id]
+    model.num_rows[cone_id] = offset + MOI.output_dimension(func)
+    return ci, offset, func
+end
+
+function _allocate_constraints(model::ConicForm, src, indexmap, cone_id, ::Type{S}) where S
+    cis = MOI.get(src, MOI.ListOfConstraintIndices{MOI.VectorAffineFunction{Float64}, S}())
+    return map(cis) do ci
+        _allocate_constraint(model, src, indexmap, cone_id, ci)
+    end
+end
+
+function _load_variables(model::ConicForm, nvars::Integer)
+    m = sum(model.num_rows)
+    model.A.m = m
+    model.b = zeros(m)
+    model.c = zeros(model.A.n)
+    allocate_nonzeros(model.A)
+end
+
+function _load_constraints(model::ConicForm, src, indexmap, cone_offset, i, cache)
+    for (ci_src, offset_in_cone, func) in cache
+        offset = cone_offset + offset_in_cone
+        set = MOI.get(src, MOI.ConstraintSet(), ci_src)
+        load_terms(model.A, indexmap, func, offset)
+        copyto!(model.b, offset + 1, func.constants)
+        model.dimension[offset] = MOI.output_dimension(func)
+        indexmap[ci_src] = typeof(ci_src)(offset)
+    end
+end
+
+function MOI.copy_to(dest::ConicForm, src::MOI.ModelLike; copy_names::Bool=true)
+    MOI.empty!(dest)
+
+    vis_src = MOI.get(src, MOI.ListOfVariableIndices())
+    idxmap = MOIU.IndexMap()
+
+    has_constraints = BitSet()
+    for (F, S) in MOI.get(src, MOI.ListOfConstraints())
+        i = _findfirst(S, dest.cone_types)
+        if i === nothing || F != MOI.VectorAffineFunction{Float64}
+            throw(MOI.UnsupportedConstraint{F, S}())
+        end
+        push!(has_constraints, i)
+    end
+
+    _allocate_variables(dest, vis_src, idxmap)
+
+    # Allocate constraints
+    caches = map(collect(has_constraints)) do i
+        _allocate_constraints(dest, src, idxmap, i, dest.cone_types[i])
+    end
+
+    # Load variables
+    _load_variables(dest, length(vis_src))
+
+    # Set variable attributes
+    MOIU.pass_attributes(dest, src, copy_names, idxmap, vis_src)
+
+    # Set model attributes
+    MOIU.pass_attributes(dest, src, copy_names, idxmap)
+
+    # Load constraints
+    offset = 0
+    for (i, cache) in zip(has_constraints, caches)
+        _load_constraints(dest, src, idxmap, offset, i, cache)
+        offset += dest.num_rows[i]
+    end
+
+    return idxmap
+end

src/sparse_matrix.jl

@@ -0,0 +1,44 @@
+mutable struct SparseMatrixCSRtoCSC{T}
+    m::Int # Number of rows
+    n::Int # Number of columns
+    colptr::Vector{T}
+    rowval::Vector{T}
+    nzval::Vector{Float64}
+    function SparseMatrixCSRtoCSC{T}(n) where T
+        A = new()
+        A.n = n
+        A.colptr = zeros(T, n + 1)
+        return A
+    end
+end
+function allocate_nonzeros(A::SparseMatrixCSRtoCSC{T}) where T
+    for i in 3:length(A.colptr)
+        A.colptr[i] += A.colptr[i - 1]
+    end
+    A.rowval = Vector{T}(undef, A.colptr[end])
+    A.nzval = Vector{Float64}(undef, A.colptr[end])
+end
+function final_touch(A::SparseMatrixCSRtoCSC)
+    for i in length(A.colptr):-1:2
+        A.colptr[i] = A.colptr[i - 1]
+    end
+    A.colptr[1] = 0
+end
+function _allocate_terms(colptr, indexmap, terms)
+    for term in terms
+        colptr[indexmap[term.scalar_term.variable_index].value + 1] += 1
+    end
+end
+function allocate_terms(A::SparseMatrixCSRtoCSC, indexmap, func)
+    _allocate_terms(A.colptr, indexmap, func.terms)
+end
+function _load_terms(colptr, rowval, nzval, indexmap, terms, offset)
+    for term in terms
+        ptr = colptr[indexmap[term.scalar_term.variable_index].value] += 1
+        rowval[ptr] = offset + term.output_index - 1
+        nzval[ptr] = -term.scalar_term.coefficient
+    end
+end
+function load_terms(A::SparseMatrixCSRtoCSC, indexmap, func, offset)
+    _load_terms(A.colptr, A.rowval, A.nzval, indexmap, func.terms, offset)
+end