com.interpss.core.sparse.impl

Class SparseEqnComplexImpl

java.lang.Object

com.interpss.core.sparse.impl.AbstractSparseEquation

com.interpss.core.sparse.impl.SparseEqnComplexImpl

All Implemented Interfaces:

ISparseEqnObject<org.apache.commons.math3.complex.Complex,org.apache.commons.math3.complex.Complex>, ISparseEquation, ISparseEqnComplex

public class SparseEqnComplexImpl
extends AbstractSparseEquation
implements ISparseEqnComplex

Sparse Equation of data type complex for solving the [A]X=B problem. To outside, the index number is from 0 to n-1

Nested Class Summary

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

ISparseEquation.IndexType

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addToA(org.apache.commons.math3.complex.Complex x, int i, int j) Add the aij element to the matrix.
void	addToB(org.apache.commons.math3.complex.Complex bi, int i) add to bi element.
boolean	factorization(double tolerance) LU decomposition of the matrix.
org.apache.commons.math3.complex.Complex	getA(int i, int j) Get the aij element.
java.lang.String	getBusId(int row) get cached bus id by the row number
SparseEqnDataType.ComAii	getElem(int i)
int	getTotalElements() Get the total elements in the matrix
org.apache.commons.math3.complex.Complex	getX(int i) Get the bi element.
int	getZeroA_row() Get zero aii row number, in case the matrix is singular
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	setA(org.apache.commons.math3.complex.Complex 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.
void	setBi(org.apache.commons.math3.complex.Complex bi, int i) Set bi element.
void	setBusId(int row, java.lang.String id) set bus id corresponding to the row
void	setElem(int i, SparseEqnDataType.ComAii aii)
void	setToZero() Reset all matrix element to zero, preserve the matrix structure.
void	solveEqn() 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

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

Methods inherited from class java.lang.Object

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

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

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

Constructor Detail

SparseEqnComplexImpl

public SparseEqnComplexImpl(int n)

SparseEqnComplexImpl

public SparseEqnComplexImpl(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

addToA

public void addToA(org.apache.commons.math3.complex.Complex x,
                   int i,
                   int j)

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

Specified by:

addToA in interface ISparseEqnObject<org.apache.commons.math3.complex.Complex,org.apache.commons.math3.complex.Complex>

Parameters:

x - the aij element

i - the element row number

j - the element column number

getX

public org.apache.commons.math3.complex.Complex getX(int i)

Get the bi element.

Specified by:

getX in interface ISparseEqnObject<org.apache.commons.math3.complex.Complex,org.apache.commons.math3.complex.Complex>

Parameters:

i - the element row number

Returns:

the bi element

getElem

public SparseEqnDataType.ComAii getElem(int i)

setElem

public void setElem(int i,
                    SparseEqnDataType.ComAii aii)

setA

public void setA(org.apache.commons.math3.complex.Complex x,
                 int i,
                 int j)

Set the aij element.

Specified by:

setA in interface ISparseEqnObject<org.apache.commons.math3.complex.Complex,org.apache.commons.math3.complex.Complex>

Parameters:

x - the aij element

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

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

getA

public org.apache.commons.math3.complex.Complex getA(int i,
                                                     int j)

Get the aij element.

Specified by:

getA in interface ISparseEqnObject<org.apache.commons.math3.complex.Complex,org.apache.commons.math3.complex.Complex>

Parameters:

i - the element row number

j - the element column number

Returns:

aij

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

setB2Zero

public void setB2Zero()

Set all b elements to 0.0.

Specified by:

setB2Zero in interface ISparseEquation

Overrides:

setB2Zero in class AbstractSparseEquation

setBi

public void setBi(org.apache.commons.math3.complex.Complex bi,
                  int i)

Set bi element.

Specified by:

setBi in interface ISparseEqnObject<org.apache.commons.math3.complex.Complex,org.apache.commons.math3.complex.Complex>

Parameters:

bi - the bi element

i - row number

addToB

public void addToB(org.apache.commons.math3.complex.Complex bi,
                   int i)

Description copied from interface: ISparseEqnObject

add to bi element.

Specified by:

addToB in interface ISparseEqnObject<org.apache.commons.math3.complex.Complex,org.apache.commons.math3.complex.Complex>

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

factorization

public boolean factorization(double tolerance)
                      throws IpssNumericException

LU decomposition of the matrix.

Specified by:

factorization in interface ISparseEquation

Overrides:

factorization in class AbstractSparseEquation

Parameters:

tolerance - the tolerance for matrix singular detection

Returns:

if succeed return true.

Throws:

IpssNumericException

solveEqn

public void solveEqn()
              throws IpssNumericException

Solve the [A]X = B problem

Specified by:

solveEqn in interface ISparseEquation

Throws:

IpssNumericException

getTotalElements

public int getTotalElements()

Get the total elements in the matrix

Specified by:

getTotalElements in interface ISparseEquation

Returns:

the total elements

getZeroA_row

public int getZeroA_row()

Description copied from interface: ISparseEqnObject

Get zero aii row number, in case the matrix is singular

Specified by:

getZeroA_row in interface ISparseEqnObject<org.apache.commons.math3.complex.Complex,org.apache.commons.math3.complex.Complex>

Returns:

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

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

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