org.drip.spline.stretch

Interface SegmentSequenceBuilder

All Known Implementing Classes:

CkSegmentSequenceBuilder, LatentStateSequenceBuilder

public interface SegmentSequenceBuilder

SegmentSequenceBuilder is the interface that contains the stubs required for the construction of the segment stretch. It exposes the following functions: - Set the Stretch whose Segments are to be calibrated - Retrieve the Calibration Boundary Condition - Calibrate the Starting Segment using the LeftSlope - Calibrate the Segment Sequence in the Stretch

Author:

Lakshmi Krishnamurthy

Method Summary

Modifier and Type	Method and Description
boolean	calibSegmentSequence(int iStartingSegment) Calibrate the Segment Sequence in the Stretch
boolean	calibStartingSegment(double dblLeftSlope) Calibrate the Starting Segment using the LeftSlope
BoundarySettings	getCalibrationBoundaryCondition() Retrieve the Calibration Boundary Condition
boolean	manifestMeasureSensitivity(double dblLeftSlopeSensitivity) Compute the Stretch Manifest Measure Sensitivity Sequence
boolean	setStretch(MultiSegmentSequence mss) Set the Stretch whose Segments are to be calibrated

Method Detail

setStretch

boolean setStretch(MultiSegmentSequence mss)

Set the Stretch whose Segments are to be calibrated

Parameters:

mss - The Stretch that needs to be calibrated

Returns:

TRUE - Stretch successfully set

getCalibrationBoundaryCondition

BoundarySettings getCalibrationBoundaryCondition()

Retrieve the Calibration Boundary Condition

Returns:

The Calibration Boundary Condition

calibStartingSegment

boolean calibStartingSegment(double dblLeftSlope)

Calibrate the Starting Segment using the LeftSlope

Parameters:

dblLeftSlope - The Slope

Returns:

TRUE - The Segment was successfully set up.

calibSegmentSequence

boolean calibSegmentSequence(int iStartingSegment)

Calibrate the Segment Sequence in the Stretch

Parameters:

iStartingSegment - The Starting Segment in the Sequence

Returns:

TRUE - The Segment Sequence successfully calibrated

manifestMeasureSensitivity

boolean manifestMeasureSensitivity(double dblLeftSlopeSensitivity)

Compute the Stretch Manifest Measure Sensitivity Sequence

Parameters:

dblLeftSlopeSensitivity - The Leading Segment Left Slope Sensitivity

Returns:

TRUE - The Stretch Manifest Measure Sensitivity Sequence successfully computed