Consistent Linear Algebra API
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Java
- Stars
- 259
- Forks
- 47
- PR merge metrics
- No merged PRs in 30d
Description
I believe it is worth making a consistent API for linear algebra operations as follows:
- API classes in the
mikera.matrixx.algo.*package - Static functions
- Return an
IXXXXResultfor decompositions (other algorithms can return the result type directly - Use
nullfor failed decompositions (e.g. singular matrices etc.)
This consistent API gives us a few advantages:
- Users know where to go (it is all in one place)
- We maintain common conventions
- We hide implementation details
- We have the option to upgrade to better implementations without changing the API (and breaking downstream users....)
@prasant94 - does that make sense to you? Think it applies to most of the stuff you are importing....
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing linear algebra algorithms and imports related to the mikera.matrixx.algo.* package. Identify which operations need common static entry points and which decompositions need IXXXXResult types. The issue is done only when the API scope and conventions are agreed across the affected algorithms.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- data
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100