org.itc.idv.math
Interface AlgorithmOnList

All Superinterfaces:

AlgorithmN

public interface AlgorithmOnList
extends AlgorithmN

List of algorithms with the same signature

Concept discussed between Jan Hendrikse, Willem Nieuwenhuis and Wim Koolhoven on 23-08-05.

Author:

Wim Koolhoven

Method Summary

Algorithm	getAlgorithm(int index) returns the requested Algorithm
int	getNrAlgorithms()
int	getNrParams()
java.lang.String	getParamDescription(int paramNr) may return a Description of the parameter.
java.lang.String	getParamName(int paramNr) returns the Name of the parameter.

Methods inherited from interface org.itc.idv.math.AlgorithmN

calculate

Method Detail

getNrParams

int getNrParams()

Returns:

the number of parameters. This is the maximum of all the algorithms

getParamName

java.lang.String getParamName(int paramNr)
                              throws java.lang.IndexOutOfBoundsException

returns the Name of the parameter. All Algorithms are supposed to use the same names

Parameters:

paramNr - starts counting at 0

Returns:

the Name of parameter paramNr

Throws:

java.lang.IndexOutOfBoundsException - when paramNr is negative or larger or equal to {#getNrParams()}

getParamDescription

java.lang.String getParamDescription(int paramNr)
                                     throws java.lang.IndexOutOfBoundsException

may return a Description of the parameter. Intended to give the end user more information. All Algorithms are supposed to use the same description

Parameters:

paramNr - starts counting at 0

Returns:

the Name of parameter paramNr

Throws:

java.lang.IndexOutOfBoundsException - when paramNr is negative or larger or equal to {#getNrParams()}

getNrAlgorithms

int getNrAlgorithms()

Returns:

the number of Algorithms

getAlgorithm

Algorithm getAlgorithm(int index)

returns the requested Algorithm

Parameters:

index -

Returns:

the Algorithm