Skip to content

Commit

Permalink
MVPoly: additional documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
dannywillems committed Oct 14, 2024
1 parent aaea0e0 commit e44364a
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
2 changes: 1 addition & 1 deletion mvpoly/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## MVPoly: symbolic interpreter of multivariate polynomials
# MVPoly: play with multi-variate poynomials

This library aims to provide algorithms and different representations to
manipulate multivariate polynomials.
Expand Down
12 changes: 12 additions & 0 deletions mvpoly/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
//! This module contains the definition of the `MVPoly` trait, which is used to
//! represent multi-variate polynomials.
//!
//! Different representations are provided in the sub-modules:
//! - `monomials`: a representation based on monomials
//! - `prime`: a representation based on a mapping from variables to prime
//! numbers. This representation is unmaintained for now. We leave it
//! for interested users.
//!
//! "Expressions", as defined in the [kimchi] crate, can be converted into a
//! multi-variate polynomial using the `from_expr` method.
use std::collections::HashMap;

use ark_ff::PrimeField;
Expand Down

0 comments on commit e44364a

Please sign in to comment.