Consistent Linear Algebra API - Githubissues

mikera / vectorz

Fast and flexible numerical library for Java featuring N-dimensional arrays

GNU Lesser General Public License v3.0

242 stars 46 forks source link

Consistent Linear Algebra API #37

Open mikera opened 10 years ago

mikera commented 10 years ago

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 commented 10 years ago

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