com.interpss.core.sparse.impl

Class AbstractSparseEquation

java.lang.Object

com.interpss.core.sparse.impl.AbstractSparseEquation

All Implemented Interfaces:

ISparseEquation

Direct Known Subclasses:

SparseEqnComplexImpl, SparseEqnComplexMatrix3x3Impl, SparseEqnDoubleImpl, SparseEqnIntegerImpl

public abstract class AbstractSparseEquation
extends java.lang.Object
implements ISparseEquation

Base Sparse Equation for solving sparse matrix problems.

Nested Class Summary

Nested classes/interfaces inherited from interface org.interpss.numeric.sparse.base.ISparseEquation

ISparseEquation.IndexType

Constructor Summary

Constructors

Constructor and Description
AbstractSparseEquation(int n) Constructor
AbstractSparseEquation(int rows, int cols) Constructor

Method Summary

Modifier and Type	Method and Description
boolean	factorization() Factorization, for example LU decomposition, of the matrix.
boolean	factorization(double tolerance) Factorization, for example LU decomposition, of the matrix.
java.lang.String	getBusId(int row) get cached bus id by the row number
int	getDimension() get matrix dimension.
int	getDimension(ISparseEquation.IndexType type) get matrix dimension.
int	getZeroAii_row() During the LU process, aii might be zero.
boolean	isFactorized() Flag to indicate if the matrix is factorized
boolean	isSquareMatrix() Check if the matrix is square
void	setB2Zero() Set all b elements to 0.0
void	setBusId(int row, java.lang.String id) set bus id corresponding to the row
void	setFactorized(boolean isLUFac) set the factorized flag
void	setZeroAii_row(int i)
boolean	solveEqn(double tolerance) LU decomposition of the matrix and the solve the [A]X = B problem.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.interpss.numeric.sparse.base.ISparseEquation

getTotalElements, increaseDimension, reset, setB2Unity, setToZero, solveEqn

Constructor Detail

AbstractSparseEquation

public AbstractSparseEquation(int n)

Constructor

Parameters:

n - matrix dimension

AbstractSparseEquation

public AbstractSparseEquation(int rows,
                              int cols)

Constructor

Parameters:

n - matrix dimension

Method Detail

isSquareMatrix

public boolean isSquareMatrix()

Description copied from interface: ISparseEquation

Check if the matrix is square

Specified by:

isSquareMatrix in interface ISparseEquation

Returns:

true if it is a square matrix

getDimension

public int getDimension()

Description copied from interface: ISparseEquation

get matrix dimension.

Specified by:

getDimension in interface ISparseEquation

Returns:

the dimension

getDimension

public int getDimension(ISparseEquation.IndexType type)

Description copied from interface: ISparseEquation

get matrix dimension.

Specified by:

getDimension in interface ISparseEquation

Returns:

the dimension

getZeroAii_row

public int getZeroAii_row()

Description copied from interface: ISparseEquation

During the LU process, aii might be zero. An exception will be thrown. This function is for getting zero aii row number for error reporting

Specified by:

getZeroAii_row in interface ISparseEquation

Returns:

the row number

setZeroAii_row

public void setZeroAii_row(int i)

solveEqn

public boolean solveEqn(double tolerance)
                 throws IpssNumericException

LU decomposition of the matrix and the solve the [A]X = B problem.

Specified by:

solveEqn in interface ISparseEquation

Parameters:

tolerance - the tolerance for matrix singular detection

Returns:

if succeed return true.

Throws:

IpssNumericException

setB2Zero

public void setB2Zero()

Description copied from interface: ISparseEquation

Set all b elements to 0.0

Specified by:

setB2Zero in interface ISparseEquation

isFactorized

public boolean isFactorized()

Description copied from interface: ISparseEquation

Flag to indicate if the matrix is factorized

Specified by:

isFactorized in interface ISparseEquation

Returns:

the boolean flag

setFactorized

public void setFactorized(boolean isLUFac)

Description copied from interface: ISparseEquation

set the factorized flag

Specified by:

setFactorized in interface ISparseEquation

Parameters:

isLUFac - the flag

factorization

public boolean factorization()
                      throws IpssNumericException

Description copied from interface: ISparseEquation

Factorization, for example LU decomposition, of the matrix.

Specified by:

factorization in interface ISparseEquation

Returns:

if succeed return true.

Throws:

IpssNumericException

factorization

public boolean factorization(double tolerance)
                      throws IpssNumericException

Description copied from interface: ISparseEquation

Factorization, for example LU decomposition, of the matrix.

Specified by:

factorization in interface ISparseEquation

Parameters:

tolerance - the tolerance for matrix singular detection

Returns:

if succeed return true.

Throws:

IpssNumericException

getBusId

public java.lang.String getBusId(int row)

Description copied from interface: ISparseEquation

get cached bus id by the row number

Specified by:

getBusId in interface ISparseEquation

Parameters:

row - row number

Returns:

the bus id

setBusId

public void setBusId(int row,
                     java.lang.String id)

Description copied from interface: ISparseEquation

set bus id corresponding to the row

Specified by:

setBusId in interface ISparseEquation

Parameters:

row - row number

id - bus id