ISparseEquation

All Known Subinterfaces:

ISparseEqnComplex, ISparseEqnComplexMatrix3x3, ISparseEqnDouble, ISparseEqnInteger, ISparseEqnMatrix2x2, ISparseEqnObject<TAij,TBi>

All Known Implementing Classes:

AbstractSparseEqnComplexImpl, AbstractSparseEqnComplexMatrix3x3Impl, AbstractSparseEqnDoubleImpl, AbstractSparseEqnMatrix2x2Impl, AbstractSparseEquation, CSJSparseEqnComplexImpl, CSJSparseEqnComplexMatrix3x3Impl, CSJSparseEqnDoubleImpl, CSJSparseEqnMatrix2x2Impl, SparseEqnIntegerImpl
```
public interface ISparseEquation
```
Base Sparse Equation for solving sparse matrix problems.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class ISparseEquation.IndexType

Nested Classes
Modifier and Type	Interface and Description
`static class`	`ISparseEquation.IndexType`

Method Summary

All Methods Instance Methods Abstract Methods
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`	`getTotalElements()` Get the total elements in the matrix
`int`	`getZeroAii_row()` During the LU process, aii might be zero.
`void`	`increaseDimension()` Increase matrix dimension by 1.
`boolean`	`isFactorized()` Flag to indicate if the matrix is factorized
`boolean`	`isSquareMatrix()` Check if the matrix is square
`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`	`setB2Unity(int i)` Set all b elements to 0.0 and bi = 1.0, a unity vector.
`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`	`setToZero()` Reset all matrix element to zero, preserve the matrix sparse structure.
`void`	`solveEqn()` Solve the [A]X = B problem
`boolean`	`solveEqn(double tolerance)` LU decomposition of the matrix and the solve the [A]X = B problem.

- Method Detail
  - isSquareMatrix
```
boolean isSquareMatrix()
```
    Check if the matrix is square
    
    Returns:
    
    true if it is a square matrix
  - getTotalElements
```
int getTotalElements()
```
    Get the total elements in the matrix
    
    Returns:
    
    the total elements
  - setB2Unity
```
void setB2Unity(int i)
```
    Set all b elements to 0.0 and bi = 1.0, a unity vector.
    
    Parameters:
    
    i - the element row number
  - setB2Zero
```
void setB2Zero()
```
    Set all b elements to 0.0
  - reset
```
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
  - setToZero
```
void setToZero()
```
    Reset all matrix element to zero, preserve the matrix sparse structure.
  - isFactorized
```
boolean isFactorized()
```
    Flag to indicate if the matrix is factorized
    
    Returns:
    
    the boolean flag
  - setFactorized
```
void setFactorized(boolean isLUFac)
```
    set the factorized flag
    
    Parameters:
    
    isLUFac - the flag
  - getDimension
```
int getDimension()
```
    get matrix dimension.
    
    Returns:
    
    the dimension
  - increaseDimension
```
void increaseDimension()
```
    Increase matrix dimension by 1. B[n] = 0.0, aii(n)=1.0, aij(n)=0.0
    
    Parameters:
    
    n -
  - factorization
```
boolean factorization()
               throws IpssNumericException
```
    Factorization, for example LU decomposition, of the matrix.
    
    Returns:
    
    if succeed return true.
    
    Throws:
    
    IpssNumericException
  - factorization
```
boolean factorization(double tolerance)
               throws IpssNumericException
```
    Factorization, for example LU decomposition, of the matrix.
    
    Parameters:
    
    tolerance - the tolerance for matrix singular detection
    
    Returns:
    
    if succeed return true.
    
    Throws:
    
    IpssNumericException
  - solveEqn
```
boolean solveEqn(double tolerance)
          throws IpssNumericException
```
    LU decomposition of the matrix and the solve the [A]X = B problem.
    
    Parameters:
    
    tolerance - the tolerance for matrix singular detection
    
    Returns:
    
    if succeed return true.
    
    Throws:
    
    IpssNumericException
  - solveEqn
```
void solveEqn()
       throws IpssNumericException
```
    Solve the [A]X = B problem
    
    Throws:
    
    IpssNumericException
  - getZeroAii_row
```
int getZeroAii_row()
```
    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
    
    Returns:
    
    the row number
  - getBusId
```
java.lang.String getBusId(int row)
```
    get cached bus id by the row number
    
    Parameters:
    
    row - row number
    
    Returns:
    
    the bus id
  - setBusId
```
void setBusId(int row,
              java.lang.String id)
```
    set bus id corresponding to the row
    
    Parameters:
    
    row - row number
    
    id - bus id
  - getDimension
```
int getDimension(ISparseEquation.IndexType type)
```
    get matrix dimension.
    
    Returns:
    
    the dimension

Interface ISparseEquation

Nested Class Summary

Method Summary

Method Detail

isSquareMatrix

getTotalElements

setB2Unity

setB2Zero

reset

setToZero

isFactorized

setFactorized

getDimension

increaseDimension

factorization

factorization

solveEqn

solveEqn

getZeroAii_row

getBusId

setBusId

getDimension