Dual Model
Index
CTModels.boundary_constraints_dual
CTModels.control_constraints_lb_dual
CTModels.control_constraints_ub_dual
CTModels.dual
CTModels.path_constraints_dual
CTModels.state_constraints_lb_dual
CTModels.state_constraints_ub_dual
CTModels.variable_constraints_lb_dual
CTModels.variable_constraints_ub_dual
Documentation
CTModels.boundary_constraints_dual
— Methodboundary_constraints_dual(
model::CTModels.DualModel{<:Union{Nothing, Function}, BC_Dual<:Union{Nothing, AbstractVector{<:Real}}}
) -> Union{Nothing, AbstractVector{<:Real}}
Return the dual vector associated with the boundary constraints.
Arguments
model::DualModel
: A model including dual variables for boundary constraints.
Returns
A vector of dual values, or nothing
if not set.
CTModels.control_constraints_lb_dual
— Methodcontrol_constraints_lb_dual(
model::CTModels.DualModel{<:Union{Nothing, Function}, <:Union{Nothing, AbstractVector{<:Real}}, <:Union{Nothing, Function}, <:Union{Nothing, Function}, CC_LB_Dual<:Union{Nothing, Function}}
) -> Union{Nothing, Function}
Return the dual function associated with the lower bounds of control constraints.
Arguments
model::DualModel
: A model including dual variables for control lower bounds.
Returns
A function mapping time t
to a vector of dual values, or nothing
if not set.
CTModels.control_constraints_ub_dual
— Methodcontrol_constraints_ub_dual(
model::CTModels.DualModel{<:Union{Nothing, Function}, <:Union{Nothing, AbstractVector{<:Real}}, <:Union{Nothing, Function}, <:Union{Nothing, Function}, <:Union{Nothing, Function}, CC_UB_Dual<:Union{Nothing, Function}}
) -> Union{Nothing, Function}
Return the dual function associated with the upper bounds of control constraints.
Arguments
model::DualModel
: A model including dual variables for control upper bounds.
Returns
A function mapping time t
to a vector of dual values, or nothing
if not set.
CTModels.dual
— Methoddual(
sol::CTModels.Solution,
model::CTModels.Model,
label::Symbol
) -> Any
Return the dual variable associated with a constraint identified by its label
.
Searches through all constraint types (path, boundary, state, control, and variable constraints) defined in the model and returns the corresponding dual value from the solution.
Arguments
sol::Solution
: Solution object containing dual variables.model::Model
: Model containing constraint definitions.label::Symbol
: Symbol corresponding to a constraint label.
Returns
A function of time t
for time-dependent constraints, or a scalar/vector for time-invariant duals. If the label is not found, throws an IncorrectArgument
exception.
CTModels.path_constraints_dual
— Methodpath_constraints_dual(
model::CTModels.DualModel{PC_Dual<:Union{Nothing, Function}}
) -> Union{Nothing, Function}
Return the dual function associated with the nonlinear path constraints.
Arguments
model::DualModel
: A model including dual variables for path constraints.
Returns
A function mapping time t
to the vector of dual values, or nothing
if not set.
CTModels.state_constraints_lb_dual
— Methodstate_constraints_lb_dual(
model::CTModels.DualModel{<:Union{Nothing, Function}, <:Union{Nothing, AbstractVector{<:Real}}, SC_LB_Dual<:Union{Nothing, Function}}
) -> Union{Nothing, Function}
Return the dual function associated with the lower bounds of state constraints.
Arguments
model::DualModel
: A model including dual variables for state lower bounds.
Returns
A function mapping time t
to a vector of dual values, or nothing
if not set.
CTModels.state_constraints_ub_dual
— Methodstate_constraints_ub_dual(
model::CTModels.DualModel{<:Union{Nothing, Function}, <:Union{Nothing, AbstractVector{<:Real}}, <:Union{Nothing, Function}, SC_UB_Dual<:Union{Nothing, Function}}
) -> Union{Nothing, Function}
Return the dual function associated with the upper bounds of state constraints.
Arguments
model::DualModel
: A model including dual variables for state upper bounds.
Returns
A function mapping time t
to a vector of dual values, or nothing
if not set.
CTModels.variable_constraints_lb_dual
— Methodvariable_constraints_lb_dual(
model::CTModels.DualModel{<:Union{Nothing, Function}, <:Union{Nothing, AbstractVector{<:Real}}, <:Union{Nothing, Function}, <:Union{Nothing, Function}, <:Union{Nothing, Function}, <:Union{Nothing, Function}, VC_LB_Dual<:Union{Nothing, AbstractVector{<:Real}}}
) -> Union{Nothing, AbstractVector{<:Real}}
Return the dual vector associated with the lower bounds of variable constraints.
Arguments
model::DualModel
: A model including dual variables for variable lower bounds.
Returns
A vector of dual values, or nothing
if not set.
CTModels.variable_constraints_ub_dual
— Methodvariable_constraints_ub_dual(
model::CTModels.DualModel{<:Union{Nothing, Function}, <:Union{Nothing, AbstractVector{<:Real}}, <:Union{Nothing, Function}, <:Union{Nothing, Function}, <:Union{Nothing, Function}, <:Union{Nothing, Function}, <:Union{Nothing, AbstractVector{<:Real}}, VC_UB_Dual<:Union{Nothing, AbstractVector{<:Real}}}
) -> Union{Nothing, AbstractVector{<:Real}}
Return the dual vector associated with the upper bounds of variable constraints.
Arguments
model::DualModel
: A model including dual variables for variable upper bounds.
Returns
A vector of dual values, or nothing
if not set.