Better documentation for skew fields, and fields which don't close under all implemented operations

Open
#10 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
typescript
Domain
tooling

Research direction

Locate the implementations of toString, toHorner, mul, eval, and pow, then read how polynomial coefficients and field operations are represented. Document the left/right quaternion polynomial convention, check that the named operations use it consistently, and document the lack of closure for pow over ℚ and ℝ; done means the documentation and behavior agree.

Written by the indexing model from the issue text.

Description

  1. If we are working in the quaternions ℍ, there are two canonical forms for a polynomial; we could either use the left or right polynomial, i.e. P(x) = ∑ a_k x^k, or P(x) = ∑ x^k b_k. These two differ because ℍ is non-commutative. This subtlety needs to be documented, and ensured that it's implemented consistently throughout, e.g. within toString, toHorner, mul, and eval.
  2. The fields ℚ and ℝ are not closed under the pow operation, but this operation is assumed to be implemented for each field. This needs to be documented.
Dominant language
TypeScript
Stars
135
Forks
16
No merged PRs in 30d

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.

More from rawify/Polynomial.js

All issues in rawify/Polynomial.js

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.