Skip to content

Commit 062f15e

Browse files
committed
add docs
1 parent 7f9fdac commit 062f15e

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

src/clenshaw.jl

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,9 @@ evaluates the orthogonal polynomial expansion with coefficients `c` at points `x
4949
where `A`, `B`, and `C` are `AbstractVector`s containing the recurrence coefficients
5050
as defined in DLMF,
5151
overwriting `x` with the results.
52+
53+
If `c` is a matrix this treats each column as a separate vector of coefficients, returning a vector
54+
if `x` is a number and a matrix if `x` is a vector.
5255
"""
5356
clenshaw!(c::AbstractVector, A::AbstractVector, B::AbstractVector, C::AbstractVector, x::AbstractVector) =
5457
clenshaw!(c, A, B, C, x, Ones{eltype(x)}(length(x)), x)
@@ -106,6 +109,9 @@ evaluates the orthogonal polynomial expansion with coefficients `c` at points `x
106109
where `A`, `B`, and `C` are `AbstractVector`s containing the recurrence coefficients
107110
as defined in DLMF.
108111
`x` may also be a single `Number`.
112+
113+
If `c` is a matrix this treats each column as a separate vector of coefficients, returning a vector
114+
if `x` is a number and a matrix if `x` is a vector.
109115
"""
110116

111117
function clenshaw(c::AbstractVector, A::AbstractVector, B::AbstractVector, C::AbstractVector, x::Number)

0 commit comments

Comments
 (0)