Class TopLevelBlock

java.lang.Object

solvers.linearSystem.btf.ComponentBlock

solvers.linearSystem.btf.topLevelBlocks.TopLevelBlock

Direct Known Subclasses:

ATopLevelBlock, B1Block, B2Block, CBlock

public abstract class TopLevelBlock
extends ComponentBlock

This class is a superclass for the five main components of the BTF linear system: X, Y, B1, B2 and C. It is composed of MacroBlocks and implements the methods that intialise and handle them. A MacroBlockSelectionPolicy must be specified by any concrete implementation, this will be used to select which MacroBlocks to use in lower class linear systems.

Author:

Jack Bradshaw

Field Summary

Fields

Modifier and Type	Field	Description
protected MacroBlock[]	macro_blocks	The list of Macro Blocks contained in the TopLevelBlock
protected MacroBlockSelectionPolicy	selection_policy	Encapsulated policy for selecting macro blocks when creating sub-blocks for lower classes

Fields inherited from class ComponentBlock

basis, cols_printed, current_class, position, qnm, size

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TopLevelBlock(QNModel qnm, CoMoMBasis basis, Position position)	Constructor - First phase of construction Initialises everything up to but not including the list of macro blocks
protected	TopLevelBlock(TopLevelBlock full_block, int current_class)	Copy Constructor

Method Summary

Modifier and Type	Method	Description
int	addCE(int position, PopulationChangeVector n, int queue)	Adds the appropriate coefficients of a Convolution Expression to the block
int	addPC(int position, PopulationChangeVector n, int _class)	Adds the appropriate coefficients of a Population Constraint to the block
protected int	findMacroBlock(int position)	Finds the macro which contains a specified column (row)
void	initialise()	Second Phase of Construction This method intialises the list component macro blocks.
void	multiply(BigRational[] result)	Carries out the appropriate matrix multiplication operation for the block
protected abstract MacroBlock	newMacroBlock(Position 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.
void	printRow2(int row)	Prints a line of the block if the contains the row.
void	solve(BigRational[] rhs)	Makes the block carry out its role in the solution of the linear system
TopLevelBlock	subBlock(int current_class)	Builder method that encapsulates the creation of sub-TopLevelBlocks
protected abstract 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 ComponentBlock

getStartingCol, getStartingRow, newLine, size

Methods inherited from class Object

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

Field Details

macro_blocks

protected MacroBlock[] macro_blocks

The list of Macro Blocks contained in the TopLevelBlock

selection_policy

protected MacroBlockSelectionPolicy selection_policy

Encapsulated policy for selecting macro blocks when creating sub-blocks for lower classes

Constructor Details

TopLevelBlock

protected TopLevelBlock(QNModel qnm,
 CoMoMBasis basis,
 Position position)
                 throws BTFMatrixErrorException,
InternalErrorException,
InconsistentLinearSystemException

Constructor - First phase of construction Initialises everything up to but not including the list of macro blocks

Parameters:

qnm - The Model under consideration

basis - The corresponding basis for the model

position - The starting position (top right hand corner) of the block

Throws:

BTFMatrixErrorException

InternalErrorException

InconsistentLinearSystemException

See Also:

• initialise()

TopLevelBlock

protected TopLevelBlock(TopLevelBlock full_block,
 int current_class)

Copy Constructor

Method Details

initialise

public void initialise()
                throws BTFMatrixErrorException,
InternalErrorException,
InconsistentLinearSystemException

Second Phase of Construction This method intialises the list component macro blocks.

Throws:

BTFMatrixErrorException

InternalErrorException

InconsistentLinearSystemException

newMacroBlock

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

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

Parameters:

position - Starting position for the new macro block

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

Throws:

InternalErrorException

InconsistentLinearSystemException

subBlockCopy

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

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

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

subBlock

public TopLevelBlock subBlock(int current_class)
                       throws BTFMatrixErrorException,
InternalErrorException,
InconsistentLinearSystemException

Builder method that encapsulates the creation of sub-TopLevelBlocks

Parameters:

current_class - The class for which the copy is created

Returns:

A shallow copy of calling block, containing the correct macro blocks for the current_class

Throws:

BTFMatrixErrorException

InternalErrorException

InconsistentLinearSystemException

findMacroBlock

protected int findMacroBlock(int position)
                      throws BTFMatrixErrorException

Finds the macro which contains a specified column (row)

Parameters:

position - The number of the column (row)

Returns:

The index of containing MacroBlock in the list macro_blocks

Throws:

BTFMatrixErrorException

addCE

public int addCE(int position,
 PopulationChangeVector n,
 int queue)
          throws BTFMatrixErrorException,
InternalErrorException

Description copied from class: ComponentBlock

Adds the appropriate coefficients of a Convolution Expression to the block

Specified by:

addCE in class ComponentBlock

Parameters:

position - Carries information on where to insert the equation depending on the context (can be interpreted differently by subclasses)

n - The Population Change Vector n to which the equation relates

queue - The queue k to which the equation relates; 1 <= k <= M

Returns:

The row at which the equation was inserted

Throws:

BTFMatrixErrorException

InternalErrorException

addPC

public int addPC(int position,
 PopulationChangeVector n,
 int _class)
          throws BTFMatrixErrorException,
InternalErrorException

Description copied from class: ComponentBlock

Adds the appropriate coefficients of a Population Constraint to the block

Specified by:

addPC in class ComponentBlock

Parameters:

position - Carries information on where to insert the equation depending on the context (can be interpreted differently by subclasses)

n - The Population Change Vector n to which the equation relates

_class - The class r to which the equation relates; 1 <= r <= R

Returns:

The row at which the equation was inserted

Throws:

BTFMatrixErrorException

InternalErrorException

multiply

public void multiply(BigRational[] result)
              throws BTFMatrixErrorException

Description copied from class: ComponentBlock

Carries out the appropriate matrix multiplication operation for the block

Specified by:

multiply in class ComponentBlock

Parameters:

result - Result vector

Throws:

BTFMatrixErrorException

solve

public void solve(BigRational[] rhs)
           throws BTFMatrixErrorException,
OperationNotSupportedException,
InconsistentLinearSystemException,
InternalErrorException

Description copied from class: ComponentBlock

Makes the block carry out its role in the solution of the linear system

Specified by:

solve in class ComponentBlock

Parameters:

rhs - The intermediate basis used during the computation of the solution

Throws:

BTFMatrixErrorException

OperationNotSupportedException

InconsistentLinearSystemException

InternalErrorException

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.

Specified by:

printRow2 in class ComponentBlock

Parameters:

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