Macaulay2 / Macaulay2/M2

inconsistent naming of matrix factorization functions

Open
#2,687 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Linear Algebra
Dominant language
Macaulay2
Stars
435
Forks
297
Avg merge
4d 20h
Merged PRs (30d)
11

Description

We make available functions for the LU, QR and SVD decompositions of a matrix over the reals, for example.

However the names are LUdecomposition, QRDecomposition, and SVD.
While we probably can't change these , I suggest we make changes so that LUDecomposition and SVDDecomposition all work. Or does anyone have better ideas for the (consistent) names we should use? @antonleykin @DanGrayson, @d-torrance ?

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 by locating the definitions or entry points for LUdecomposition, QRDecomposition, and SVD. Review how these functions are exposed and used, then resolve the naming convention before determining whether compatible aliases should be added and how the existing behavior should be verified.

Written by the indexing model from the issue text.

Assessment

Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.