Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Consistent Linear Algebra API #37

Open
mikera opened this issue May 20, 2014 · 1 comment
Open

Consistent Linear Algebra API #37

mikera opened this issue May 20, 2014 · 1 comment

Comments

@mikera
Copy link
Owner

mikera commented May 20, 2014

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 IXXXXResult for decompositions (other algorithms can return the result type directly
  • Use null for 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....

@prasant94
Copy link
Collaborator

Yes, I like the idea of using static functions.
I suppose I should also change Cholesky according to this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants