Class CMicroBlock

java.lang.Object

solvers.linearSystem.btf.ComponentBlock

solvers.linearSystem.btf.microBlocks.MicroBlock

solvers.linearSystem.btf.microBlocks.CMicroBlock

public class CMicroBlock
extends MicroBlock

This class implements the Micro Blocks of the Carry Forward Equations componet of the Linear System.

Author:

Jack Bradshaw

Field Summary

Fields inherited from class ComponentBlock

basis, cols_printed, current_class, position, qnm, size

Constructor Summary

Constructors

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

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 void	computeDimensions()	Computes the dimensions of block and stores them in the member field size
protected void	initialiseDataStructures()	Initialise any underlying data structures
void	multiply(BigRational[] result)	Carries out the appropriate matrix multiplication operation for the block
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
protected MicroBlock	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 XMicroBlocks needs to be a XMicroBlock

Methods inherited from class MicroBlock

initialise, subBlock

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

CMicroBlock

public CMicroBlock(QNModel qnm,
 CoMoMBasis basis,
 Position position,
 int h)
            throws InternalErrorException

Throws:

InternalErrorException

CMicroBlock

public CMicroBlock(CMicroBlock full_block,
 int current_class)

Method Details

subBlockCopy

protected MicroBlock subBlockCopy(int current_class)

Description copied from class: MicroBlock

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 XMicroBlocks needs to be a XMicroBlock

Specified by:

subBlockCopy in class MicroBlock

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.

initialiseDataStructures

protected void initialiseDataStructures()
                                 throws InternalErrorException

Description copied from class: MicroBlock

Initialise any underlying data structures

Specified by:

initialiseDataStructures in class MicroBlock

Throws:

InternalErrorException

computeDimensions

protected void computeDimensions()

Description copied from class: MicroBlock

Computes the dimensions of block and stores them in the member field size

Specified by:

computeDimensions in class MicroBlock

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.

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)

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