net.finmath.analytic.model.curves.CurveInterface Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of finmath-lib Show documentation

finmath lib is a Mathematical Finance Library in Java. It provides algorithms and methodologies related to mathematical finance.

There is a newer version: 6.0.19

Show newest version

/*
 * (c) Copyright Christian P. Fries, Germany. Contact: [email protected].
 *
 * Created on 30.11.2012
 */
package net.finmath.analytic.model.curves;

import java.time.LocalDate;

import net.finmath.analytic.calibration.ParameterObjectInterface;
import net.finmath.analytic.model.AnalyticModelInterface;
import net.finmath.stochastic.RandomVariableInterface;

/**
 * The interface which is implemented by a general curve.
 * 
 * @author Christian Fries
 */
public interface CurveInterface extends ParameterObjectInterface, Cloneable {

	/**
	 * Get the name of the curve.
	 * 
	 * @return The name of this curve
	 */
	String getName();

	/**
	 * Return the reference date of this curve, i.e. the date
	 * associated with t=0.
	 * 
	 * May be null in case the curve is not associated with a fixed date (e.g. a time homogenous model).
	 * 
	 * @return The date identified as t=0.
	 */
	LocalDate getReferenceDate();

	/**
	 * Returns the value for the time using the interpolation method associated with this curve.
	 * 
	 * @param time Time for which the value should be returned.
	 * @return The value at the give time.
	 */
	RandomVariableInterface getValue(double time);

	/**
	 * Returns the value for the time using the interpolation method associated with this curve
	 * within a given context, i.e., a model. The model (context) is needed only if the curve
	 * relies on another curve. Examples are a forward curve which relies on a discount curve or
	 * a discount curve which is defined via a spread over another curve.
	 *  
	 * @param model An analytic model providing a context.
	 * @param time Time for which the value should be returned.
	 * 
	 * @return The value at the give time.
	 */
     RandomVariableInterface getValue(AnalyticModelInterface model, double time);

	/**
	 * Create a deep copied clone.
	 * 
	 * @return A clone (deep copied).
	 * @throws CloneNotSupportedException Thrown, when the curve could not be cloned.
	 */
	Object clone() throws CloneNotSupportedException;

	/**
	 * Returns a curve builder bases on a clone of this curve. Using that curve
	 * builder you may create a new curve from this curve by adding points or
	 * changing properties.
	 * Note: The clone has the same name than this one.
	 * 
	 * @return An object implementing the CurveBuilderInterface where the underlying curve is a clone of this curve.
	 * @throws CloneNotSupportedException Thrown, when this curve could not be cloned.
	 */
	CurveBuilderInterface getCloneBuilder() throws CloneNotSupportedException;

	@Override
	CurveInterface getCloneForParameter(RandomVariableInterface[] value) throws CloneNotSupportedException;
}