Class XBlock

java.lang.Object

solvers.linearSystem.btf.ComponentBlock

solvers.linearSystem.btf.topLevelBlocks.TopLevelBlock

solvers.linearSystem.btf.topLevelBlocks.ATopLevelBlock

solvers.linearSystem.btf.topLevelBlocks.XBlock

public class XBlock
extends ATopLevelBlock

This class implements the X Block of the A matrix. The Factory Methods newMacroBlock, newSecondaryMacroBlock and subBlockCopy are implemented to return the correct block type in the parallel hierarchy. Type 1 Macro Blocks are selected for lower class linear systems

Author:

Jack Bradshaw

Field Summary

Fields inherited from class ATopLevelBlock

sec_macro_blocks

Fields inherited from class TopLevelBlock

macro_blocks, selection_policy

Fields inherited from class ComponentBlock

basis, cols_printed, current_class, position, qnm, size

Constructor Summary

Constructors

Constructor	Description
XBlock(QNModel qnm, CoMoMBasis basis)
XBlock(QNModel qnm, CoMoMBasis basis, Position position)
XBlock(XBlock full_block, int current_class)

Method Summary

Modifier and Type	Method	Description
void	LUPDecompose(boolean in_place)
protected MacroBlock	newMacroBlock(Position block_position, int h)	Factory Method for Macro Blocks To be overridden by subclasses in order to create the appropriate subclass of MacroBlock in the parallel hierarchy.
protected void	newSecondaryMacroBlock(int h, MacroBlock block_1, MacroBlock block_2)	Factory Method for Secondary Macro Blocks To be overridden by subclasses in order to create the appropriate subclass of SecondaryMacroBlock in the parallel hierarchy.
void	printRow2(int row)	Prints a line of the block if the contains the row.
protected TopLevelBlock	subBlockCopy(int current_class)	Factory Method for sub-block creation This method is to be overridden by subclasses to instantiate a copy of the current block of correct type

Methods inherited from class ATopLevelBlock

addCE, addPC, initialise, multiply, solve, subBlock

Methods inherited from class TopLevelBlock

findMacroBlock

Methods inherited from class ComponentBlock

getStartingCol, getStartingRow, newLine, size

Methods inherited from class Object

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

Constructor Details

XBlock

public XBlock(QNModel qnm,
 CoMoMBasis basis)
       throws BTFMatrixErrorException,
InternalErrorException,
InconsistentLinearSystemException

Throws:

BTFMatrixErrorException

InternalErrorException

InconsistentLinearSystemException

XBlock

public XBlock(QNModel qnm,
 CoMoMBasis basis,
 Position position)
       throws BTFMatrixErrorException,
InternalErrorException,
InconsistentLinearSystemException

Throws:

BTFMatrixErrorException

InternalErrorException

InconsistentLinearSystemException

XBlock

public XBlock(XBlock full_block,
 int current_class)
       throws BTFMatrixErrorException

Throws:

BTFMatrixErrorException

Method Details

subBlockCopy

protected TopLevelBlock subBlockCopy(int current_class)
                              throws BTFMatrixErrorException,
InternalErrorException,
InconsistentLinearSystemException

Description copied from class: TopLevelBlock

Factory Method for sub-block creation This method is to be overridden by subclasses to instantiate a copy of the current block of correct type

Specified by:

subBlockCopy in class TopLevelBlock

Parameters:

current_class - The class for which the copy is created

Returns:

A shallow copy of calling block, for the current_class. Without macro blocks.

Throws:

BTFMatrixErrorException

InternalErrorException

InconsistentLinearSystemException

newMacroBlock

protected MacroBlock newMacroBlock(Position block_position,
 int h)
                            throws InternalErrorException,
InconsistentLinearSystemException

Description copied from class: TopLevelBlock

Factory Method for Macro Blocks To be overridden by subclasses in order to create the appropriate subclass of MacroBlock in the parallel hierarchy. i.e. XBlocks are composed of XMacroBlocks

Specified by:

newMacroBlock in class TopLevelBlock

Parameters:

block_position - Starting position for the new macro block

h - Number of non-zeros associated with the macro block

Throws:

InternalErrorException

InconsistentLinearSystemException

newSecondaryMacroBlock

protected void newSecondaryMacroBlock(int h,
 MacroBlock block_1,
 MacroBlock block_2)
                               throws BTFMatrixErrorException

Description copied from class: ATopLevelBlock

Factory Method for Secondary Macro Blocks To be overridden by subclasses in order to create the appropriate subclass of SecondaryMacroBlock in the parallel hierarchy.

Specified by:

newSecondaryMacroBlock in class ATopLevelBlock

Parameters:

h -

block_1 -

block_2 -

Throws:

BTFMatrixErrorException

LUPDecompose

public void LUPDecompose(boolean in_place)
                  throws InconsistentLinearSystemException

Throws:

InconsistentLinearSystemException

printRow2

public void printRow2(int row)

Description copied from class: ComponentBlock

Prints a line of the block if the contains the row. The number of columns printed for the current row is incremented accordingly.

Overrides:

printRow2 in class TopLevelBlock

Parameters:

row - The absolute row of the overall matrix to be printed.