org.ejml.alg.fixed

Class FixedOps5

java.lang.Object

org.ejml.alg.fixed.FixedOps5

public class FixedOps5
extends Object

Common matrix operations for fixed sized matrices which are 5 x 5 or 5 element vectors.

DO NOT MODIFY. Automatically generated code created by GenerateFixedOps

Author:

Peter Abeles

Constructor Summary

Constructors

Constructor and Description
FixedOps5()

Method Summary

Methods

Modifier and Type	Method and Description
static void	add(FixedMatrix5x5_64F a, FixedMatrix5x5_64F b, FixedMatrix5x5_64F c) Performs the following operation: c = a + b cij = aij + bij
static void	addEquals(FixedMatrix5x5_64F a, FixedMatrix5x5_64F b) Performs the following operation: a = a + b aij = aij + bij
static void	changeSign(FixedMatrix5x5_64F a) Changes the sign of every element in the matrix. aij = -aij
static double	det(FixedMatrix5x5_64F mat) Computes the determinant using minor matrices.
static void	diag(FixedMatrix5x5_64F input, FixedMatrix5_64F out) Extracts all diagonal elements from 'input' and places them inside the 'out' vector.
static void	divide(double alpha, FixedMatrix5x5_64F a) Performs an in-place element by element scalar division. aij = aij/α
static void	divide(double alpha, FixedMatrix5x5_64F a, FixedMatrix5x5_64F b) Performs an element by element scalar division. bij = *aij /α
static double	dot(FixedMatrix5_64F a, FixedMatrix5_64F b) Performs the vector dot product: c = a * b c> = ∑k=1:n { bk * ak }
static void	elementDiv(FixedMatrix5x5_64F a, FixedMatrix5x5_64F b) Performs the an element by element division operation: aij = aij / bij
static void	elementDiv(FixedMatrix5x5_64F a, FixedMatrix5x5_64F b, FixedMatrix5x5_64F c) Performs the an element by element division operation: cij = aij / bij
static double	elementMax(FixedMatrix5x5_64F a) Returns the value of the element in the matrix that has the largest value. Max{ aij } for all i and j
static double	elementMaxAbs(FixedMatrix5x5_64F a) Returns the absolute value of the element in the matrix that has the largest absolute value. Max{ |aij| } for all i and j
static double	elementMin(FixedMatrix5x5_64F a) Returns the value of the element in the matrix that has the minimum value. Min{ aij } for all i and j
static double	elementMinAbs(FixedMatrix5x5_64F a) Returns the absolute value of the element in the matrix that has the smallest absolute value. Min{ |aij| } for all i and j
static void	elementMult(FixedMatrix5x5_64F a, FixedMatrix5x5_64F b) Performs the an element by element multiplication operation: aij = aij * bij
static void	elementMult(FixedMatrix5x5_64F a, FixedMatrix5x5_64F b, FixedMatrix5x5_64F c) Performs the an element by element multiplication operation: cij = aij * bij
static void	fill(FixedMatrix5x5_64F a, double v) Sets every element in the matrix to the specified value. aij = value
static boolean	invert(FixedMatrix5x5_64F a, FixedMatrix5x5_64F inv) Inverts matrix 'a' using minor matrices and stores the results in 'inv'.
static void	mult(FixedMatrix5_64F a, FixedMatrix5x5_64F b, FixedMatrix5_64F c) Performs vector to matrix multiplication: c = a * b cj = ∑k=1:n { bk * akj }
static void	mult(FixedMatrix5x5_64F a, FixedMatrix5_64F b, FixedMatrix5_64F c) Performs matrix to vector multiplication: c = a * b ci = ∑k=1:n { aik * bk}
static void	mult(FixedMatrix5x5_64F a, FixedMatrix5x5_64F b, FixedMatrix5x5_64F c) Performs the following operation: c = a * b cij = ∑k=1:n { aik * bkj}
static void	multTransA(FixedMatrix5x5_64F a, FixedMatrix5x5_64F b, FixedMatrix5x5_64F c) Performs the following operation: c = aT * b cij = ∑k=1:n { aki * bkj}
static void	multTransAB(FixedMatrix5x5_64F a, FixedMatrix5x5_64F b, FixedMatrix5x5_64F c) Performs the following operation: c = aT * bT cij = ∑k=1:n { aki * bjk}
static void	multTransB(FixedMatrix5x5_64F a, FixedMatrix5x5_64F b, FixedMatrix5x5_64F c) Performs the following operation: c = a * bT cij = ∑k=1:n { aik * bjk}
static void	scale(double alpha, FixedMatrix5x5_64F a) Performs an in-place element by element scalar multiplication. aij = α*aij
static void	scale(double alpha, FixedMatrix5x5_64F a, FixedMatrix5x5_64F b) Performs an element by element scalar multiplication. bij = α*aij
static void	setIdentity(FixedMatrix5x5_64F a) Sets all the diagonal elements equal to one and everything else equal to zero.
static double	trace(FixedMatrix5x5_64F a) This computes the trace of the matrix: trace = ∑i=1:n { aii }
static void	transpose(FixedMatrix5x5_64F m) Performs an in-place transpose.
static FixedMatrix5x5_64F	transpose(FixedMatrix5x5_64F input, FixedMatrix5x5_64F output) Transposes matrix 'a' and stores the results in 'b': bij = aji where 'b' is the transpose of 'a'.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FixedOps5

