Skip to content

Commit

Permalink
[docs] add links in SecondOrderCone docstring (#3927)
Browse files Browse the repository at this point in the history
  • Loading branch information
odow authored Jan 26, 2025
1 parent 162b038 commit 0cce7a0
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions src/sets.jl
Original file line number Diff line number Diff line change
Expand Up @@ -98,12 +98,14 @@ end
SecondOrderCone
Second order cone object that can be used to constrain the euclidean norm of a
vector `x` to be less than or equal to a nonnegative scalar `t`. This is a
shortcut for the `MOI.SecondOrderCone`.
vector `x` to be less than or equal to a nonnegative scalar `t`.
This is a shortcut for the [`MOI.SecondOrderCone`](@ref) set.
## Example
The following constrains ``\\|(x-1, x-2)\\|_2 \\le t`` and ``t \\ge 0``:
```jldoctest
julia> model = Model();
Expand All @@ -125,8 +127,9 @@ moi_set(::SecondOrderCone, dim::Int) = MOI.SecondOrderCone(dim)
Rotated second order cone object that can be used to constrain the square of the
euclidean norm of a vector `x` to be less than or equal to ``2tu`` where `t` and
`u` are nonnegative scalars. This is a shortcut for the
`MOI.RotatedSecondOrderCone`.
`u` are nonnegative scalars.
This is a shortcut for the [`MOI.RotatedSecondOrderCone`](@ref) set.
## Example
Expand Down

0 comments on commit 0cce7a0

Please sign in to comment.