pishleback / pishleback/Algebraeon

User guide examples

Open
#40 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation good first issue priority
Dominant language
Rust
Stars
82
Forks
10
PR merge metrics
No merged PRs in 30d

Description

There's a ton of undocumented functionality. The user guide needs sections on all the core functionality, with each section containing an overview of the mathematics involved and example code blocks.

Checklist of things to document in order to close this issue:

  • Natural numbers and their operations including factoring. (#62)
  • Integers and their operations including factoring. (#77)
  • Integer factoring.
  • Rationals and their operations (#83).
  • Polynomials in one variable, operations with them, factoring over different rings.
  • Multivariable polynomials, operations with them, factoring over different rings.
  • Symmetric polynomials and obtaining expressions in terms of elementary symmetric polynomials.
  • Combinatorical functions: partitions of sets, partitions of numbers, compositions of numbers, subsets of a fixed size, etc.
  • Matricies, hermite normal form, smith normal form, jordan normal form, solving systems of linear equations.
  • Algebraic real and complex numbers.
  • Algebraic p-adic numbers.
  • Algebraic number fields, integral bases, ring of integers, ideals, factoring ideals, etc.
  • Finite groups, enumerating subgroups and normal subgroups, finding isomorphisms, enumerating cosets in finitely generated groups, etc.
  • Simplicial complexes: convex hull of points, boolean operations.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the user guide and review the checklist to identify which core functionality remains undocumented. Use the completed sections as a model for the mathematics overviews and example code blocks, then document the remaining polynomial, combinatorial, matrix, algebraic-number, and group functionality until the unchecked items are complete.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.