Docstring.

Author: samuelsonric

README.md

@@ -27,16 +27,16 @@ julia> function construct_model(f, name::String)
            set_silent(model)
            @variable(model, x[1:m])
            @objective(model, Min, c' * x)
-           @constraint(model, con1,  Symmetric(-Matrix(F[1]) + sum(Matrix(F[k + 1]) .* x[k] for k in 1:m)) in JuMP.PSDCone())
-           return model
+           @constraint(model, con, Symmetric(-Matrix(F[1]) + sum(Matrix(F[k + 1]) .* x[k] for k in 1:m)) in JuMP.PSDCone())
+           return model, con
        end
 construct_model (generic function with 1 method)
 ```
 
 Solve the problem using the [Mosek.jl](https://github.com/MOSEK/Mosek.jl) optimizer.
 
 ```julia-repl
-julia> model = construct_model(Mosek.Optimizer, "mcp124-1");
+julia> model, con = construct_model(Mosek.Optimizer, "mcp124-1");
 
 julia> @time JuMP.optimize!(model)
   6.005076 seconds (2.53 k allocations: 515.859 KiB)
@@ -48,7 +48,7 @@ julia> objective_value(model)
 Solve the problem using [Mosek.jl](https://github.com/MOSEK/Mosek.jl) and MathOptChordalDecomposition.jl.
 
 ```julia-repl
-julia> model = construct_model(() -> MOCD.Optimizer(Mosek.Optimizer), "mcp124-1");
+julia> model, con = construct_model(() -> MOCD.Optimizer(Mosek.Optimizer), "mcp124-1");
 
 julia> @time JuMP.optimize!(model)
   0.041175 seconds (230.72 k allocations: 11.800 MiB)

src/MathOptChordalDecomposition.jl

@@ -17,7 +17,17 @@ struct Decomposition
 end
 
 """
-    Optimizer(inner; alg::EliminationAlgorithm=MF())
+    Optimizer <: MOI.AbstractOptimizer
+
+    Optimizer(inner::MOI.AbstractOptimizer; alg::CliqueTrees.EliminationAlgorithm=MF())
+
+An optimizer that computes a chordal decomposition of each semidefinite constraint.
+The elimination algorithm `alg` is used to compute the decomposition, and the optimizer
+`inner` is used to solve the decomposed problem.
+
+### Parameters
+  - `inner`: inner optimizer
+  - `alg`: elimination algorithm
 """
 mutable struct Optimizer{A <: EliminationAlgorithm} <: MOI.AbstractOptimizer
     inner::MOI.AbstractOptimizer