com.interpss.core.sparse.impl

Class AbstractSparseEqnDoubleImpl

java.lang.Object

com.interpss.core.sparse.impl.AbstractSparseEquation<ISparseEqnSolver>

com.interpss.core.sparse.impl.AbstractSparseEqnDoubleImpl

All Implemented Interfaces:

ISparseEquation, ISparseEqnDouble

Direct Known Subclasses:

AbstractSparseEqnMatrix2x2Impl, CSJSparseEqnDoubleImpl

public abstract class AbstractSparseEqnDoubleImpl
extends AbstractSparseEquation<ISparseEqnSolver>
implements ISparseEqnDouble

Abstract Sparse Equation of data type double for solving the [A]X=B problem. To outside, the index number is from 0 to n-1. When [A] is a square matrix, LU decomposition method is used to solve the eqn When [A] is a non-square matrix, QR decomposition method is used to provide a Least Square or Weighted Least Square solution

Nested Class Summary

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

ISparseEquation.IndexType

Field Summary

Fields

Modifier and Type	Field and Description
protected DoubleSEqnRow[]	aryAii

Fields inherited from class com.interpss.core.sparse.impl.AbstractSparseEquation

colCnt, factored, rowCnt, solver, squareMatrix, zeroAii_row

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addToAij(double x, int i, int j) Add the aij element to the matrix.
void	addToBi(double bi, int i) Set bi element.
double	err(double[] x)
boolean	factorization() Decomposition of the matrix.
boolean	factorization(double tolerance) Decomposition of the matrix.
double	getAij(int i, int j) Get the aij element.
java.lang.String	getBusId(int row) get cached bus id by the row number
DoubleSEqnRow	getElem(int i)
int	getTotalElements() Get the total elements in the matrix
double	getXi(int i) Get the bi element.
double[]	getXVector() Get the b/x vector
void	increaseDimension() Increase matrix dimension by 1.
void	reset() Reset the matrix to zero - set all aii and bi to 0.0 and clear the aijList
void	setAij(double x, int i, int j) Set the aij element.
void	setB2Unity(int i) Set all b elements to 0.0 and bi = 1.0, a unit vector.
void	setB2Zero() Set all b elements to 0.0 and bi = 1.0, a unit vector.
void	setBi(double bi, int i) Set bi element.
void	setBusId(int row, java.lang.String id) set bus id corresponding to the row
void	setBVector(double[] b) Set b/x vector.
void	setElem(int i, DoubleSEqnRow aii)
void	setToZero() Reset all matrix element to zero, preserve the matrix structure.
void	solveEqn() Solve the [A]X = B problem
double[]	solveLUedEqn(double[] b) Solve the [A]X = B problem
java.lang.String	toString() Get the string representation of the matrix object

Methods inherited from class com.interpss.core.sparse.impl.AbstractSparseEquation

getDimension, getDimension, getZeroAii_row, isFactorized, isSquareMatrix, setFactorized, setZeroAii_row, solveEqn

Methods inherited from class java.lang.Object

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

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

getDimension, getDimension, getZeroAii_row, isFactorized, isSquareMatrix, setFactorized, solveEqn

Field Detail

aryAii

protected DoubleSEqnRow[] aryAii

Constructor Detail

AbstractSparseEqnDoubleImpl

public AbstractSparseEqnDoubleImpl(int n)

AbstractSparseEqnDoubleImpl

public AbstractSparseEqnDoubleImpl(int rows,
                                   int cols)

Method Detail

increaseDimension

public void increaseDimension()

Description copied from interface: ISparseEquation

Increase matrix dimension by 1. B[n] = 0.0, aii(n)=1.0, aij(n)=0.0

Specified by:

increaseDimension in interface ISparseEquation

Parameters:

n - matrix dimension

addToAij

public void addToAij(double x,
                     int i,
                     int j)

Add the aij element to the matrix. If aij exists, aij += x.

Specified by:

addToAij in interface ISparseEqnDouble

