Difference between revisions of "Procedural"

From Efficient Java Matrix Library
Jump to navigation Jump to search
Line 1: Line 1:
 
The procedural interface in EJML provides access to all of its capabilities and provides much more control over which algorithms are used and when memory is created.  The downside to this increased control is the added difficulty in programming, kinda resembles writing in assembly.  Code can be made very efficient, but managing all the temporary data structures can be tedious.   
 
The procedural interface in EJML provides access to all of its capabilities and provides much more control over which algorithms are used and when memory is created.  The downside to this increased control is the added difficulty in programming, kinda resembles writing in assembly.  Code can be made very efficient, but managing all the temporary data structures can be tedious.   
  
−
The procedural API processes DenseMatrix matrix types. A complete list of these data types is listed [[#DenseMatrix Types|below]].  These classes themselves only provide very basic operators for accessing elements within a matrix and well as its size and shape.  The complete set of functions for manipulating DenseMatrix are available in various Ops classes, described below.  
+
The procedural supports all matrix types in EJML and follows a consistent naming pattern across all matrix types. Ops classes end in a suffix that indicate which type of matrix they can process.  From the matrix name you can determine the type of element (float,double,real,complex) and it's internal data structure, e.g. row-major or block.  In general, almost everyone will want to interact with row major matrices.  Conversion to block format is done automatically internally when it becomes advantageous.
  
−
Internally all dense matrix classes store the matrix in a single array using a row-major format.  Fixed sized matrices and vectors unroll the matrix, where each element is a matrix parameter. This can allow for much faster access and array overhead.  However if fixed sized matrices get too large then performance starts to drop due to what I suppose is CPU caching issues.
+
''NOTE: In previous versions of EJML the matrix DMatrixRMaj was known as DenseMatrix64F.''
−
 
 
−
While it has a sharper learning curve and takes more time to learn it is the most powerful API.
 
−
 
 
−
* [[Manual#Example Code|List of code examples]]
 
−
 
 
−
= DenseMatrix Types =
 
  
 
{| style="wikitable"
 
{| style="wikitable"
−
! Name !! Description
+
! Matrix Name !! Description
 
|-
 
|-
−
| {{DataDocLink|DMatrixRMaj}} || Dense Double Real Matrix
+
| {{DataDocLink|DMatrixRMaj}} || Dense Double Real Matrix - Row Major
 
|-
 
|-
−
| {{DataDocLink|FMatrixRMaj}} || Dense Float Real Matrix
+
| {{DataDocLink|FMatrixRMaj}} || Dense Float Real Matrix - Row Major
 
|-
 
|-
−
| {{DataDocLink|ZDMatrixRMaj}} || Dense Double Complex Matrix
+
| {{DataDocLink|ZDMatrixRMaj}} || Dense Double Complex Matrix - Row Major
 
|-
 
|-
−
| {{DataDocLink|CDMatrixRMaj}} || Dense Float Complex Matrix
+
| {{DataDocLink|CDMatrixRMaj}} || Dense Float Complex Matrix - Row Major
 
|-
 
|-
 
| {{DocLink|org/ejml/data/DMatrix3x3.html|DMatrixNxN}} || Fixed Size Dense Real Matrix
 
| {{DocLink|org/ejml/data/DMatrix3x3.html|DMatrixNxN}} || Fixed Size Dense Real Matrix
Line 26: Line 20:
 
| {{DocLink|org/ejml/data/DMatrix3.html|DMatrixN}} || Fixed Size Dense Real Vector
 
| {{DocLink|org/ejml/data/DMatrix3.html|DMatrixN}} || Fixed Size Dense Real Vector
 
|}
 
|}
 +
 +
The list of ops suffixes is listed below and the related matrix type.  Through out the manual we will default to DMatrixRMaj unless there is a specific need to do otherwise. 
 +
 +
{| class="wikitable"
 +
! Ops Suffix || Matrix Type
 +
|-
 +
| DDRM || DMatrixRMaj
 +
|-
 +
| FDRM || FMatrixRMaj
 +
|-
 +
| ZDRM || ZMatrixRMaj
 +
|-
 +
| CDRM || CMatrixRMaj
 +
|}
 +
 +
* [[Manual#Example Code|List of code examples]]
 +
 +
= DenseMatrix Types =
  
 
= Accessors =
 
= Accessors =
Line 43: Line 55:
 
= Operations =
 
= Operations =
  
−
Several "Ops" classes provide functions for manipulating *MatrixRMaj and most are contained inside of the org.ejml.dense.row package.  The list below is provided for real matrices.  Other matrix can be found by changing the suffix.
+
Several "Ops" classes provide functions for manipulating different types of matrices and most are contained inside of the org.ejml.dense.* package, where * is replaced with the matrix structure package type, e.g. row for row-major.  The list below is provided for DMatrixRMaj, other matrix can be found by changing the suffix as discussed above.
−
 
 
−
{| class="wikitable"
 
−
! Suffix || Matrix Type
 
−
|-
 
−
| DDRM || Dense Double Real
 
−
|-
 
−
| FDRM || Dense Float Real
 
−
|-
 
−
| ZDRM || Dense Double Complex
 
−
|-
 
−
| CDRM || Dense Float Complex
 
−
|}
 
  
 
; {{OpsDocLink|CommonOps_DDRM}} : Provides the most common matrix operations.  
 
; {{OpsDocLink|CommonOps_DDRM}} : Provides the most common matrix operations.  

Revision as of 06:11, 18 May 2017

The procedural interface in EJML provides access to all of its capabilities and provides much more control over which algorithms are used and when memory is created. The downside to this increased control is the added difficulty in programming, kinda resembles writing in assembly. Code can be made very efficient, but managing all the temporary data structures can be tedious.

The procedural supports all matrix types in EJML and follows a consistent naming pattern across all matrix types. Ops classes end in a suffix that indicate which type of matrix they can process. From the matrix name you can determine the type of element (float,double,real,complex) and it's internal data structure, e.g. row-major or block. In general, almost everyone will want to interact with row major matrices. Conversion to block format is done automatically internally when it becomes advantageous.

NOTE: In previous versions of EJML the matrix DMatrixRMaj was known as DenseMatrix64F.

Matrix Name Description
DMatrixRMaj Dense Double Real Matrix - Row Major
FMatrixRMaj Dense Float Real Matrix - Row Major
ZDMatrixRMaj Dense Double Complex Matrix - Row Major
CDMatrixRMaj Dense Float Complex Matrix - Row Major
DMatrixNxN Fixed Size Dense Real Matrix
DMatrixN Fixed Size Dense Real Vector

The list of ops suffixes is listed below and the related matrix type. Through out the manual we will default to DMatrixRMaj unless there is a specific need to do otherwise.

Ops Suffix Matrix Type
DDRM DMatrixRMaj
FDRM FMatrixRMaj
ZDRM ZMatrixRMaj
CDRM CMatrixRMaj

DenseMatrix Types

Accessors

  • get( row , col )
  • set( row , col , value )
    • Returns or sets the value of an element at the specified row and column.
  • unsafe_get( row , col )
  • unsafe_set( row , col , value )
    • Faster version of get() or set() that does not perform bounds checking.
  • get( index )
  • set( index )
    • Returns or sets the value of an element at the specified index. Useful for vectors and element-wise operations.
  • iterator( boolean rowMajor, int minRow, int minCol, int maxRow, int maxCol )
    • An iterator that iterates through the sub-matrix by row or by column.

Operations

Several "Ops" classes provide functions for manipulating different types of matrices and most are contained inside of the org.ejml.dense.* package, where * is replaced with the matrix structure package type, e.g. row for row-major. The list below is provided for DMatrixRMaj, other matrix can be found by changing the suffix as discussed above.

{{{2}}}
Provides the most common matrix operations.
{{{2}}}
Provides operations related to eigenvalues and eigenvectors.
{{{2}}}
Used to compute various features related to a matrix.
{{{2}}}
Operations for computing different matrix norms.
{{{2}}}
Operations related to singular value decompositions.
{{{2}}}
Grab bag for operations which do not fit in anywhere else.
{{{2}}}
Used to create different types of random matrices.

For fixed sized matrices FixedOpsN is provided, where N = 2 to 6. FixedOpsN is similar in functionality to CommonOps.

Retrieved from "http://ejml.org/wiki/index.php?title=Procedural&oldid=220"