Procedural - Revision history

Peter at 15:58, 24 March 2021

2021-03-24T15:58:15Z

Peter at 14:26, 18 May 2017

2017-05-18T14:26:54Z

Peter at 14:26, 18 May 2017

2017-05-18T14:26:29Z

Peter at 14:11, 18 May 2017

2017-05-18T14:11:25Z

Peter at 04:52, 18 May 2017

2017-05-18T04:52:27Z

Peter at 04:44, 18 May 2017

2017-05-18T04:44:37Z

Peter at 14:57, 26 March 2015

2015-03-26T14:57:44Z

Peter at 15:08, 25 March 2015

2015-03-25T15:08:57Z

Peter at 15:04, 25 March 2015

2015-03-25T15:04:09Z

Peter: Created page with "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 down..."

2015-03-25T14:52:51Z

Created page with "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 down..."

New page

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 asembly. Code can be made very efficient, but managing all the temporary data structures can be tedious.

The procedural API processes [[DenseMatrix]] matrix types. For real numbers it takes in [http://ejml.org/javadoc/org/ejml/data/DenseMatrix64F.html DenseMatrix64F] and for complex [http://ejml.org/javadoc/org/ejml/data/CDenseMatrix64F.html CDenseMatrix64F]. These classes themselves only provide very basic operators for accessing elements within a matrix and well as its size and shape. More complex functions for manipulating DenseMatrix are available in various Ops classes, described below. Internally they store the matrix in a single array using a row-major format.

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]]

= 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 DenseMatrix64F and most are contained inside of the org.ejml.ops package.

* CommonOps
** Provides the most common matrix operations.
* EigenOps
** Provides operations related to eigenvalues and eigenvectors.
* MatrixFeatures
** Used to compute various features related to a matrix.
* NormOps
** Operations for computing different matrix norms.
* SingularOps
** Operations related to singular value decompositions.
* SpecializedOps
** Grab bag for operations which do not fit in anywhere else.
* RandomMatrices
** Used to create different types of random matrices.

= Tips for Avoiding "new" =

TODO fill this out.

* reshape matrices instead of declaring new ones
* not all functions recycle memory

@@ Line 46: / Line 46: @@
 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.
-; {{OpsDocLink|CommonOps_DDRM}} : Provides the most common matrix operations.
+; {{DocLink|org/ejml/dense/row/CommonOps_DDRM.html|CommonOps_DDRM}} : Provides the most common matrix operations.
-; {{OpsDocLink|EigenOps_DDRM}} : Provides operations related to eigenvalues and eigenvectors.
+; {{DocLink|org/ejml/dense/row/EigenOps_DDRM.html|EigenOps_DDRM}} : Provides operations related to eigenvalues and eigenvectors.
-; {{OpsDocLink|MatrixFeatures_DDRM}} : Used to compute various features related to a matrix.
+; {{DocLink|org/ejml/dense/row/MatrixFeatures_DDRM.html|MatrixFeatures_DDRM}} : Used to compute various features related to a matrix.
-; {{OpsDocLink|NormOps_DDRM}} : Operations for computing different matrix norms.
+; {{DocLink|org/ejml/dense/row/NormOps_DDRM.html|NormOps_DDRM}} : Operations for computing different matrix norms.
-; {{OpsDocLink|SingularOps_DDRM}} : Operations related to singular value decompositions.
+; {{DocLink|org/ejml/dense/row/SingularOps_DDRM.html|SingularOps_DDRM}} : Operations related to singular value decompositions.
-; {{OpsDocLink|SpecializedOps_DDRM}} : Grab bag for operations which do not fit in anywhere else.
+; {{DocLink|org/ejml/dense/row/SpecializedOps_DDRM.html|SpecializedOps_DDRM}} : Grab bag for operations which do not fit in anywhere else.
-; {{OpsDocLink|RandomMatrices_DDRM}} : Used to create different types of random matrices.
+; {{DocLink|org/ejml/dense/row/RandomMatrices_DDRM.html|RandomMatrices_DDRM}} : 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.

@@ Line 26: / Line 26: @@
 | {{DocLink|org/ejml/data/FMatrix3.html|FMatrix3}} || Dense Float Real 3 || FDF3
 |}
