From f01562e37f28b276c6df22d143f924c01d36670c Mon Sep 17 00:00:00 2001 From: Alinson S Xavier Date: Sun, 30 May 2021 07:58:53 -0500 Subject: [PATCH] Update docs --- src/model/build.jl | 33 +++------------------------------ 1 file changed, 3 insertions(+), 30 deletions(-) diff --git a/src/model/build.jl b/src/model/build.jl index 7e7259c..aae1223 100644 --- a/src/model/build.jl +++ b/src/model/build.jl @@ -8,10 +8,6 @@ import JuMP: value, fix, set_name """ function build_model(; instance::UnitCommitmentInstance, - isf::Union{Matrix{Float64},Nothing} = nothing, - lodf::Union{Matrix{Float64},Nothing} = nothing, - isf_cutoff::Float64 = 0.005, - lodf_cutoff::Float64 = 0.001, optimizer = nothing, variable_names::Bool = false, )::JuMP.Model @@ -20,38 +16,15 @@ Build the JuMP model corresponding to the given unit commitment instance. Arguments ========= -- `instance::UnitCommitmentInstance`: +- `instance`: the instance. -- `isf::Union{Matrix{Float64},Nothing} = nothing`: - the injection shift factors matrix. If not provided, it will be computed. -- `lodf::Union{Matrix{Float64},Nothing} = nothing`: - the line outage distribution factors matrix. If not provided, it will be - computed. -- `isf_cutoff::Float64 = 0.005`: - the cutoff that should be applied to the ISF matrix. Entries with magnitude - smaller than this value will be set to zero. -- `lodf_cutoff::Float64 = 0.001`: - the cutoff that should be applied to the LODF matrix. Entries with magnitude - smaller than this value will be set to zero. -- `optimizer = nothing`: +- `optimizer`: the optimizer factory that should be attached to this model (e.g. Cbc.Optimizer). If not provided, no optimizer will be attached. -- `variable_names::Bool = false`: +- `variable_names`: If true, set variable and constraint names. Important if the model is going to be exported to an MPS file. For large models, this can take significant time, so it's disabled by default. - -Example -======= -```jldoctest -julia> import Cbc, UnitCommitment -julia> instance = UnitCommitment.read_benchmark("matpower/case118/2017-02-01") -julia> model = UnitCommitment.build_model( - instance=instance, - optimizer=Cbc.Optimizer, - variable_names=true, -) -``` """ function build_model(; instance::UnitCommitmentInstance,