Package org.drip.spline.params

Class SegmentCustomBuilderControl

java.lang.Object

org.drip.spline.params.SegmentCustomBuilderControl

public class SegmentCustomBuilderControl
extends java.lang.Object

SegmentCustomBuilderControl holds the parameters the guide the creation/behavior of the segment. It holds the segment elastic/inelastic parameters and the named basis function set.

• SegmentCustomBuilderControl constructor
• Retrieve the Basis Spline Name
• Retrieve the Basis Set Parameters
• Retrieve the Segment Inelastic Controller
• Retrieve the Segment Shape Controller
• Retrieve the Preceeding Manifest Sensitivity Control Parameters

Module	Product Core Module
Library	Fixed Income Analytics
Project	Basis Splines and Linear Compounders across a Broad Family of Spline Basis Functions
Package	Spline Segment Construction Control Parameters

Author:

Lakshmi Krishnamurthy

Constructor Summary

Constructors

Constructor	Description
SegmentCustomBuilderControl(java.lang.String basisSpline, FunctionSetBuilderParams functionSetBuilderParams, SegmentInelasticDesignControl segmentInelasticDesignControl, ResponseScalingShapeControl responseScalingShapeControl, PreceedingManifestSensitivityControl preceedingManifestSensitivityControl)	SegmentCustomBuilderControl constructor

Method Summary

Modifier and Type	Method	Description
FunctionSetBuilderParams	basisSetParams()	Retrieve the Basis Set Parameters
java.lang.String	basisSpline()	Retrieve the Basis Spline Name
SegmentInelasticDesignControl	inelasticParams()	Retrieve the Segment Inelastic Parameters
PreceedingManifestSensitivityControl	preceedingManifestSensitivityControl()	Retrieve the Preceeding Manifest Sensitivity Control Parameters
ResponseScalingShapeControl	shapeController()	Retrieve the Segment Shape Controller

Methods inherited from class java.lang.Object

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

Constructor Details

SegmentCustomBuilderControl

public SegmentCustomBuilderControl(java.lang.String basisSpline,
FunctionSetBuilderParams functionSetBuilderParams,
SegmentInelasticDesignControl segmentInelasticDesignControl,
ResponseScalingShapeControl responseScalingShapeControl,
PreceedingManifestSensitivityControl preceedingManifestSensitivityControl)
                            throws java.lang.Exception

SegmentCustomBuilderControl constructor

Parameters:

basisSpline - Named Segment Basis Spline

functionSetBuilderParams - Segment Basis Set Construction Parameters

segmentInelasticDesignControl - Segment Design Inelastic Parameters

responseScalingShapeControl - Segment Shape Controller

preceedingManifestSensitivityControl - Preceeding Manifest Sensitivity Control Parameters

Throws:

java.lang.Exception - Thrown if inputs are invalid

Method Details

basisSpline

public java.lang.String basisSpline()

Retrieve the Basis Spline Name

Returns:

The Basis Spline Name

basisSetParams

public FunctionSetBuilderParams basisSetParams()

Retrieve the Basis Set Parameters

Returns:

The Basis Set Parameters

inelasticParams

public SegmentInelasticDesignControl inelasticParams()

Retrieve the Segment Inelastic Parameters

Returns:

The Segment Inelastic Parameters

shapeController

public ResponseScalingShapeControl shapeController()

Retrieve the Segment Shape Controller

Returns:

The Segment Shape Controller

preceedingManifestSensitivityControl

public PreceedingManifestSensitivityControl preceedingManifestSensitivityControl()

Retrieve the Preceeding Manifest Sensitivity Control Parameters

Returns:

The Preceeding Manifest Sensitivity Control Parameters