com.opengamma.strata.market.curve

Class ParameterizedFunctionalCurve.Builder

java.lang.Object

org.joda.beans.impl.direct.DirectFieldsBeanBuilder<ParameterizedFunctionalCurve>

com.opengamma.strata.market.curve.ParameterizedFunctionalCurve.Builder

All Implemented Interfaces:

org.joda.beans.BeanBuilder<ParameterizedFunctionalCurve>

Enclosing class:

ParameterizedFunctionalCurve

public static final class ParameterizedFunctionalCurve.Builder
extends org.joda.beans.impl.direct.DirectFieldsBeanBuilder<ParameterizedFunctionalCurve>

The bean-builder for ParameterizedFunctionalCurve.

Method Summary

Modifier and Type	Method and Description
ParameterizedFunctionalCurve	build()
ParameterizedFunctionalCurve.Builder	derivativeFunction(BiFunction<DoubleArray,Double,Double> derivativeFunction) Sets the derivative function.
Object	get(String propertyName)
ParameterizedFunctionalCurve.Builder	metadata(CurveMetadata metadata) Sets the curve metadata.
ParameterizedFunctionalCurve.Builder	parameters(DoubleArray parameters) Sets the array of parameters for the curve function.
ParameterizedFunctionalCurve.Builder	sensitivityFunction(BiFunction<DoubleArray,Double,DoubleArray> sensitivityFunction) Sets the parameter sensitivity function.
ParameterizedFunctionalCurve.Builder	set(org.joda.beans.MetaProperty<?> property, Object value)
ParameterizedFunctionalCurve.Builder	set(String propertyName, Object newValue)
String	toString()
ParameterizedFunctionalCurve.Builder	valueFunction(BiFunction<DoubleArray,Double,Double> valueFunction) Sets the y-value function.

Methods inherited from class org.joda.beans.impl.direct.DirectFieldsBeanBuilder

get

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

get

public Object get(String propertyName)

Specified by:

get in interface org.joda.beans.BeanBuilder<ParameterizedFunctionalCurve>

Overrides:

get in class org.joda.beans.impl.direct.DirectFieldsBeanBuilder<ParameterizedFunctionalCurve>

set

public ParameterizedFunctionalCurve.Builder set(String propertyName,
                                                Object newValue)

set

public ParameterizedFunctionalCurve.Builder set(org.joda.beans.MetaProperty<?> property,
                                                Object value)

Specified by:

set in interface org.joda.beans.BeanBuilder<ParameterizedFunctionalCurve>

Overrides:

set in class org.joda.beans.impl.direct.DirectFieldsBeanBuilder<ParameterizedFunctionalCurve>

build

public ParameterizedFunctionalCurve build()

metadata

public ParameterizedFunctionalCurve.Builder metadata(CurveMetadata metadata)

Sets the curve metadata.

The metadata includes an optional list of parameter metadata. If present, the size of the parameter metadata list will match the number of parameters of this curve.

Parameters:

metadata - the new value, not null

Returns:

this, for chaining, not null

parameters

public ParameterizedFunctionalCurve.Builder parameters(DoubleArray parameters)

Sets the array of parameters for the curve function.

Parameters:

parameters - the new value, not null

Returns:

this, for chaining, not null

valueFunction

public ParameterizedFunctionalCurve.Builder valueFunction(BiFunction<DoubleArray,Double,Double> valueFunction)

Sets the y-value function.

The function takes parameters and x-value, then returns y-value.

Parameters:

valueFunction - the new value, not null

Returns:

this, for chaining, not null

derivativeFunction

public ParameterizedFunctionalCurve.Builder derivativeFunction(BiFunction<DoubleArray,Double,Double> derivativeFunction)

Sets the derivative function.

The function takes parameters and x-value, then returns the first derivative of y-value with respective to x, i.e., the gradient of the curve.

Parameters:

derivativeFunction - the new value, not null

Returns:

this, for chaining, not null

sensitivityFunction

public ParameterizedFunctionalCurve.Builder sensitivityFunction(BiFunction<DoubleArray,Double,DoubleArray> sensitivityFunction)

Sets the parameter sensitivity function.

The function takes parameters and x-value, then returns the sensitivities of y-value to the parameters.

Parameters:

sensitivityFunction - the new value, not null

Returns:

this, for chaining, not null

toString

public String toString()

Overrides:

toString in class org.joda.beans.impl.direct.DirectFieldsBeanBuilder<ParameterizedFunctionalCurve>