com.interpss.core.sparse.impl

Class SparseEqnIntegerImpl

java.lang.Object

com.interpss.core.sparse.impl.AbstractSparseEquation

com.interpss.core.sparse.impl.SparseEqnIntegerImpl

All Implemented Interfaces:

ISparseEquation, ISparseEqnInteger

public class SparseEqnIntegerImpl
extends AbstractSparseEquation
implements ISparseEqnInteger

Sparse Equation of data type integer. The purpose is for arranging network bus number to minimise the non-zero fill-ins. To outside, the index number is from 0 to n-1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SparseEqnIntegerImpl.IntAii Data structure for Integer sparse eqn implementation
static class	SparseEqnIntegerImpl.IntAij Data structure for Integer sparse eqn implementation

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

ISparseEquation.IndexType

Field Summary

Fields

Modifier and Type	Field and Description
static int	StatusOutCnt

Constructor Summary

Constructors

Constructor and Description
SparseEqnIntegerImpl()
SparseEqnIntegerImpl(int n)

Method Summary

Modifier and Type	Method and Description
void	arrangeRowNoT2() Arrange bus bus according to the Tinney-2 rule
void	arrangeRowNoT3() Arrange bus bus according to the Tinney-3 rule
boolean	factorization(double tolerance) Factorization, for example LU decomposition, of the matrix.
SparseEqnIntegerImpl.IntAij	getAij(SparseEqnIntegerImpl.IntAii ai, int j) get the Aij element
SparseEqnIntegerImpl.IntAii	getElem(int i) get the Aii element
int	getOld2New(int i) After the bus number arrangement, get the new bus number from an old bus number.
int	getTotalElements() Get the total elements in the matrix
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 sparse structure, and release memory if necessary
void	setAij(int n, int i, int j) Set the aij element
void	setB2Unity(int i) Set all b elements to 0.0 and bi = 1.0, a unity vector.
void	setToZero() Reset all matrix element to zero, preserve the matrix sparse 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, getBusId, getDimension, getDimension, getZeroAii_row, isFactorized, isSquareMatrix, setB2Zero, setBusId, 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, getBusId, getDimension, getDimension, getZeroAii_row, isFactorized, isSquareMatrix, setB2Zero, setBusId, setFactorized, solveEqn

Field Detail

StatusOutCnt

public static int StatusOutCnt

Constructor Detail

SparseEqnIntegerImpl

public SparseEqnIntegerImpl()

SparseEqnIntegerImpl

public SparseEqnIntegerImpl(int n)

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

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

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

Description copied from interface: ISparseEquation

Solve the [A]X = B problem

Specified by:

solveEqn in interface ISparseEquation

Throws:

IpssNumericException

setB2Unity

public void setB2Unity(int i)

Description copied from interface: ISparseEquation

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

Specified by:

setB2Unity in interface ISparseEquation

Parameters:

i - the element row number

reset

public void reset()

Description copied from interface: ISparseEquation

Reset the matrix to zero - set all aii and bi to 0.0 and clear the sparse structure, and release memory if necessary

Specified by:

reset in interface ISparseEquation

setToZero

public void setToZero()

Description copied from interface: ISparseEquation

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

Specified by:

setToZero in interface ISparseEquation

arrangeRowNoT2

public void arrangeRowNoT2()

Arrange bus bus according to the Tinney-2 rule

Specified by:

arrangeRowNoT2 in interface ISparseEqnInteger

arrangeRowNoT3

public void arrangeRowNoT3()

Arrange bus bus according to the Tinney-3 rule

Specified by:

arrangeRowNoT3 in interface ISparseEqnInteger

getAij

public SparseEqnIntegerImpl.IntAij getAij(SparseEqnIntegerImpl.IntAii ai,
                                          int j)

get the Aij element

Parameters:

ai -

j -

Returns:

getElem

public SparseEqnIntegerImpl.IntAii getElem(int i)

get the Aii element

Parameters:

i -

Returns:

getOld2New

public int getOld2New(int i)

After the bus number arrangement, get the new bus number from an old bus number.

Specified by:

getOld2New in interface ISparseEqnInteger

Parameters:

i - old bus number (1-n convention)

Returns:

the new bus number

setAij

public void setAij(int n,
                   int i,
                   int j)

Set the aij element

Specified by:

setAij in interface ISparseEqnInteger

Parameters:

n - the aij element

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

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

getTotalElements

public int getTotalElements()

Get the total elements in the matrix

Specified by:

getTotalElements in interface ISparseEquation

Returns:

the total elements

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