IteratedVariate

java.lang.Object

org.drip.function.r1tor1solver.IteratedVariate

public class IteratedVariate
extends java.lang.Object

IteratedVariate holds the variate and the corresponding value for the objective function during each iteration.

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

IteratedVariate(ExecutionInitializationOutput eiop, double dblOF)
IteratedVariate constructor

Method Summary

Modifier and Type	Method	Description
`double`	`getOF()`	Retrieve the Objective Function Value
`double`	`getVariate()`	Retrieve the variate
`boolean`	`setOF(double dblOF)`	Set the Objective Function Value
`boolean`	`setVariate(double dblVariate)`	Set the variate

Methods inherited from class java.lang.Object

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

Constructor Details
- IteratedVariate
  
  public IteratedVariate(ExecutionInitializationOutput eiop, double dblOF) throws java.lang.Exception
  
  IteratedVariate constructor
  
  Parameters:
  
  eiop - Execution Initialization Output
  
  dblOF - Objective Function Value
  
  Throws:
  
  java.lang.Exception - Thrown if inputs are invalid
Method Details
- getVariate
  
  public double getVariate()
  
  Retrieve the variate
  
  Returns:
  
  Variate
- setVariate
  
  public boolean setVariate(double dblVariate)
  
  Set the variate
  
  Parameters:
  
  dblVariate - Variate
  
  Returns:
  
  TRUE - Variate set successfully
- getOF
  
  public double getOF()
  
  Retrieve the Objective Function Value
  
  Returns:
  
  The Objective Function Value
- setOF
  
  public boolean setOF(double dblOF)
  
  Set the Objective Function Value
  
  Parameters:
  
  dblOF - Objective Function Value
  
  Returns:
  
  TRUE - Objective Function Value set successfully