ApproxFun.jl icon indicating copy to clipboard operation
ApproxFun.jl copied to clipboard

Documentation Requests

Open ChrisRackauckas opened this issue 7 years ago • 2 comments

Trying to copy everything over from our conversations to turn them into docs:

  • [x] TensorSpace
  • [ ] Legendre space
  • [ ] SplineSpace
  • [x] Jacobi
  • [ ] Getting non-lazy operators out, i.e. Ln = L[1:n,1:n]
  • [x] ArraySpace
  • [ ] view(L,1:n,1:n)
  • [ ] Projection of arrays to spaces (P = SpaceOperator(ConstantOperator(1.0), SequenceSpace(), space)). Probably for FAQ
  • [ ] "values(f) gives back the values on points(f)(values(f) == f.(points(f)))"
  • [ ] SpaceOperator
  • [ ] ConstantOperator
  • [ ] SequenceSpace
  • [ ] ~~DiskSpace~~ (It's in MultivariateOrthogonalPolynomials.jl)
  • [ ] ~~KoornwinderTriangle~~ (It's in MultivariateOrthogonalPolynomials.jl)

ChrisRackauckas avatar Jan 08 '18 15:01 ChrisRackauckas

LeftIntegral and RightIntegral? LeftIntegral is used in the Fractional Integral Equation example notebook but doesn't appear in the docs.

More generally, as a new user, I find level of the documentation way too high. The Homepage and the Linear Equations sections are the only thing that I found approachable. The processes of mapping a pencil-and-paper problem to an ApproxFun implementation remains opaque. For instance, after reading the docs, I can implement many differential and some integral operators, but how do I solve a straightforward transcendental algebraic equation? Maybe this is better addressed in the Examples repo, but this seemed like the more visible place to say something.

nshaffer avatar May 15 '18 15:05 nshaffer

LeftIntegral and RightIntegral? LeftIntegral is used in the Fractional Integral Equation example notebook but doesn't appear in the docs.

These are only really useful for fractional integro/differential equations, and should probably be moved out of ApproxFun into their own repository (JuliaApproximation/FractionalEquations.jl)

I find level of the documentation way too high.

Agreed, but writing documentation requires a lot of time that I don't have at the moment. Please file issues on anything that is particularly confusing.

how do I solve a straightforward transcendental algebraic equation?

This is done in the README:

x = Fun(identity,0..10)
f = sin(x^2)
g = cos(x)
roots(f + g^2) # returns all solutions to sin(x^2) + cos(x)^2 in 0 .. 10

dlfivefifty avatar May 16 '18 09:05 dlfivefifty