org.drip.function.r1tor1solver

Class ConvergenceOutput

java.lang.Object

org.drip.function.r1tor1solver.ExecutionInitializationOutput

org.drip.function.r1tor1solver.ConvergenceOutput

public class ConvergenceOutput
extends ExecutionInitializationOutput

ConvergenceOutput extends the ExecutionInitializationOutput by retaining the starting variate that results from the convergence zone search. ConvergenceOutput does not add any new field to ExecutionInitializationOutput.

Author:

Lakshmi Krishnamurthy

Constructor Summary

Constructors

Constructor and Description
ConvergenceOutput() Default ConvergenceOutput constructor: Initializes the output object
ConvergenceOutput(ExecutionInitializationOutput eiop) Initialize off of an existing EIOP

Method Summary

Modifier and Type	Method and Description
boolean	done(double dblStartingVariate) Indicate that the initialization is completed

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

displayString, 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 Detail

ConvergenceOutput

public ConvergenceOutput()

Default ConvergenceOutput constructor: Initializes the output object

ConvergenceOutput

public ConvergenceOutput(ExecutionInitializationOutput eiop)
                  throws java.lang.Exception

Initialize off of an existing EIOP

Parameters:

eiop - EIOP

Throws:

java.lang.Exception - Thrown if inputs are invalid

Method Detail

done

public boolean done(double dblStartingVariate)

Indicate that the initialization is completed

Parameters:

dblStartingVariate - Starting Variate

Returns:

TRUE - Initialization successfully completed