Skip to content

expand docstring of lowrankfun #231

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 5, 2022
Merged

expand docstring of lowrankfun #231

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion src/Multivariate/LowRankFun.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,13 @@ export LowRankFun
"""
LowRankFun(f, space::TensorSpace)

Return an approximation to a bivariate function in low rank form.
Return an approximation to a bivariate function in a low-rank form
```math
f(x,y) = \\sum_i \\sigma_i \\phi_i(x) \\psi_i(y)
```
where ``\\sigma_i`` represent the highest singular values,
and ``\\phi_i(x)`` and ``\\psi_i(y)`` are orthogonal bases. The summation is truncated
after an acceptable tolerance is reached.

# Examples
```jldoctest
Expand Down