cairo_native icon indicating copy to clipboard operation
cairo_native copied to clipboard

Improve documentation and minor refactors.

Open azteca1998 opened this issue 1 year ago • 2 comments

This PR makes it so that everything public is documented. It also implements a few refactors, mostly to reduce the amount of stuff to document.

Checklist

  • [ ] Linked to Github Issue
  • [ ] Unit tests added
  • [ ] Integration tests added.
  • [ ] This change requires new documentation.
    • [ ] Documentation has been added/updated.

azteca1998 avatar Feb 21 '24 10:02 azteca1998

Benchmarking results

Benchmark for program factorial_2M

Open benchmarks
Command Mean [s] Min [s] Max [s] Relative
Cairo-vm (Rust, Cairo 1) 12.994 ± 0.082 12.909 13.181 29.90 ± 0.20
cairo-native (embedded AOT) 2.398 ± 0.011 2.381 2.410 5.52 ± 0.03
cairo-native (embedded JIT using LLVM's ORC Engine) 1.592 ± 0.013 1.570 1.614 3.66 ± 0.03
cairo-native (standalone AOT) 0.660 ± 0.001 0.658 0.660 1.52 ± 0.00
cairo-native (standalone AOT with -march=native) 0.435 ± 0.001 0.434 0.437 1.00

Benchmark for program fib_2M

Open benchmarks
Command Mean [s] Min [s] Max [s] Relative
Cairo-vm (Rust, Cairo 1) 12.400 ± 0.065 12.360 12.583 2036.87 ± 37.69
cairo-native (embedded AOT) 1.125 ± 0.014 1.107 1.152 184.84 ± 3.97
cairo-native (embedded JIT using LLVM's ORC Engine) 1.116 ± 0.005 1.112 1.128 183.38 ± 3.35
cairo-native (standalone AOT) 0.006 ± 0.000 0.006 0.007 1.00
cairo-native (standalone AOT with -march=native) 0.006 ± 0.000 0.006 0.007 1.04 ± 0.03

Benchmark for program logistic_map

Open benchmarks
Command Mean [s] Min [s] Max [s] Relative
Cairo-vm (Rust, Cairo 1) 1.903 ± 0.011 1.890 1.928 28.49 ± 0.18
cairo-native (embedded AOT) 1.369 ± 0.010 1.353 1.382 20.51 ± 0.15
cairo-native (embedded JIT using LLVM's ORC Engine) 1.214 ± 0.007 1.203 1.230 18.18 ± 0.11
cairo-native (standalone AOT) 0.107 ± 0.000 0.107 0.109 1.61 ± 0.01
cairo-native (standalone AOT with -march=native) 0.067 ± 0.000 0.067 0.067 1.00

github-actions[bot] avatar Feb 21 '24 10:02 github-actions[bot]

Codecov Report

Attention: 106 lines in your changes are missing coverage. Please review.

Comparison is base (8b49c84) 77.69% compared to head (5393359) 77.70%.

:exclamation: Current head 5393359 differs from pull request most recent head d86e2f0. Consider uploading reports for the commit d86e2f0 to get more accurate results

Files Patch % Lines
src/execution_result.rs 14.89% 40 Missing :warning:
src/executor/aot.rs 0.00% 25 Missing :warning:
src/values.rs 28.57% 10 Missing :warning:
src/executor/jit.rs 77.27% 5 Missing :warning:
src/error/executor.rs 0.00% 4 Missing :warning:
src/cache/aot.rs 0.00% 3 Missing :warning:
src/error/compile.rs 66.66% 3 Missing :warning:
src/utils.rs 57.14% 3 Missing :warning:
src/bin/cairo-native-compile.rs 0.00% 2 Missing :warning:
src/bin/cairo-native-dump.rs 0.00% 2 Missing :warning:
... and 6 more
Additional details and impacted files
@@           Coverage Diff           @@
##             main     #444   +/-   ##
=======================================
  Coverage   77.69%   77.70%           
=======================================
  Files         109      108    -1     
  Lines       31781    31719   -62     
=======================================
- Hits        24692    24646   -46     
+ Misses       7089     7073   -16     

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov-commenter avatar Feb 21 '24 11:02 codecov-commenter