https://github.com/dandxy89/lp_parser_rs
Rust LP File Parser and Diff tool
https://github.com/dandxy89/lp_parser_rs
diff integer-programming linear-programming lp lpfile nom parser rust
Last synced: about 2 months ago
JSON representation
Rust LP File Parser and Diff tool
- Host: GitHub
- URL: https://github.com/dandxy89/lp_parser_rs
- Owner: dandxy89
- License: apache-2.0
- Created: 2023-11-10T19:13:01.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-24T22:06:26.000Z (3 months ago)
- Last Synced: 2025-04-10T16:55:27.046Z (about 2 months ago)
- Topics: diff, integer-programming, linear-programming, lp, lpfile, nom, parser, rust
- Language: Linear Programming
- Homepage: https://docs.rs/lp_parser_rs/latest/lp_parser_rs/
- Size: 4.6 MB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-rust-formalized-reasoning - lp_parser_rs - LP file parser. (Projects / Libraries)
README
# Rust LP File Parser and Diff Tool
[](https://github.com/dandxy89/congenial-enigma/actions/workflows/cargo_test.yml)
[](https://crates.io/crates/lp_parser_rs)
[](https://docs.rs/lp_parser_rs/)
## Overview
A robust Rust parser for Linear Programming (LP) files, built on the [NOM](https://docs.rs/nom/latest/nom/) parsing framework. This crate provides comprehensive support for parsing and analysing LP files according to major industry specifications.
### Supported Specifications
- [IBM CPLEX v22.1.1](https://www.ibm.com/docs/en/icos/22.1.1?topic=cplex-lp-file-format-algebraic-representation)
- [FICO Xpress](https://www.fico.com/fico-xpress-optimization/docs/dms2020-03/solver/optimizer/HTML/chapter10_sec_section102.html)
- [Gurobi](https://www.gurobi.com/documentation/current/refman/lp_format.html)
- Mosek
## Features
### Core Functionality
- **Problem Definition**
- Problem name and sense specification
- Single and multi-objective optimization support
- Comprehensive constraint handling
- **Variable Support**
- Integer, general, bounded, free, semi-continuous variables
### Advanced Features
- **LP File Comparison (`diff` feature)**
- Identify added, removed, and modified elements
- Useful for model version control and validation
- **Serialization (`serde` feature)**
- Full serialization support for all model structures
- Compatible with various data formats
- Enables integration with other tools and systems
## Quick Start
### Installation
Add to your `Cargo.toml`:
```toml
[dependencies]
lp_parser_rs = "x.y.z"
```
### Basic Usage
Clone and run with a sample file:
```bash
git clone https://github.com/dandxy89/lp_parser_rs.git
# Dissemble a single LP file
cargo run --bin lp_parser --release -- {{ /path/to/your/file.lp }}
# Compare two LP files (enabling the 'diff' feature)
cargo run --bin lp_parser --release --features diff -- {{ /path/to/your/file.lp }} {{ /path/to/your/other/file.lp }}
```
Using the library directly:
```rust
use lp_parser::{parser::parse_file, LpProblem};
use std::path::Path;
fn main() -> Result<(), Box> {
// Parse LP file content
let content = parse_file(Path::new("problem.lp"))?;
// Parse into LP problem structure
let problem = LpProblem::parse(&content)?;
// Access problem components
println!("Problem name: {:?}", problem.name());
println!("Objective count: {}", problem.objective_count());
println!("Constraint count: {}", problem.constraint_count());
println!("Variable count: {}", problem.variable_count());
Ok(())
}
```
### Enable Optional Features
```toml
[dependencies]
lp_parser_rs = { version = "x.y.z", features = ["serde", "diff"] }
```
## Development
### Testing
The project uses snapshot testing via `insta` for reliable test management:
```bash
# Run all tests with all features enabled
cargo insta test --all-features
# Review snapshot changes
cargo insta review
```
## Test Data Sources
The test suite includes data from various open-source projects:
- [Jplex](https://github.com/asbestian/jplex/blob/main/instances/afiro.lp)
- [LPWriter.jl](https://github.com/odow/LPWriter.jl/blob/master/test/model2.lp)
- [Lp-Parser](https://github.com/aphi/Lp-Parser)
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.