public FixedOps5()

Method Detail

add

public static void add(FixedMatrix5x5_64F a,
       FixedMatrix5x5_64F b,
       FixedMatrix5x5_64F c)

Performs the following operation:

c = a + b
c_ij = a_ij + b_ij

Matrix C can be the same instance as Matrix A and/or B.

Parameters:

a - A Matrix. Not modified.

b - A Matrix. Not modified.

c - A Matrix where the results are stored. Modified.

addEquals

public static void addEquals(FixedMatrix5x5_64F a,
             FixedMatrix5x5_64F b)

Performs the following operation:

a = a + b
a_ij = a_ij + b_ij

Parameters:

a - A Matrix. Modified.

b - A Matrix. Not modified.

transpose

public static void transpose(FixedMatrix5x5_64F m)

Performs an in-place transpose. This algorithm is only efficient for square matrices.

Parameters:

m - The matrix that is to be transposed. Modified.

transpose

public static FixedMatrix5x5_64F transpose(FixedMatrix5x5_64F input,
                           FixedMatrix5x5_64F output)

Transposes matrix 'a' and stores the results in 'b':

b_ij = a_ji
where 'b' is the transpose of 'a'.

Parameters:

input - The original matrix. Not modified.

output - Where the transpose is stored. If null a new matrix is created. Modified.

Returns:

The transposed matrix.

mult

public static void mult(FixedMatrix5x5_64F a,
        FixedMatrix5x5_64F b,
        FixedMatrix5x5_64F c)

Performs the following operation:

c = a * b

c_ij = ∑_k=1:n { a_ik * b_kj}

Parameters:

a - The left matrix in the multiplication operation. Not modified.

b - The right matrix in the multiplication operation. Not modified.

c - Where the results of the operation are stored. Modified.

multTransA

public static void multTransA(FixedMatrix5x5_64F a,
              FixedMatrix5x5_64F b,
              FixedMatrix5x5_64F c)

Performs the following operation:

c = a^T * b

c_ij = ∑_k=1:n { a_ki * b_kj}

Parameters:

a - The left matrix in the multiplication operation. Not modified.

b - The right matrix in the multiplication operation. Not modified.

c - Where the results of the operation are stored. Modified.

multTransAB

public static void multTransAB(FixedMatrix5x5_64F a,
               FixedMatrix5x5_64F b,
               FixedMatrix5x5_64F c)

Performs the following operation:

c = a^T * b^T
c_ij = ∑_k=1:n { a_ki * b_jk}

Parameters:

a - The left matrix in the multiplication operation. Not modified.

b - The right matrix in the multiplication operation. Not modified.

c - Where the results of the operation are stored. Modified.

multTransB

public static void multTransB(FixedMatrix5x5_64F a,
              FixedMatrix5x5_64F b,
              FixedMatrix5x5_64F c)

Performs the following operation:

c = a * b^T
c_ij = ∑_k=1:n { a_ik * b_jk}

Parameters:

a - The left matrix in the multiplication operation. Not modified.

b - The right matrix in the multiplication operation. Not modified.

c - Where the results of the operation are stored. Modified.

mult

public static void mult(FixedMatrix5x5_64F a,
        FixedMatrix5_64F b,
        FixedMatrix5_64F c)

Performs matrix to vector multiplication:

c = a * b

c_i = ∑_k=1:n { a_ik * b_k}

Parameters:

a - The left matrix in the multiplication operation. Not modified.

b - The right vector in the multiplication operation. Not modified.

c - Where the results of the operation are stored. Modified.

mult

public static void mult(FixedMatrix5_64F a,
        FixedMatrix5x5_64F b,
        FixedMatrix5_64F c)

Performs vector to matrix multiplication:

c = a * b

c_j = ∑_k=1:n { b_k * a_kj }

Parameters:

a - The left vector in the multiplication operation. Not modified.

b - The right matrix in the multiplication operation. Not modified.

c - Where the results of the operation are stored. Modified.

dot

public static double dot(FixedMatrix5_64F a,
         FixedMatrix5_64F b)

Performs the vector dot product:

c = a * b

c> = ∑_k=1:n { b_k * a_k }

Parameters:

a - The left vector in the multiplication operation. Not modified.

b - The right matrix in the multiplication operation. Not modified.

Returns:

The dot product

setIdentity

public static void setIdentity(FixedMatrix5x5_64F a)

Sets all the diagonal elements equal to one and everything else equal to zero. If this is a square matrix then it will be an identity matrix.

Parameters:

a - A matrix.

invert

public static boolean invert(FixedMatrix5x5_64F a,
             FixedMatrix5x5_64F inv)

Inverts matrix 'a' using minor matrices and stores the results in 'inv'. Scaling is applied to improve stability against overflow and underflow. WARNING: Potentially less stable than using LU decomposition.

