squiid-parser 1.5.2

The algebraic expression parser for Squiid Calculator.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

# Squiid Parser

Squiid Parser is the algebraic expression parser for [Squiid Calculator](https://gitlab.com/ImaginaryInfinity/squiid-calculator/squiid), designed to parse infix notation into postifix (RPN) notation, which can then be evaluated by [squiid-engine](https://crates.io/crates/squiid-engine). It is implemented in Rust to ensure high performance and safety.

## Features

- Fast and memory-safe algebraic (infix) to RPN (postfix) conversion
- Well-documented API
- Error handling with the prohibition of `unwrap()`/`expect()`
- Able to be used through a variety of different languages through the [bindings](https://gitlab.com/ImaginaryInfinity/squiid-calculator/squiid-bindings)

## Installation

```sh
cargo add squiid-parser
```

## Example Usage

```rs
use squiid_parser::parse;

fn main() {
    // Parse an algebraic expression: (3 + 5 * 7)
    let result = parse("(3+5*7)");

    assert_eq!(result, vec!["3", "5", "7", "*", "+"]);
}
```

## License

Squiid Parser is licensed under GPLv3.

# Compiling

To compile the shared object file for use in bindings, just run install Rust and run `cargo build --release --lib --features=ffi`. The shared object file should be found in `target/release/libsquiid_parser.so`.