Difference between revisions of "Main Page"

From Efficient Java Matrix Library
Jump to navigation Jump to search
Line 9: Line 9:
 
Efficient Java Matrix Library (EJML) is a [http://en.wikipedia.org/wiki/Linear_algebra linear algebra] library for manipulating dense matrices. Its design goals are; 1) to be as computationally and memory efficient as possible for both small and large matrices, and 2) to be accessible to both novices and experts.  These goals are accomplished by dynamically selecting the best algorithms to use at runtime, clean API, and multiple interfaces.  EJML is free, written in 100% Java and has been released under an Apache v2.0 license.
 
Efficient Java Matrix Library (EJML) is a [http://en.wikipedia.org/wiki/Linear_algebra linear algebra] library for manipulating dense matrices. Its design goals are; 1) to be as computationally and memory efficient as possible for both small and large matrices, and 2) to be accessible to both novices and experts.  These goals are accomplished by dynamically selecting the best algorithms to use at runtime, clean API, and multiple interfaces.  EJML is free, written in 100% Java and has been released under an Apache v2.0 license.
  
EJML has three distinct ways to interact with it:  1) ''procedural'', 2) ''object oriented'', and 3) ''equations''.  ''Procedure'' provides all capabilities of EJML and almost complete control over memory creation, speed, and specific algorithms.  ''Object oriented'' provides a simplified subset of the core capabilities in an easy to use API, inspired by [http://math.nist.gov/javanumerics/jama/ Jama].  ''Equations'' is a symbolic interface, similar in spirit to [http://www.mathworks.com/products/matlab/ Matlab] and other [http://en.wikipedia.org/wiki/Computer_algebra_system CAS], that provides a compact way of writing equations.
+
EJML has three distinct ways to interact with it:  1) ''procedural'', 2) ''SimpleMatrix'', and 3) ''equations''.  ''Procedure'' provides all capabilities of EJML and almost complete control over memory creation, speed, and specific algorithms.  ''SimpleMatrix'' provides a simplified subset of the core capabilities in an easy to use flow styled object-oriented API, inspired by [http://math.nist.gov/javanumerics/jama/ Jama].  ''Equations'' is a symbolic interface, similar in spirit to [http://www.mathworks.com/products/matlab/ Matlab] and other [http://en.wikipedia.org/wiki/Computer_algebra_system CAS], that provides a compact way of writing equations.
 
|}
 
|}
  
Line 53: Line 53:
 
== Code Examples ==
 
== Code Examples ==
  
Below are code examples demonstrating how to compute the Kalman gain, "K", using the three different interfaces in EJML.
+
Demonstrations on how to compute the Kalman gain "K" using each interface in EJML.
  
 
{| width="500pt" |
 
{| width="500pt" |
 
|-
 
|-
 
|
 
|
'''Equations'''
+
'''Procedural'''
 
<syntaxhighlight lang="java">
 
<syntaxhighlight lang="java">
eq.process("K = P*H'*inv( H*P*H' + R )");
+
mult(H,P,c);
 +
multTransB(c,H,S);
 +
addEquals(S,R);
 +
if( !invert(S,S_inv) ) throw new RuntimeException("Invert failed");
 +
multTransA(H,S_inv,d);
 +
mult(P,d,K);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
'''Object Oriented'''
+
'''SimpleMatrix'''
 
<syntaxhighlight lang="java">
 
<syntaxhighlight lang="java">
 
SimpleMatrix S = H.mult(P).mult(H.transpose()).plus(R);
 
SimpleMatrix S = H.mult(P).mult(H.transpose()).plus(R);
Line 69: Line 74:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
'''Procedural'''
+
'''Equations'''
 
<syntaxhighlight lang="java">
 
<syntaxhighlight lang="java">
mult(H,P,c);
+
eq.process("K = P*H'*inv( H*P*H' + R )");
multTransB(c,H,S);
 
addEquals(S,R);
 
if( !invert(S,S_inv) ) throw new RuntimeException("Invert failed");
 
multTransA(H,S_inv,d);
 
mult(P,d,K);
 
 
</syntaxhighlight>
 
</syntaxhighlight>
 
|}
 
|}

Revision as of 16:06, 21 March 2015


Ejml logo.gif

Efficient Java Matrix Library (EJML) is a linear algebra library for manipulating dense matrices. Its design goals are; 1) to be as computationally and memory efficient as possible for both small and large matrices, and 2) to be accessible to both novices and experts. These goals are accomplished by dynamically selecting the best algorithms to use at runtime, clean API, and multiple interfaces. EJML is free, written in 100% Java and has been released under an Apache v2.0 license.

EJML has three distinct ways to interact with it: 1) procedural, 2) SimpleMatrix, and 3) equations. Procedure provides all capabilities of EJML and almost complete control over memory creation, speed, and specific algorithms. SimpleMatrix provides a simplified subset of the core capabilities in an easy to use flow styled object-oriented API, inspired by Jama. Equations is a symbolic interface, similar in spirit to Matlab and other CAS, that provides a compact way of writing equations.

Version: v0.26
Date: September 15, 2014
Download
Manual
JavaDoc
Message Board
Bug Reports
FAQ
Acknowledgments
Performance
Users


Code Examples

Demonstrations on how to compute the Kalman gain "K" using each interface in EJML.

Procedural

mult(H,P,c);
multTransB(c,H,S);
addEquals(S,R);
if( !invert(S,S_inv) ) throw new RuntimeException("Invert failed");
multTransA(H,S_inv,d);
mult(P,d,K);

SimpleMatrix

SimpleMatrix S = H.mult(P).mult(H.transpose()).plus(R);
SimpleMatrix K = P.mult(H.transpose().mult(S.invert()));

Equations

eq.process("K = P*H'*inv( H*P*H' + R )");

Functionality

Data Structures Operations
  • Fixed Sized
  • Dense Real
    • Row-major
    • Block
  • Dense Complex
    • Row-major
    • Incomplete Support
  • Basic Operators (addition, multiplication, ... )
  • Matrix Manipulation (extract, insert, combine, ... )
  • Linear Solvers (linear, least squares, incremental, ... )
  • Decompositions (LU, QR, Cholesky, SVD, Eigenvalue, ...)
  • Matrix Features (rank, symmetric, definitiveness, ... )
  • Random Matrices (covariance, orthogonal, symmetric, ... )
  • Unit Testing
.

EJML is currently a single threaded library only. Multi threaded work will start once block implementations of SVD and Eigenvalue are finished.