Parameters:

a - Input matrix. Not modified.

inv - Inverted output matrix. Modified.

Returns:

true if it was successful or false if it failed. Not always reliable.

det

public static double det(FixedMatrix5x5_64F mat)

Computes the determinant using minor matrices.

WARNING: Potentially less stable than using LU decomposition.

Parameters:

mat - Input matrix. Not modified.

Returns:

The determinant.

trace

public static double trace(FixedMatrix5x5_64F a)

This computes the trace of the matrix:

trace = ∑_i=1:n { a_ii }

The trace is only defined for square matrices.

Parameters:

a - A square matrix. Not modified.

diag

public static void diag(FixedMatrix5x5_64F input,
        FixedMatrix5_64F out)

Extracts all diagonal elements from 'input' and places them inside the 'out' vector. Elements are in sequential order.

Parameters:

input - Matrix. Not modified.

out - Vector containing diagonal elements. Modified.

elementMax

public static double elementMax(FixedMatrix5x5_64F a)

Returns the value of the element in the matrix that has the largest value.

Max{ a_ij } for all i and j

Parameters:

a - A matrix. Not modified.

Returns:

The max element value of the matrix.

elementMaxAbs

public static double elementMaxAbs(FixedMatrix5x5_64F a)

Returns the absolute value of the element in the matrix that has the largest absolute value.

Max{ |a_ij| } for all i and j

Parameters:

a - A matrix. Not modified.

Returns:

The max abs element value of the matrix.

elementMin

public static double elementMin(FixedMatrix5x5_64F a)

Returns the value of the element in the matrix that has the minimum value.

Min{ a_ij } for all i and j

Parameters:

a - A matrix. Not modified.

Returns:

The value of element in the matrix with the minimum value.

elementMinAbs

public static double elementMinAbs(FixedMatrix5x5_64F a)

Returns the absolute value of the element in the matrix that has the smallest absolute value.

Min{ |a_ij| } for all i and j

Parameters:

a - A matrix. Not modified.

Returns:

The max element value of the matrix.

elementMult

public static void elementMult(FixedMatrix5x5_64F a,
               FixedMatrix5x5_64F b)

Performs the an element by element multiplication operation:

a_ij = a_ij * b_ij

Parameters:

a - The left matrix in the multiplication operation. Modified.

b - The right matrix in the multiplication operation. Not modified.

elementMult

public static void elementMult(FixedMatrix5x5_64F a,
               FixedMatrix5x5_64F b,
               FixedMatrix5x5_64F c)

Performs the an element by element multiplication operation:

c_ij = a_ij * b_ij

Parameters:

a - The left matrix in the multiplication operation. Not modified.

b - The right matrix in the multiplication operation. Not modified.

c - Where the results of the operation are stored. Modified.

elementDiv

public static void elementDiv(FixedMatrix5x5_64F a,
              FixedMatrix5x5_64F b)

Performs the an element by element division operation:

a_ij = a_ij / b_ij

Parameters:

a - The left matrix in the division operation. Modified.

b - The right matrix in the division operation. Not modified.

elementDiv

public static void elementDiv(FixedMatrix5x5_64F a,
              FixedMatrix5x5_64F b,
              FixedMatrix5x5_64F c)

Performs the an element by element division operation:

c_ij = a_ij / b_ij

Parameters:

a - The left matrix in the division operation. Not modified.

b - The right matrix in the division operation. Not modified.

c - Where the results of the operation are stored. Modified.

scale

public static void scale(double alpha,
         FixedMatrix5x5_64F a)

Performs an in-place element by element scalar multiplication.

a_ij = α*a_ij

Parameters:

a - The matrix that is to be scaled. Modified.

alpha - the amount each element is multiplied by.

scale

public static void scale(double alpha,
         FixedMatrix5x5_64F a,
         FixedMatrix5x5_64F b)

Performs an element by element scalar multiplication.

b_ij = α*a_ij

Parameters:

alpha - the amount each element is multiplied by.

a - The matrix that is to be scaled. Not modified.

b - Where the scaled matrix is stored. Modified.

divide

public static void divide(double alpha,
          FixedMatrix5x5_64F a)

Performs an in-place element by element scalar division.

a_ij = a_ij/α

Parameters:

a - The matrix whose elements are to be divided. Modified.

alpha - the amount each element is divided by.

divide

public static void divide(double alpha,
          FixedMatrix5x5_64F a,
          FixedMatrix5x5_64F b)

Performs an element by element scalar division.

b_ij = *a_ij /α

Parameters:

alpha - the amount each element is divided by.

a - The matrix whose elements are to be divided. Not modified.

b - Where the results are stored. Modified.

changeSign

public static void changeSign(FixedMatrix5x5_64F a)

Changes the sign of every element in the matrix.

a_ij = -a_ij

Parameters:

a - A matrix. Modified.

fill

public static void fill(FixedMatrix5x5_64F a,
        double v)

Sets every element in the matrix to the specified value.

a_ij = value

Parameters:

a - A matrix whose elements are about to be set. Modified.

v - The value each element will have.