ExecutionInitializationOutput

java.lang.Object
- org.drip.function.r1tor1solver.ExecutionInitializationOutput

Direct Known Subclasses:

BracketingOutput, ConvergenceOutput
```
public abstract class ExecutionInitializationOutput
extends java.lang.Object
```
ExecutionInitializationOutput holds the output of the root initializer calculation. The following are the fields held by ExecutionInitializationOutput: - Whether the initialization completed successfully - the number of iterations, the number of objective function calculations, and the time taken for the initialization - the starting variate from the initialization

Author:

Lakshmi Krishnamurthy

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`displayString()` Return a string form of the Initializer output
`int`	`getNumIterations()` Return The number of Iterations consumed
`int`	`getNumOFCalcs()` Retrieve the number of objective function calculations needed
`int`	`getNumOFDerivCalcs()` Retrieve the number of objective function derivative calculations needed
`double`	`getStartingVariate()` Return the Starting Variate
`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`	`isDone()` Indicate if the execution initialization is done
`boolean`	`setStartingVariate(double dblStartingVariate)` Set the Starting Variate
`double`	`time()` Return the time elapsed for the execution initialization operation

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - incrIterations
```
public final boolean incrIterations()
```
    Increment the Number of Iterations
    
    Returns:
    
    TRUE - Successfully incremented
  - getNumIterations
```
public final int getNumIterations()
```
    Return The number of Iterations consumed
    
    Returns:
    
    Number of Iterations consumed
  - incrOFCalcs
```
public final boolean incrOFCalcs()
```
    Increment the Number of Objective Function Evaluations
    
    Returns:
    
    TRUE - Successfully incremented
  - getNumOFCalcs
```
public final int getNumOFCalcs()
```
    Retrieve the number of objective function calculations needed
    
    Returns:
    
    Number of objective function calculations needed
  - incrOFDerivCalcs
```
public final boolean incrOFDerivCalcs()
```
    Increment the number of Objective Function Derivative evaluations
    
    Returns:
    
    TRUE - Successfully incremented
  - getNumOFDerivCalcs
```
public final int getNumOFDerivCalcs()
```
    Retrieve the number of objective function derivative calculations needed
    
    Returns:
    
    Number of objective function derivative calculations needed
  - isDone
```
public final boolean isDone()
```
    Indicate if the execution initialization is done
    
    Returns:
    
    TRUE - Execution initialization is done
  - time
```
public final double time()
```
    Return the time elapsed for the execution initialization operation
    
    Returns:
    
    execution initialization time
  - setStartingVariate
```
public boolean setStartingVariate(double dblStartingVariate)
```
    Set the Starting Variate
    
    Parameters:
    
    dblStartingVariate - Starting Variate
    
    Returns:
    
    TRUE - Starting Variate set successfully
  - getStartingVariate
```
public double getStartingVariate()
```
    Return the Starting Variate
    
    Returns:
    
    Starting Variate
  - displayString
```
public java.lang.String displayString()
```
    Return a string form of the Initializer output
    
    Returns:
    
    String form of the Initializer output

Class ExecutionInitializationOutput

Method Summary

Methods inherited from class java.lang.Object

Method Detail

incrIterations

getNumIterations

incrOFCalcs

getNumOFCalcs

incrOFDerivCalcs

getNumOFDerivCalcs

isDone

time

setStartingVariate

getStartingVariate

displayString