-Fixed sized matrix from 2 to 7 are supported.  Just replaced the 3 with the desired size.  ''NOTE: In previous versions of EJML the matrix DMatrixRMaj was known as DenseMatrix64F.''
+Fixed sized matrix from 2 to 6 are supported.  Just replaced the 3 with the desired size.  ''NOTE: In previous versions of EJML the matrix DMatrixRMaj was known as DenseMatrix64F.''
 = Matrix Element Accessors =

@@ Line 3: / Line 3: @@
 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.''
+{| class="wikitable"
+! Matrix Name !! Description !! Suffix
 |-
-| {{DataDocLink|DMatrixRMaj}} || Dense Double Real Matrix - Row Major
+| {{DataDocLink|DMatrixRMaj}} || Dense Double Real - Row Major || DDRM
 |-
-| {{DataDocLink|FMatrixRMaj}} || Dense Float Real Matrix - Row Major
+| {{DataDocLink|FMatrixRMaj}} || Dense Float Real - Row Major || FDRM
 |-
-| {{DataDocLink|ZDMatrixRMaj}} || Dense Double Complex Matrix - Row Major
+| {{DataDocLink|ZDMatrixRMaj}} || Dense Double Complex - Row Major || ZDRM
 |-
-| {{DataDocLink|CDMatrixRMaj}} || Dense Float Complex Matrix - Row Major
+| {{DataDocLink|CDMatrixRMaj}} || Dense Float Complex - Row Major || CDRM
 |-
-| {{DocLink|org/ejml/data/DMatrix3x3.html|DMatrixNxN}} || Fixed Size Dense Real Matrix
+| {{DataDocLink|DMatrixSparseCSC}} || Sparse Double Real - Compressed Column || DSCC
 |-
-| {{DocLink|org/ejml/data/DMatrix3.html|DMatrixN}} || Fixed Size Dense Real Vector
+| {{DataDocLink|DMatrixSparseTriplet}} || Sparse Double Real - Triplet || DSTL
 |-
-| DDRM || DMatrixRMaj
+| {{DocLink|org/ejml/data/DMatrix3x3.html|DMatrix3x3}} || Dense Double Real 3x3 || DDF3
 |-
-| FDRM || FMatrixRMaj
+| {{DocLink|org/ejml/data/DMatrix3.html|DMatrix3}} || Dense Double Real 3 || DDF3
 |-
-| ZDRM || ZMatrixRMaj
+| {{DocLink|org/ejml/data/FMatrix3x3.html|FMatrix3x3}} || Dense Float Real 3x3 || FDF3
 |-
-| CDRM || CMatrixRMaj
+| {{DocLink|org/ejml/data/FMatrix3.html|FMatrix3}} || Dense Float Real 3 || FDF3
 |}
