org.drip.spline.stretch

Class MultiSegmentSequenceModifier

java.lang.Object

org.drip.spline.stretch.MultiSegmentSequenceModifier

public class MultiSegmentSequenceModifier
extends java.lang.Object

MultiSegmentSequenceModifier exports Stretch modification/alteration methods to generate customized basis splines, with customized segment behavior using the segment control. It exposes the following stretch modification methods: - Insert the specified Predictor Ordinate Knot into the specified Stretch, using the specified Response Value. - Append a Segment to the Right of the Specified Stretch using the Supplied Constraint. - Insert the Predictor Ordinate Knot into the specified Stretch. - Insert a Cardinal Knot into the specified Stretch at the specified Predictor Ordinate Location. - Insert a Catmull-Rom Knot into the specified Stretch at the specified Predictor Ordinate Location.

Author:

Lakshmi Krishnamurthy

Constructor Summary

Constructors

Constructor and Description
MultiSegmentSequenceModifier()

Method Summary

Modifier and Type	Method and Description
static MultiSegmentSequence	AppendSegment(MultiSegmentSequence mssIn, double dblPredictorOrdinateAppendRight, SegmentResponseValueConstraint srvc, SegmentCustomBuilderControl scbc, BoundarySettings bs, int iCalibrationDetail) Append a Segment to the Right of the Specified Stretch using the Supplied Constraint
static MultiSegmentSequence	InsertCardinalKnot(MultiSegmentSequence mssIn, double dblPredictorOrdinate, double dblCardinalTension) Insert a Cardinal Knot into the specified Stretch at the specified Predictor Ordinate Location
static MultiSegmentSequence	InsertCatmullRomKnot(MultiSegmentSequence mssIn, double dblPredictorOrdinate) Insert a Catmull-Rom Knot into the specified Stretch at the specified Predictor Ordinate Location
static MultiSegmentSequence	InsertKnot(MultiSegmentSequence mssIn, double dblPredictorOrdinate, double dblResponseValue, BoundarySettings bs, int iCalibrationDetail) Insert the specified Predictor Ordinate Knot into the specified Stretch, using the specified Response Value
static MultiSegmentSequence	InsertKnot(MultiSegmentSequence mssIn, double dblPredictorOrdinate, SegmentPredictorResponseDerivative sprdLeftSegmentRightEdge, SegmentPredictorResponseDerivative sprdRightSegmentLeftEdge) Insert the Predictor Ordinate Knot into the specified Stretch

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiSegmentSequenceModifier

public MultiSegmentSequenceModifier()

Method Detail

InsertKnot

public static final MultiSegmentSequence InsertKnot(MultiSegmentSequence mssIn,
                                                    double dblPredictorOrdinate,
                                                    double dblResponseValue,
                                                    BoundarySettings bs,
                                                    int iCalibrationDetail)

Insert the specified Predictor Ordinate Knot into the specified Stretch, using the specified Response Value

Parameters:

mssIn - Input Stretch

dblPredictorOrdinate - Predictor Ordinate Knot

dblResponseValue - Response Value

bs - The Calibration Boundary Condition

iCalibrationDetail - The Calibration Detail

Returns:

The Stretch with the Knot inserted

AppendSegment

public static final MultiSegmentSequence AppendSegment(MultiSegmentSequence mssIn,
                                                       double dblPredictorOrdinateAppendRight,
                                                       SegmentResponseValueConstraint srvc,
                                                       SegmentCustomBuilderControl scbc,
                                                       BoundarySettings bs,
                                                       int iCalibrationDetail)

Append a Segment to the Right of the Specified Stretch using the Supplied Constraint

Parameters:

mssIn - Input Stretch

dblPredictorOrdinateAppendRight - The Predictor Ordinate at the Right Edge of the Segment to be appended

srvc - The Segment Response Value Constraint

scbc - Segment Builder Parameters

bs - The Calibration Boundary Condition

iCalibrationDetail - The Calibration Detail

Returns:

The Stretch with the Segment Appended

InsertKnot

public static final MultiSegmentSequence InsertKnot(MultiSegmentSequence mssIn,
                                                    double dblPredictorOrdinate,
                                                    SegmentPredictorResponseDerivative sprdLeftSegmentRightEdge,
                                                    SegmentPredictorResponseDerivative sprdRightSegmentLeftEdge)

Insert the Predictor Ordinate Knot into the specified Stretch

Parameters:

mssIn - Input Stretch

dblPredictorOrdinate - Knot Predictor Ordinate

sprdLeftSegmentRightEdge - Response Values for the Right Edge of the Left Segment

sprdRightSegmentLeftEdge - Response Values for the Left Edge of the Right segment

Returns:

The Stretch with the Predictor Ordinate Knot inserted

InsertCardinalKnot

public static final MultiSegmentSequence InsertCardinalKnot(MultiSegmentSequence mssIn,
                                                            double dblPredictorOrdinate,
                                                            double dblCardinalTension)

Insert a Cardinal Knot into the specified Stretch at the specified Predictor Ordinate Location

Parameters:

mssIn - Input Stretch

dblPredictorOrdinate - Knot Predictor Ordinate

dblCardinalTension - Cardinal Tension Parameter

Returns:

The Stretch with the Knot inserted

InsertCatmullRomKnot

public static final MultiSegmentSequence InsertCatmullRomKnot(MultiSegmentSequence mssIn,
                                                              double dblPredictorOrdinate)

Insert a Catmull-Rom Knot into the specified Stretch at the specified Predictor Ordinate Location

Parameters:

mssIn - Input Stretch

dblPredictorOrdinate - Knot Predictor Ordinate

Returns:

The Stretch with the Knot inserted