Skip to content

Latest commit

 

History

History
69 lines (43 loc) · 2 KB

docs.md

File metadata and controls

69 lines (43 loc) · 2 KB
Raw

Documentation

APA mini documentation

  • Big Integers

    For values that cannot fit the integral types. e.g. int, long long int, uint64_t & etc.

  • Big Real Numbers

    For values that cannot fit the real types. e.g. float & double.

  • Compilation

    Learn how to use the library, include the proper headers, compile directly or create a static library.

  • Specification

    Some rules or designs followed by this library.

  • Big Integer Representations

    Learn how this library represent big numbers.


  • Benchmarks

    • Basic-Arithmetic. - generated by make benchmark .

    • Karatsuba. - generated by make benchmark .

    • Initialization and Base 10 string conversion. - generated by make benchmark .

    • Performance Comparison - generated by make -C benchmark/comparisons , here the performance was compared with other light-weight popular C++ big integer libraries.

    • To generate a performance comparison in your own device.

      1. Download the target libraries. (only once)

        make -C benchmark/comparisons clone

      2. Compile the performance comparison scripts.

        make -C benchmark/comparisons compile

      3. Run and Generate performance stats markdown files.

        make -C benchmark/comparisons run

        Output file: APA/benchmark/comparison.md

      4. Clean the downloaded resources.

        make -C benchmark/comparisons clean

    These benchmark commands will only work in Linux.