net.sourceforge.combean.interfaces.mathprog.lp.model
Interface LPModel

All Known Implementing Classes:

ConstructableLPModel

public interface LPModel

A linear programming model consisting of variables, constraints and components of the constraint matrix. A model shall provide the possibility to define a linear model in a problem oriented way, i.e., more comfortably than through the low level interface of an LPSolver. The components of the model are composed into one global model by using strings as symbolic offset for the position within the global model. Constraints and variables are grouped in sequences which are positioned in consecutive rows resp. columns in the global model. Every such sequence has an offset identifer. By querying for that identifer, the sequence and its position in the global model can be retrieved.

Method Summary

LPConstraintSequence	getConstraintSequence(String rowOffsetId) Get the constraint sequence for a given offset identifier.
Iterator	getConstraintSequences() Get an iterator through sequences of constraints.
Iterator	getModelComponents() Get an iterator through all components of the model.
int	getNumColumns() The number of columns in the model.
int	getNumRows() The number of rows in the model.
LPVariableSequence	getVariableSequence(String columnOffsetId) Get the variable sequence for a given offset identifier.
Iterator	getVariableSequences() Get an iterator through sequences of variables.

Method Detail

getNumRows

int getNumRows()

The number of rows in the model.

Returns:

the number of rows.

getNumColumns

int getNumColumns()

The number of columns in the model.

Returns:

the number of columns.

getConstraintSequences

Iterator getConstraintSequences()

Get an iterator through sequences of constraints.

Returns:

an iterator through sequences of constraints.

getConstraintSequence

LPConstraintSequence getConstraintSequence(String rowOffsetId)

Get the constraint sequence for a given offset identifier.

Parameters:

rowOffsetId - the offset identifier for the row.

Returns:

the corresponding constraint sequence (or null if no matching sequence exists).

getVariableSequences

Iterator getVariableSequences()

Get an iterator through sequences of variables.

Returns:

an iterator through sequences of variables.

getVariableSequence

LPVariableSequence getVariableSequence(String columnOffsetId)

Get the variable sequence for a given offset identifier.

Parameters:

columnOffsetId - the offset identfier for the column.

Returns:

the correponding variable sequence. (or null if no matching sequence exists).

getModelComponents

Iterator getModelComponents()

Get an iterator through all components of the model.

Returns:

an iterator through all components of the model.