org.drip.function.r1tor1solver

Class FixedPointFinderOutput

java.lang.Object

org.drip.function.r1tor1solver.FixedPointFinderOutput

public class FixedPointFinderOutput
extends java.lang.Object

FixedPointFinderOutput holds the result of the fixed point search. FixedPointFinderOutput contains the following fields: - Whether the search completed successfully - The number of iterations, the number of objective function base/derivative calculations, and the time taken for the search - The output from initialization

Author:

Lakshmi Krishnamurthy

Constructor Summary

Constructors

Constructor and Description
FixedPointFinderOutput(ExecutionInitializationOutput eiop) FixedPointFinderOutput constructor

Method Summary

Modifier and Type	Method and Description
boolean	containsRoot() Indicate whether the root is present in the output, i.e., if the finder has successfully completed.
java.lang.String	displayString() Return a string form of the root finder output
ExecutionInitializationOutput	getEIOP() Retrieve the Execution Initialization Output
int	getNumIterations() Return The number of iterations taken
int	getNumOFCalcs() Retrieve the number of objective function calculations needed
int	getNumOFDerivCalcs() Retrieve the number of objective function derivative calculations needed
double	getRoot() Return the root
boolean	incrIterations() Increment the number of Iterations
boolean	incrOFCalcs() Increment the number of Objective Function evaluations
boolean	incrOFDerivCalcs() Increment the number of Objective Function Derivative evaluations
boolean	setRoot(double dblRoot) Set the Root
double	time() Return the time elapsed for the the full root finding operation

Methods inherited from class java.lang.Object

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

Constructor Detail

FixedPointFinderOutput

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

FixedPointFinderOutput constructor

Parameters:

eiop - Execution Initialization Output 1D

Throws:

java.lang.Exception - Thrown if inputs are invalid

Method Detail

setRoot

public boolean setRoot(double dblRoot)

Set the Root

Parameters:

dblRoot - Root

Returns:

TRUE - Successfully set

containsRoot

public boolean containsRoot()

Indicate whether the root is present in the output, i.e., if the finder has successfully completed.

Returns:

TRUE - Root exists in the output

time

public double time()

Return the time elapsed for the the full root finding operation

Returns:

Time taken for root finding

getRoot

public double getRoot()

Return the root

Returns:

Root

incrIterations

public boolean incrIterations()

Increment the number of Iterations

Returns:

TRUE - Successfully incremented

getNumIterations

public int getNumIterations()

Return The number of iterations taken

Returns:

Number of iterations taken

incrOFCalcs

public boolean incrOFCalcs()

Increment the number of Objective Function evaluations

Returns:

TRUE - Successfully incremented

getNumOFCalcs

public int getNumOFCalcs()

Retrieve the number of objective function calculations needed

Returns:

Number of objective function calculations needed

incrOFDerivCalcs

public boolean incrOFDerivCalcs()

Increment the number of Objective Function Derivative evaluations

Returns:

TRUE - Successfully incremented

getNumOFDerivCalcs

public int getNumOFDerivCalcs()

Retrieve the number of objective function derivative calculations needed

Returns:

Number of objective function derivative calculations needed

getEIOP

public ExecutionInitializationOutput getEIOP()

Retrieve the Execution Initialization Output

Returns:

Execution Initialization Output

displayString

public java.lang.String displayString()

Return a string form of the root finder output

Returns:

String form of the root finder output