Class MacroBlock

java.lang.Object

solvers.linearSystem.btf.ComponentBlock

solvers.linearSystem.btf.macroBlocks.MacroBlock

Direct Known Subclasses:

B1MacroBlock, B2MacroBlock, CMacroBlock, XMacroBlock, YMacroBlock

public abstract class MacroBlock
extends ComponentBlock

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

Author:

Jack Bradshaw

Field Summary

Fields

Modifier and Type	Field	Description
protected int	h	Number of non-zeros in n associated to macro block
protected MicroBlock[]	micro_blocks	Array of contained micro blocks
protected MicroBlockSelectionPolicy	selection_policy	Encapsulated policy for selecting micro 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	MacroBlock(QNModel qnm, CoMoMBasis basis, Position position, int h)	Constructor - First phase of construction Initialises everything up to but not including the list of micro blocks
protected	MacroBlock(MacroBlock 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
void	initialise()	Second Phase of Construction This method initialises the list component micro blocks.
void	multiply(BigRational[] result)	Carries out the appropriate matrix multiplication operation for the block
protected abstract MicroBlock	newMicroBlock(Position block_position, int h)	Factory Method for Micro Blocks To be overridden by subclasses in order to create the appropriate subclass of MacroBlock in the parallel hierarchy.
protected int	numberOfMicroBlocks()	Method numberOfMicroBlocks.
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
MacroBlock	subBlock(int current_class)	Builder method that encapsulates the creation of sub-MacroBlock
protected abstract MacroBlock	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 the correct type) For instance, a copy of an XMacroBlocks needs to be a XMacroBlock

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

micro_blocks

protected MicroBlock[] micro_blocks

Array of contained micro blocks

selection_policy

protected MicroBlockSelectionPolicy selection_policy

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

h

protected int h

Number of non-zeros in n associated to macro block

Constructor Details

MacroBlock

protected MacroBlock(QNModel qnm,
 CoMoMBasis basis,
 Position position,
 int h)
              throws InternalErrorException,
InconsistentLinearSystemException

Constructor - First phase of construction Initialises everything up to but not including the list of micro 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:

InternalErrorException

InconsistentLinearSystemException

See Also:

• initialise()

MacroBlock

protected MacroBlock(MacroBlock full_block,
 int current_class)

Copy Constructor

Parameters:

full_block - Block to be copied

current_class - The class for which the copy is being created

Method Details

initialise

public void initialise()
                throws InternalErrorException,
InconsistentLinearSystemException

Second Phase of Construction This method initialises the list component micro blocks.

Throws:

InternalErrorException

InconsistentLinearSystemException

newMicroBlock

protected abstract MicroBlock newMicroBlock(Position block_position,
 int h)
                                     throws InternalErrorException,
InconsistentLinearSystemException

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

Parameters:

block_position - Starting position for the new macro block

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

Throws:

InternalErrorException

InconsistentLinearSystemException

subBlock

public MacroBlock subBlock(int current_class)

Builder method that encapsulates the creation of sub-MacroBlock

Parameters:

current_class - The class for which the copy is being created

Returns:

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

subBlockCopy

protected abstract MacroBlock 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 the correct type) For instance, a copy of an XMacroBlocks needs to be a XMacroBlock

Parameters:

current_class - The class for which the copy is created

Returns:

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

numberOfMicroBlocks

protected int numberOfMicroBlocks()

Method numberOfMicroBlocks.

Returns:

The number of micro blocks contain in this macro block

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.