ra-ra/TODO

RA -*- mode: org; -*-

help: [C-uc .] insert timestamp [C-cc] flip checkbox [C-uucc] partial flip [M-RET] continue list
checkbox [C-ct] flip TODO

#+STARTUP: logdone

* TODO [1/7]
  - [-] Bugs [2/10]
    - [ ] const issues in View vs Container
      - [ ] fix conversion to const op in View, or
      - [ ] fix view() members in Container not to depend on conversion to const op in view (make View a member union??)
      - [ ] fix SmallView/SmallArray after the same pattern
      - [ ] fix RA_DEF_ASSIGNOPS return type and reuse that and RA_DEF_ASSIGNOPS_SELF in View
    - [ ] ra::Small<real, 3, 3, 3>() benchmark in bench-dot.cc has op 10x worse
      than indexed
      - Fixed in ca20c1678bb7aa43ccf6b4fe1b93ee9c742b1630. Yay!
      - Appears to have regressed in 65076211eeeeecd8623877e3e3b5cc0a87af302c, although by a smaller factor. Bummer.
    - [X] size_s, rank_s in Ryn:: are broken [ra7]
    - [X] broken with -DNDEBUG (95ac2014bfd86cbc27e3d151f55abaceef628de4 and by <2023-05-26 Fri 15:08> in CI)
    - [ ] ambiguity / bad init in nested constructors [ra45]
    - [ ] subscripting inconsistencies; for example, if `A` is rank>1 and `i` is
      rank 1, then `A(i)` will return a nested expression instead of preserving
      `A`'s rank.
    - [ ] beatable subscripts are not beaten if mixed with non-beatable
      subscripts. E.g. in A(vector, iota, vector) the iota isn't beaten.
    - [ ] be namespace clean except for possibly complex.hh.
    - [ ] make iter work with w/rank.
    - [ ] make iter work with foreign vectors.
  - [-] Features [1/7]
    - [ ] Merge Ptr and Iota. We should only need one rank 1 IteratorConcept adaptor.
    - [-] Deduction guides, e.g. ra::Small a = {{1, 2}, {3, 4}} ?! maybe rank 1 first
      - [X] rank 1 SmallArray <2023-06-23 Fri 13:24> (not very useful)
      - [ ] rank >1 SmallArray
      - [ ] Small
      - [ ] Big
    - [ ] Should be able to reshape iota (??) or show examples with TensorIndex,
      maybe. One idea is to generalize View (so View<Iota>, etc.) which is
      something that newra does. But as long as Container is parent of View,
      conversion of (Container const &) into (View const &) forces us to have
      const/nonconst overloads in View (instead of just relying on the constness
      of (View::p). This is just a mess when View::p isn't a pointer.
      - [ ] Fix relationship between Container and View [0/5]
        - [ ] forward const/nonconst overloads to View or ViewConst from here.
        - [ ] remove inheritance relationship of Container on View
        - [ ] add const/nonconst casts of Container to View or ViewConst
        - [ ] remove const overloads from View::operator()
        - [ ] make View be View<pointer> and not View<value_type>
    - [ ] Should be able to turn ravel iterators (e.g. View::begin()) into array
      iterators. Ptr() doesn't work for that. Or to obtain STLIterator from any
      array iterator. That may come of merging STLIterator with
      ply_index/ply_ravel.
    - [ ] gemv(conj(a), b) should work. Beat View-like selectors down an Expr??
    - [ ] port some of the View ops to generic Iterator. reverse,
          transpose, etc. seem easy enough. Only it kind of bothers me that they
          need their own Expr-like types while on Views it's just a one time
          op. Propagating ops down Expr into leaf Views (a kind of beating) would be
          better.
    - [X] Support operator <=> <2020-09-15 Tue 13:50>
      - https://gcc.gnu.org/bugzilla/show_bug.cgi?id=96278 is annoying
  - [ ] Performance [0/1]
    - [ ] bench/bench-stencil* is weird.
  - [X] Error report, debugging [3/3]
    - [X] Optionally throw instead of abort on bounds checks, etc. cf. test/ra-12.cc
      * This was fixed between v8 and v10, see examples/throw.cc.
    - [X] Static check on Small constructors e.g. real3 {1, 2, 3}. Cf big.hh:513 init<SS>(SS const & s).
      - [X] for Container constructors
      - [X] for Small constructors
    - [X] General static check on prefix matching <2019-02-06 Wed 12:06>
  - [-] Building, tests [3/6]
    - [X] Build docs with cmake
    - [X] Support RA_USE_BLAS with cmake (linux)
    - [X] Support RA_USE_BLAS with cmake (mac) <2018-12-07 Fri 16:33>
    - [ ] Make cmake tests respect dependences and able to be run independently.
    - [ ] Test for expected compilation errors (static_assert, etc) [ra42].
    - [ ] TestRecorder.test_eq with mismatched shapes aborts. Should just fail the test.
  - [ ] Documentation [0/3]
    - [ ] Complete section on internals
    - [ ] Complete section on other languages, libraries
    - [ ] Describe xreferenced issues in doc ([raxx], etc.)
  - [ ] Other [0/2]
    - [ ] Review Container constructors. Why do we need (&) when we have (const &)?
    - [ ] Support tuple as a kind of foreign vector
      - [ ] Iterator type for tuple (like Vector for std::vector).
      - [ ] Appropriate ply. Possibly restrict it to rank 1.

Will stop reusing issue numbers so I can keep the record. Some of these aren't bugs in the sense that I expect to solve them, but more like footnotes.

* Numbered issues throughout the source [ra...]
  1. [ ]
  2. [ ] test/compatibility.cc, ra/atom.hh, ra/bootstrap.hh
     ra::vector(rank 1 builtin array) should be the same as ra::start(), that is static sizes shouldn't be lost.
  3. [ ]
  4. [ ] test/optimize.cc
     Expression objects only keep pointers to data objects. This means that it is unsafe to define expression objects unless none of the data objects are temporaries. E.g. `auto e = temp + temp;` is unsafe. Either `obj a; obj b; auto e = a + b;` or `obj o = temp + temp;` is safe. Generally there's no reason to ever define expression objects explicitly.
  5. [ ]
  6. [ ]
  7. [ ]
  8. [ ] test/operators.cc
     Some simple expressions with scalars fail in *FLAT(). The patch in operators.hh triggers the address sanitizer in test/ra-9.cc.
  9. [ ] test/ra-6.cc
     ra::Ptr doesn't hold copies. This enables restarting (see [ra39]), so ra::vector(temp) must only be used as temp. Really forbidding auto ll = ra::vector(lvalue) would also be ok.
  10. [ ] test/ra-0.cc
     size(SmallArray) requires ra:: to avoid collision with std::size, but not size(Big) (??).
  11. [ ]
  12. [ ]
  13. [ ] ra/io.hh, ra/atom.hh, ra/bootstrap.hh, test/compatibility.cc.
      std::string used to be registered as scalar, but that clashes with how std::ranges sees it. OTOH we don't want format(std::string_view) to print it as a foreign vector, so we have an exception for it there. As things stand, you can register it or not.
  14. [ ] CellBig needs to copy its Dimv in some cases, which also complicates View::iter<>. Problem is demonstrated in ra-5.cc.
  15. [ ] Conversion-to-scalar operators for dynamic-rank View().
  16. [ ]
  17. [ ]
  18. [ ]
  19. [ ]
  20. [ ]
  21. [ ]
  22. [ ]
  23. [ ]
  24. [ ]
  25. [ ]
  26. [ ]
  27. [ ]
  28. [ ]
  29. [ ]
  30. [ ]
  31. [ ]
  32. [ ]
  33. [ ]
  34. [ ]
  35. [ ]
  36. [ ]
  37. [ ]
  38. [ ]
  39. [ ] test/ra-7.cc
      There's no reason to restart, since the Iterator methods are all static. So start(ra::Scalar) just forwards. But that means that Scalar::c maintain constness, so a const overload is required for ScalarFlat::operator*.
  40. [ ]
  41. [ ]
  42. [ ] Ways to test that compile time assertions or constraints are triggered appropriately, esp. for things like ct array lookup.  Some are doable with concepts, see e.g. ra-14.cc or big-0.cc.
  43. [ ] bench/bench-dot.cc
      The performace of f_small_op depends on the optimization in plyf() through ocd<>(). Doing this required having static and non-static versions of Iterator::keep_step in Match/Expr. Possibly the same could be done to reduce rank/rank_s, size/size_s to just rank/size, and check for static-ness instead of RANK_ANY/DIM_ANY.
  44. [ ]
  45. [ ]
  46. [ ]
  47. [ ] ra/big.hh, test/const.cc, ra/view-ops.hh ...
      Review constness in ra/view-ops.hh after the Big/View const fixes after 913d6b531801609cb61bb7f631ddf50de701a802.