search

sethaxen / ExponentialAction.jl

Compute the action of the matrix exponential
MIT License
24 stars 0 forks source link

Increase clarity of code #12

Closed sethaxen closed 2 years ago

sethaxen commented 2 years ago

This PR increases the clarity of the code. In particular, it replaces the terse symbols like s and m used in the paper with more descriptive variable names, along with comments and docstrings to explain the algorithmic steps. These improvements will make it easier to implement new features.

This PR is currently blocked by https://github.com/JuliaDiff/ReverseDiff.jl/pull/198 and https://github.com/JuliaDiff/ForwardDiff.jl/pull/581

codecov[bot] commented 2 years ago

Codecov Report

Merging #12 (0ad6098) into main (d2a5e44) will increase coverage by 1.29%. The diff coverage is 100.00%.

@@             Coverage Diff             @@
##             main       #12      +/-   ##
===========================================
+ Coverage   98.70%   100.00%   +1.29%     
===========================================
  Files           4         4              
  Lines          77        78       +1     
===========================================
+ Hits           76        78       +2     
+ Misses          1         0       -1
Impacted Files Coverage Δ
src/expv.jl 100.00% <100.00%> (ø)
src/parameters.jl 100.00% <100.00%> (+2.50%) :arrow_up:
src/util.jl 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update d2a5e44...0ad6098. Read the comment docs.