io.capsisBridgeClient

Class CBSimulationResult

java.lang.Object

io.capsisBridgeClient.CBSimulationResult

public class CBSimulationResult
extends java.lang.Object

This class implements a data transfer object returned by the runSimulation() method.

Since:

2020-12-22

See Also:

AbstractCapsisBridgeClient.runSimulation()

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CBSimulationResult.Matrix This class implements a data transfer Matrix object contained in CBSimulationResult.

Method Summary

Modifier and Type	Method and Description
CBDataSet	getDataSet() dataset accessor
CBSimulationResult.Matrix	getModelVariance() modelVariance matrix accessor
int	getNbRealizations() nbRealizations accessor
java.util.List<java.lang.String>	getOutputTypes() outputTypes accessor
CBSimulationResult.Matrix	getSamplingVariance() samplingVariance matrix accessor
CBSimulationResult.Matrix	getY() Y matrix accessor
boolean	isEqualTo(CBSimulationResult r, double tolerance) Comparison method.
void	setModelVariance(CBSimulationResult.Matrix m) modelVariance matrix setter
void	setNbRealizations(int _nbRealizations) nbRealizations accessor
void	setSamplingVariance(CBSimulationResult.Matrix m) samplingVariance matrix setter
void	setY(CBSimulationResult.Matrix m) Y matrix setter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getNbRealizations

public int getNbRealizations()

nbRealizations accessor

Returns:

The number of realizations used in this result calculation

setNbRealizations

public void setNbRealizations(int _nbRealizations)

nbRealizations accessor

Parameters:

_nbRealizations - number of realizations used in this result calculation

getDataSet

public CBDataSet getDataSet()

dataset accessor

Returns:

The dataset

getOutputTypes

public java.util.List<java.lang.String> getOutputTypes()

outputTypes accessor

Returns:

The outputTypes as a list of strings

getY

public CBSimulationResult.Matrix getY()

Y matrix accessor

Returns:

matrix y

setY

public void setY(CBSimulationResult.Matrix m)

Y matrix setter

Parameters:

m - matrix to set y to

getModelVariance

public CBSimulationResult.Matrix getModelVariance()

modelVariance matrix accessor

Returns:

matrix modelVariance

setModelVariance

public void setModelVariance(CBSimulationResult.Matrix m)

modelVariance matrix setter

Parameters:

m - matrix to set modelVariance to

getSamplingVariance

public CBSimulationResult.Matrix getSamplingVariance()

samplingVariance matrix accessor

Returns:

matrix samplingVariance

setSamplingVariance

public void setSamplingVariance(CBSimulationResult.Matrix m)

samplingVariance matrix setter

Parameters:

m - matrix to set samplingVariance to

isEqualTo

public boolean isEqualTo(CBSimulationResult r,
                         double tolerance)

Comparison method.

Parameters:

r - a CBSimulationResult to compare with

tolerance - The tolerance under which values should be considered equal

Returns:

true if r is equal to this in respect to the given tolerance, false if not