Package org.drip.function.r1tor1solver

Class BracketingOutput

java.lang.Object

org.drip.function.r1tor1solver.ExecutionInitializationOutput

org.drip.function.r1tor1solver.BracketingOutput

public class BracketingOutput
extends ExecutionInitializationOutput

BracketingOutput carries the results of the bracketing initialization.

In addition to the fields of ExecutionInitializationOutput, BracketingOutput holds the left/right bracket variates and the corresponding values for the objective function.

• Module = Computational Core Module
• Library = Numerical Analysis Library
• Project = R^d To R^d Function Analysis
• Package = Built-in R¹ To R¹ Solvers

Author:

Lakshmi Krishnamurthy

Constructor Summary

Constructors

Constructor	Description
BracketingOutput()	Default BracketingOutput constructor: Initializes the output

Method Summary

Modifier and Type	Method	Description
java.lang.String	displayString()	Return a string form of the Initializer output
boolean	done(double dblVariateLeft, double dblVariateRight, double dblOFLeft, double dblOFRight, double dblStartingVariate)	Set the brackets in the output object
double	getOFLeft()	Return the left OF
double	getOFRight()	Return the Right OF
double	getVariateLeft()	Return the left Variate
double	getVariateRight()	Return the Right Variate
ConvergenceOutput	makeConvergenceVariate()	Make a ConvergenceOutput for the Open Method from the bracketing output

Methods inherited from class org.drip.function.r1tor1solver.ExecutionInitializationOutput

getNumIterations, getNumOFCalcs, getNumOFDerivCalcs, getStartingVariate, incrIterations, incrOFCalcs, incrOFDerivCalcs, isDone, setStartingVariate, time

Methods inherited from class java.lang.Object

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

Constructor Details

BracketingOutput

public BracketingOutput()

Default BracketingOutput constructor: Initializes the output

Method Details

getVariateLeft

public double getVariateLeft()

Return the left Variate

Returns:

Left Variate

getVariateRight

public double getVariateRight()

Return the Right Variate

Returns:

Right Variate

getOFLeft

public double getOFLeft()

Return the left OF

Returns:

Left OF

getOFRight

public double getOFRight()

Return the Right OF

Returns:

Right OF

done

public boolean done(double dblVariateLeft,
double dblVariateRight,
double dblOFLeft,
double dblOFRight,
double dblStartingVariate)

Set the brackets in the output object

Parameters:

dblVariateLeft - Left Variate

dblVariateRight - Right Variate

dblOFLeft - Left OF

dblOFRight - Right OF

dblStartingVariate - Starting Variate

Returns:

TRUE - Successfully set

makeConvergenceVariate

public ConvergenceOutput makeConvergenceVariate()

Make a ConvergenceOutput for the Open Method from the bracketing output

Returns:

The ConvergenceOutput object

displayString

public java.lang.String displayString()

Description copied from class: ExecutionInitializationOutput

Return a string form of the Initializer output

Overrides:

displayString in class ExecutionInitializationOutput

Returns:

String form of the Initializer output