com.ftlabs.fisa.calc
Interface YieldConvergence

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
AbstractYieldConvergence, BinaryYieldConvergence, DefaultYieldConvergence

public interface YieldConvergence
extends java.io.Serializable

This interface provides a method for converging on a yield from a specified price.


Method Summary
 double converge(double price, double approximateYield, YieldConvergable convergable)
          Converge upon a yield from the provided price and approximate yield.
 double getPrecision()
          Get the required precision.
 void setPrecision(double precision)
          Set the required precision.
 

Method Detail

converge

double converge(double price,
                double approximateYield,
                YieldConvergable convergable)
                throws CalculationException
Converge upon a yield from the provided price and approximate yield.

Parameters:
price - price.
approximateYield - A starting approximate yield.
convergable - The YieldConvergable implementation used to calculate price.
Returns:
yield.
Throws:
CalculationException

setPrecision

void setPrecision(double precision)
Set the required precision.

Parameters:
precision - The required precision.

getPrecision

double getPrecision()
Get the required precision.

Returns:
The required precision.