-* [[Manual#Example Code|List of code examples]]
+= Matrix Element Accessors =
 * get( row , col )
@@ Line 53: / Line 42: @@
 ** An iterator that iterates through the sub-matrix by row or by column.
-= Operations =
+= Operations Classes =
 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.

@@ 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 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.''
 {| 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
@@ Line 26: / Line 20: @@
 | {{DocLink|org/ejml/data/DMatrix3.html|DMatrixN}} || Fixed Size Dense Real Vector
 |}
 = Accessors =
@@ Line 43: / Line 55: @@
 = 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.
 ; {{OpsDocLink|CommonOps_DDRM}} : Provides the most common matrix operations.

@@ Line 22: / Line 22: @@
 | {{DataDocLink|CDMatrixRMaj}} || Dense Float Complex Matrix
 |-
-| {{DocLink|org/ejml/data/FixedMatrix3x3_64F.html|FixedMatrixNxN_F64F}} || Fixed Size Dense Real Matrix
+| {{DocLink|org/ejml/data/DMatrix3x3.html|DMatrixNxN}} || Fixed Size Dense Real Matrix
 |-
-| {{DocLink|org/ejml/data/FixedMatrix3_64F.html|FixedMatrixN_F64F}} || Fixed Size Dense Real Vector
+| {{DocLink|org/ejml/data/DMatrix3.html|DMatrixN}} || Fixed Size Dense Real Vector
 |}

@@ Line 14: / Line 14: @@
 ! Name !! Description
 |-
-| [http://ejml.org/javadoc/org/ejml/data/DenseMatrix64F.html DenseMatrix64F] || Dense Real Matrix
+| {{DataDocLink|DenseMatrix64F}} || Dense Real Matrix
 |-
-| [http://ejml.org/javadoc/org/ejml/data/CDenseMatrix64F.html CDenseMatrix64F] || Dense Complex Matrix
+| {{DataDocLink|CDenseMatrix64F}} || Dense Complex Matrix
 |-
-| [http://ejml.org/javadoc/org/ejml/data/FixedMatrix4x4_64F.html FixedMatrixNxN_64F] || Fixed Size Dense Real Matrix
+| {{DocLink|org/ejml/data/FixedMatrix3x3_64F.html|FixedMatrixNxN_F64F}} || Fixed Size Dense Real Matrix
 |-
-| [http://ejml.org/javadoc/org/ejml/data/FixedMatrix4_64F.html FixedMatrixN_64F] || Fixed Size Dense Real Vector
+| {{DocLink|org/ejml/data/FixedMatrix3_64F.html|FixedMatrixN_F64F}} || Fixed Size Dense Real Vector
 |}
@@ Line 41: / Line 41: @@
 Several "Ops" classes provide functions for manipulating DenseMatrix64F and most are contained inside of the org.ejml.ops package.  The list below is provided for real matrices.  For complex matrices add a "C" in front of the name, e.g. CCommonOps.
-* CommonOps
+; {{OpsDocLink|CommonOps}} : Provides the most common matrix operations.
-** Provides the most common matrix operations.
+; {{OpsDocLink|EigenOps}} : Provides operations related to eigenvalues and eigenvectors.
-* EigenOps
+; {{OpsDocLink|MatrixFeatures}} : Used to compute various features related to a matrix.
-** Provides operations related to eigenvalues and eigenvectors.
+; {{OpsDocLink|NormOps}} : Operations for computing different matrix norms.
-* MatrixFeatures
+; {{OpsDocLink|SingularOps}} : Operations related to singular value decompositions.
-** Used to compute various features related to a matrix.
+; {{OpsDocLink|SpecializedOps}} : Grab bag for operations which do not fit in anywhere else.
-* NormOps
+; {{OpsDocLink|RandomMatrices}} : 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.

@@ 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 asembly.  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.  For real numbers it takes in [http://ejml.org/javadoc/org/ejml/data/DenseMatrix64F.html DenseMatrix64F] and for complex [http://ejml.org/javadoc/org/ejml/data/CDenseMatrix64F.html CDenseMatrix64F].  These classes themselves only provide very basic operators for accessing elements within a matrix and well as its size and shape.  More complex functions for manipulating DenseMatrix are available in various Ops classes, described below. Internally they store the matrix in a single array using a row-major format.
+The procedural API processes [[DenseMatrix]] matrix types.  There are functions for real matrices [http://ejml.org/javadoc/org/ejml/data/DenseMatrix64F.html DenseMatrix64F], complex [http://ejml.org/javadoc/org/ejml/data/CDenseMatrix64F.html CDenseMatrix64F], and fixed sized (FixedMatrix2x2_64F, ..., FixedMatrix6x6_64F).  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.
 While it has a sharper learning curve and takes more time to learn it is the most powerful API.
@@ Line 23: / Line 25: @@
 = Operations =
-Several "Ops" classes provide functions for manipulating DenseMatrix64F and most are contained inside of the org.ejml.ops package.
+Several "Ops" classes provide functions for manipulating DenseMatrix64F and most are contained inside of the org.ejml.ops package.  The list below is provided for real matrices.  For complex matrices add a "C" in front of the name, e.g. CCommonOps.
 * CommonOps
@@ Line 40: / Line 42: @@
 ** Used to create different types of random matrices.
-= Tips for Avoiding  "new" =
+For fixed sized matrices FixedOpsN is provided, where N = 2 to 6.  FixedOpsN is similar in functionality to CommonOps.