Parameters:

x - the aij element

i - the element row number

j - the element column number

getElem

public DoubleSEqnRow getElem(int i)

setElem

public void setElem(int i,
                    DoubleSEqnRow aii)

setAij

public void setAij(double x,
                   int i,
                   int j)

Set the aij element.

Specified by:

setAij in interface ISparseEqnDouble

Parameters:

x - the aij element

i - the element row number (1-n convention)

j - the element column number (1-n convention)

getAij

public double getAij(int i,
                     int j)

Description copied from interface: ISparseEqnDouble

Get the aij element.

Specified by:

getAij in interface ISparseEqnDouble

Parameters:

i - the element row number

j - the element column number

setB2Zero

public void setB2Zero()

Set all b elements to 0.0 and bi = 1.0, a unit vector.

Specified by:

setB2Zero in interface ISparseEquation

Overrides:

setB2Zero in class AbstractSparseEquation<ISparseEqnSolver>

Parameters:

i - the element row number

setB2Unity

public void setB2Unity(int i)

Set all b elements to 0.0 and bi = 1.0, a unit vector.

Specified by:

setB2Unity in interface ISparseEquation

Parameters:

i - the element row number

getXi

public double getXi(int i)

Get the bi element.

Specified by:

getXi in interface ISparseEqnDouble

Parameters:

i - the element row number

Returns:

the bi element

getXVector

public double[] getXVector()

Get the b/x vector

Parameters:

i - the element row number

Returns:

the bi element

setBVector

public void setBVector(double[] b)

Set b/x vector.

Parameters:

b - the b vector

setBi

public void setBi(double bi,
                  int i)

Set bi element.

Specified by:

setBi in interface ISparseEqnDouble

Parameters:

bi - the bi element

i - row number (1-n convention)

addToBi

public void addToBi(double bi,
                    int i)

Set bi element.

Specified by:

addToBi in interface ISparseEqnDouble

Parameters:

bi - the bi element

i - row number

reset

public void reset()

Reset the matrix to zero - set all aii and bi to 0.0 and clear the aijList

Specified by:

reset in interface ISparseEquation

setToZero

public void setToZero()

Reset all matrix element to zero, preserve the matrix structure.

Specified by:

setToZero in interface ISparseEquation

solveEqn

public void solveEqn()
              throws IpssNumericException

Solve the [A]X = B problem

Specified by:

solveEqn in interface ISparseEquation

Throws:

IpssNumericException

solveLUedEqn

public double[] solveLUedEqn(double[] b)
                      throws IpssNumericException

Solve the [A]X = B problem

Specified by:

solveLUedEqn in interface ISparseEqnDouble

Throws:

IpssNumericException

factorization

public boolean factorization()
                      throws IpssNumericException

Decomposition of the matrix.

Specified by:

factorization in interface ISparseEquation

Overrides:

factorization in class AbstractSparseEquation<ISparseEqnSolver>

Parameters:

tolerance - the tolerance for matrix singular detection

Returns:

if succeed return true.

Throws:

IpssNumericException

factorization

public boolean factorization(double tolerance)
                      throws IpssNumericException

Decomposition of the matrix.

Specified by:

factorization in interface ISparseEquation

Overrides:

factorization in class AbstractSparseEquation<ISparseEqnSolver>

Parameters:

tolerance - the tolerance for matrix singular detection

Returns:

if succeed return true.

Throws:

IpssNumericException

getTotalElements

public int getTotalElements()

Get the total elements in the matrix

Specified by:

getTotalElements in interface ISparseEquation

Returns:

the total elements

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

Overrides:

getBusId in class AbstractSparseEquation<ISparseEqnSolver>

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

Overrides:

setBusId in class AbstractSparseEquation<ISparseEqnSolver>

Parameters:

row - row number

id - bus id

toString

public java.lang.String toString()

Get the string representation of the matrix object

Overrides:

toString in class java.lang.Object

Returns:

the string representation

err

public double err(double[] x)