Package org.moeaframework.analysis.sensitivity

Class SobolSensitivityAnalysis.SobolSensitivityResult

java.lang.Object

org.moeaframework.analysis.sensitivity.SobolSensitivityAnalysis.SobolSensitivityResult

All Implemented Interfaces:

FirstOrderSensitivity, SecondOrderSensitivity, SensitivityResult, TotalOrderSensitivity, Displayable

Enclosing class:

SobolSensitivityAnalysis

public class SobolSensitivityAnalysis.SobolSensitivityResult
extends Object
implements SensitivityResult, FirstOrderSensitivity, SecondOrderSensitivity, TotalOrderSensitivity

Computes the results of the Sobol' global variance decomposition procedure.

Method Summary

Modifier and Type	Method	Description
void	display(PrintStream out)	Displays the contents of this object to the given output stream.
Sensitivity<Parameter<?>>	getFirstOrder(Parameter<?> key)	Returns the first-order effect for the given parameter.
ParameterSet	getParameterSet()	Returns the parameter set associated with this sensitivity analysis.
Sensitivity<org.apache.commons.lang3.tuple.Pair<Parameter<?>,Parameter<?>>>	getSecondOrder(Parameter<?> left, Parameter<?> right)	Returns the second-order effect for the given parameters.
Sensitivity<Parameter<?>>	getTotalOrder(Parameter<?> key)	Returns the total-order effect for the given parameter.
void	save(PrintWriter output)	Computes and displays the first-, total-, and second- order Sobol' sensitivities and 50% bootstrap confidence intervals.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.moeaframework.util.format.Displayable

display

Methods inherited from interface org.moeaframework.analysis.sensitivity.FirstOrderSensitivity

getFirstOrder

Methods inherited from interface org.moeaframework.analysis.sensitivity.SecondOrderSensitivity

getSecondOrder

Methods inherited from interface org.moeaframework.analysis.sensitivity.TotalOrderSensitivity

getTotalOrder

Method Details

getParameterSet

public ParameterSet getParameterSet()

Description copied from interface: SensitivityResult

Returns the parameter set associated with this sensitivity analysis.

Specified by:

getParameterSet in interface SensitivityResult

Returns:

the parameter set

getFirstOrder

public Sensitivity<Parameter<?>> getFirstOrder(Parameter<?> key)

Description copied from interface: FirstOrderSensitivity

Returns the first-order effect for the given parameter.

Specified by:

getFirstOrder in interface FirstOrderSensitivity

Parameters:

key - the parameter

Returns:

the first-order effect

getTotalOrder

public Sensitivity<Parameter<?>> getTotalOrder(Parameter<?> key)

Description copied from interface: TotalOrderSensitivity

Returns the total-order effect for the given parameter.

Specified by:

getTotalOrder in interface TotalOrderSensitivity

Parameters:

key - the parameter

Returns:

the total-order effect

getSecondOrder

public Sensitivity<org.apache.commons.lang3.tuple.Pair<Parameter<?>,Parameter<?>>> getSecondOrder(Parameter<?> left,
 Parameter<?> right)

Description copied from interface: SecondOrderSensitivity

Returns the second-order effect for the given parameters.

Specified by:

getSecondOrder in interface SecondOrderSensitivity

Parameters:

left - the first parameter

right - the second parameter

Returns:

the second-order effect

save

public void save(PrintWriter output)

Computes and displays the first-, total-, and second- order Sobol' sensitivities and 50% bootstrap confidence intervals.

Parameters:

output - the output writer

display

public void display(PrintStream out)

Description copied from interface: Displayable

Displays the contents of this object to the given output stream. This method does not close the underlying stream; the caller is responsible for disposing it.

Specified by:

display in interface Displayable

Parameters:

out - the output stream