roundme - GitLite

KO | EN

gitlite — search

#javascript #react #ai #golang #machine-learning #deep-learning #docker #macos #java #windows #kubernetes #vue #security #ios

roundme

(★ 104)

No description available.

File Explorer

Download Latest Version (.zip)

- - config.yaml
  - README.md
  - report.pdf
- example.png
- - analyze_rounding.rs
  - ast.rs
- - arithmetic.lalrpop
  - formula_config.rs
  - input.rs
  - yaml.rs
- - latex_generator.rs
- analyzer.rs
- cli.rs
- lib.rs
- main.rs
- parser.rs
- printer.rs
- test_init.yaml
.gitignore
build.rs
Cargo.lock
Cargo.toml
LICENSE
README.md

# Installation Guide

1. Get the code

git clone https://github.com/crytic/roundme

Downloads the entire project code from GitHub to your computer.

cd roundme

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended

Prerequisites

Rust (rustup) Rust is required to use cargo.

cargo install roundme

Builds and installs the package published on crates.io — no need to clone the repo yourself.

cargo install --path .

Type this command into your terminal and run it.

✅ After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Rust

Medium

Prerequisites

Git Needed to download the project code from GitHub.
Rust (rustup) Installing via rustup also installs cargo.

cargo install roundme

Builds and installs the package published on crates.io — no need to clone the repo yourself.

cargo install --path .

Type this command into your terminal and run it.

✅ If cargo build finishes without errors, it worked. The executable is created under target/.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# roundme

`roundme` is a human-assisted rounding analyzer. It helps its operator determine whether an arithmetic operation should round up or down.

## Features
- Recommends whether an arithmetic operation needs to round up or down
- Generates LaTeX-based reports in PDF

## Rules

`rounding()` is the expected rounding direction for the result (up or down)

- `A + B => rounding(A), rounding(B)` (addition does not change the rounding direction)
- `A - B => rounding(A), ! rounding(B)` (the rounding direction of the substracted element is inverse of the expected rounding)
- `A * B => rounding(A), rounding(B), rounding(*) ` (multiplication does not change the rounding direction)
- `A / B => rounding(A), ! rounding(B), rounding(/)` (the rounding direction of the denominator is the inverse of the expected rounding)
- `A ** B`
  - `If A>=1 => rounding(A), rounding(B)`
  - `If A<1 => rounding(A), ! rounding(B)` (if A is below 1, the rounding direction of the exponent is the inverse of the expected rounding)

## How to use

- Run `roundme init-sample` to generate a default configuration file. 
- Run `roundme init` to generate user configuration file. 
- Run `roundme analyze` to analyze the configuration file
- Run `roundme analyze --output-format pdf` to generate a PDF (require [latexmk](https://mg.readthedocs.io/latexmk.html))

Running `roundme analyze --output-format pdf` on the default configuration will generate the following:
<img src="./images/example.png" alt="Example" width="50%" />

### Configuration

`roundme` relies on a configuration file:
```yaml
formula: a * b / c 
round_up: true
less_than_one: ["a * b"] # optional
greater_than_one: ["c"] # optional
```
- `formula` contains the formula to be analyze
- `round_up` determines if the result of the formula should round up or down
- `less_than_one` is used for the `**` [rules](#rules) *(raw string comparison and sensible to space)*
- `greater_than_one` is used for the `**` [rules](#rules) *(raw string comparison and sensible to space)*

See the [balancer V2](./examples/balancer/README.md) example.

## Install

Install with
```bash
cargo install roundme
```

To install the latest GitHub version
```bash
git clone git@github.com:crytic/roundme.git
cd roundme
cargo install --path .
```