Skip to content

Commit 15c4246

Browse files
committed
Update docstring.
1 parent 99544a5 commit 15c4246

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

src/sets.jl

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,21 @@ abstract type AbstractSet end
1010
"""
1111
dimension(s::AbstractSet)
1212
13-
Return the underlying dimension (number of vector components) in the set `s`, i.e.,
14-
``n`` if the set is a subset of ``\\mathbb{R}^n``.
13+
Return the output dimension that an [`AbstractFunction`](@ref) should have to be used with the set `s`.
14+
15+
### Examples
16+
17+
```julia-repl
18+
julia> dimension(Reals(4))
19+
4
20+
21+
julia> dimension(LessThan(3.0))
22+
1
23+
24+
julia> dimension(PositiveSemidefiniteConeTriangle(2))
25+
3
26+
```
27+
1528
"""
1629
function dimension end
1730

0 commit comments

Comments
 (0)