Skip to content

Commit c496497

Browse files
authored
Add SpaceOperator docstring (#380)
1 parent 25fb1d8 commit c496497

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

src/Operators/spacepromotion.jl

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,26 @@
11
export
22

3+
"""
4+
SpaceOperator
5+
6+
`SpaceOperator` is used to wrap other operators
7+
and change the domain/range space.
8+
This is purely a wrapper. No checks are performed to assess
9+
the compatibility of spaces, and no conversions are performed.
10+
11+
# Examples
12+
```jldoctest
13+
julia> C = Conversion(Chebyshev(), Ultraspherical(0.5));
314
4-
## Space Operator is used to wrap other operators
5-
# and change the domain/range space
15+
julia> S = ApproxFunBase.SpaceOperator(C, Chebyshev(), Legendre());
16+
17+
julia> rangespace(S)
18+
Legendre()
19+
20+
julia> domainspace(S)
21+
Chebyshev()
22+
```
23+
"""
624
struct SpaceOperator{O<:Operator,S<:Space,V<:Space,T} <: Operator{T}
725
op::O
826
domainspace::S

0 commit comments

Comments
 (0)