Getting a more functional Style for Cholesky
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Java
- Stars
- 259
- Forks
- 47
- PR merge metrics
- No merged PRs in 30d
Description
Hi @prasant94 - The initial Cholesky stuff looks good, but I think we should try to convert this to a more "functional" interface.
By which I mean:
- There should be no public mutator functions (e.g.
setExpectedMaxSize) - any such values should be set as final fields when objects are constructed. It's OK to mutate as an implementation detail of course - Immutable result objects should be returned from decompositions
- There is a pure functional interface to make the decomposition happen.
- API users should never need to use anything from the "*.impl" packages - this should be purely for implementation details
As an example, I've converted the old Cholesky code to return a CholeskyResult in this style
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 with the existing Cholesky implementation and inspect public mutators such as setExpectedMaxSize, the CholeskyResult example, and usages of *.impl packages. Done means the decomposition exposes a pure functional interface, returns immutable results, avoids public mutators, and keeps implementation packages out of the user-facing API.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- backend-api-design
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100