Class ATopLevelBlock

java.lang.Object

solvers.linearSystem.btf.ComponentBlock

solvers.linearSystem.btf.topLevelBlocks.TopLevelBlock

solvers.linearSystem.btf.topLevelBlocks.ATopLevelBlock

Direct Known Subclasses:

XBlock, YBlock

public abstract class ATopLevelBlock
extends TopLevelBlock

This class extends TopLevelBlock to also include a list of SecondaryMacroBlocks. This is required of the two blocks of the A matrix: XBlock and YBlock

Author:

Jack Bradshaw

Field Summary

Fields

Modifier and Type	Field	Description
protected SecondaryMacroBlock[]	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

Modifier	Constructor	Description
protected	ATopLevelBlock(QNModel qnm, CoMoMBasis basis, Position position)	Constructor - First phase of creation, does not initialise MacroBlocks or SecondaryMacroBlocks
protected	ATopLevelBlock(ATopLevelBlock 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()	initialise() overridden to further create list of SecondaryMacroBlocks
void	multiply(BigRational[] result)	Carries out the appropriate matrix multiplication operation for the block
protected abstract 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	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-ATopLevelBlocks Fills list of MacroBlocks as super class.

Methods inherited from class TopLevelBlock

findMacroBlock, newMacroBlock, printRow2, subBlockCopy

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

sec_macro_blocks

protected SecondaryMacroBlock[] sec_macro_blocks

Constructor Details

ATopLevelBlock

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

Constructor - First phase of creation, does not initialise MacroBlocks or SecondaryMacroBlocks

Parameters:

qnm -

basis -

position -

Throws:

BTFMatrixErrorException

InternalErrorException

InconsistentLinearSystemException

See Also:

• initialise()
• initialiseSecondaryMacroBlocks()

ATopLevelBlock

protected ATopLevelBlock(ATopLevelBlock full_block,
 int current_class)
                  throws BTFMatrixErrorException

Copy Constructor

Throws:

BTFMatrixErrorException

Method Details

subBlock

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

Builder method that encapsulates the creation of sub-ATopLevelBlocks Fills list of MacroBlocks as super class. Fills list of SecondaryMacroBlocks.

Overrides:

subBlock in class TopLevelBlock

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

initialise

public void initialise()
                throws BTFMatrixErrorException,
InternalErrorException,
InconsistentLinearSystemException

initialise() overridden to further create list of SecondaryMacroBlocks

Overrides:

initialise in class TopLevelBlock

Throws:

BTFMatrixErrorException

InternalErrorException

InconsistentLinearSystemException

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

Overrides:

addCE in class TopLevelBlock

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

newSecondaryMacroBlock

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

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

Parameters:

h -

block_1 -

block_2 -

Throws:

BTFMatrixErrorException

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

Overrides:

addPC in class TopLevelBlock

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

Overrides:

multiply in class TopLevelBlock

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

Overrides:

solve in class TopLevelBlock

Parameters:

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

Throws:

BTFMatrixErrorException

OperationNotSupportedException

InconsistentLinearSystemException

InternalErrorException