org.drip.spline.segment

Class LatentStateResponseModel

java.lang.Object

org.drip.spline.segment.LatentStateInelastic

org.drip.spline.segment.LatentStateResponseModel

All Implemented Interfaces:

java.lang.Comparable<LatentStateInelastic>

public class LatentStateResponseModel
extends LatentStateInelastic

LatentStateResponseModel implements the single segment basis calibration and inference functionality. It exports the following functionality: - Build the LatentStateResponseModel instance from the Basis Function/Shape Controller Set. - Build the LatentStateResponseModel instance from the Basis Evaluator Set. - Retrieve the Number of Parameters, Basis Evaluator, Array of the Response Basis Coefficients, and Segment Design Inelastic Control. - Calibrate the Segment State from the Calibration Parameter Set. - Sensitivity Calibrator: Calibrate the Segment Manifest Jacobian from the Calibration Parameter Set. - Calibrate the coefficients from the prior Predictor/Response Segment, the Constraint, and fitness Weights - Calibrate the coefficients from the prior Segment and the Response Value at the Right Predictor Ordinate. - Calibrate the Coefficients from the Edge Response Values and the Left Edge Response Slope. - Calibrate the coefficients from the Left Edge Response Value Constraint, the Left Edge Response Value Slope, and the Right Edge Response Value Constraint. - Retrieve the Segment Curvature, Length, and the Best Fit DPE. - Calculate the Response Value and its Derivative at the given Predictor Ordinate. - Calculate the Ordered Derivative of the Coefficient to the Manifest. - Calculate the Jacobian of the Segment's Response Basis Function Coefficients to the Edge Inputs. - Calculate the Jacobian of the Response to the Edge Inputs at the given Predictor Ordinate. - Calculate the Jacobian of the Response to the Basis Coefficients at the given Predictor Ordinate. - Calibrate the segment and calculate the Jacobian of the Segment's Response Basis Function Coefficients to the Edge Parameters. - Calibrate the Coefficients from the Edge Response Values and the Left Edge Response Value Slope and calculate the Jacobian of the Segment's Response Basis Function Coefficients to the Edge Parameters. - Calibrate the coefficients from the prior Segment and the Response Value at the Right Predictor Ordinate and calculate the Jacobian of the Segment's Response Basis Function Coefficients to the Edge Parameters. - Indicate whether the given segment is monotone. If monotone, may optionally indicate the nature of the extrema contained inside (maxima/minima/infection). - Clip the part of the Segment to the Right of the specified Predictor Ordinate. Retain all other constraints the same. - Clip the part of the Segment to the Left of the specified Predictor Ordinate. Retain all other constraints the same. - Display the string representation for diagnostic purposes.

Author:

Lakshmi Krishnamurthy

Field Summary

Fields

Modifier and Type	Field and Description
static int	LEFT_NODE_VALUE_PARAMETER_INDEX LEFT NODE VALUE PARAMETER INDEX
static int	RIGHT_NODE_VALUE_PARAMETER_INDEX RIGHT NODE VALUE PARAMETER INDEX

Method Summary

Modifier and Type	Method and Description
BasisEvaluator	basisEvaluator() Retrieve the Basis Evaluator
double	bestFitDPE(SegmentBestFitResponse sbfr) Retrieve the Segment Best Fit DPE
double	calcDResponseDManifest(java.lang.String strManifestMeasure, double dblPredictorOrdinate, int iOrder) Calculate the Ordered Derivative of the Response to the Manifest
double	calcDResponseDPreceedingManifest(java.lang.String strManifestMeasure, double dblPredictorOrdinate, int iOrder) Calculate the Ordered Derivative of the Response to the Preceeding Manifest
double	calcResponseValueDerivative(double dblPredictorOrdinate, int iOrder) Calculate the Ordered Response Value Derivative at the Predictor Ordinate
boolean	calibrate(double dblLeftValue, double dblLeftSlope, double dblRightValue, SegmentBestFitResponse sbfrState) Calibrate the Coefficients from the Edge Response Values and the Left Edge Response Slope
boolean	calibrate(LatentStateResponseModel csPreceeding, double dblRightStateValue, SegmentBestFitResponse sbfrState) Calibrate the coefficients from the prior Segment and the Response Value at the Right Predictor Ordinate
boolean	calibrate(LatentStateResponseModel csPreceeding, SegmentResponseValueConstraint srvcState, SegmentBestFitResponse sbfrState) Calibrate the coefficients from the prior Predictor/Response Segment, the Constraint, and fitness Weights
boolean	calibrate(SegmentResponseValueConstraint wrvcStateLeft, double dblLeftSlope, SegmentResponseValueConstraint wrvcStateRight, SegmentBestFitResponse sbfrState) Calibrate the coefficients from the Left Edge Response Value Constraint, the Left Edge Response Value Slope, and the Right Edge Response Value Constraint
boolean	calibrateLocalManifestJacobian(java.lang.String strManifestMeasure, SegmentStateCalibrationInputs ssciManifestSensitivity, SegmentBasisFlexureConstraint[] aSBFCState) Sensitivity Calibrator: Calibrate the Segment Local Manifest Jacobian from the Calibration Parameter Set
double[]	calibrateManifestJacobian(SegmentStateCalibrationInputs ssciManifestSensitivity, SegmentBasisFlexureConstraint[] aSBFCState) Sensitivity Calibrator: Calibrate the Segment Manifest Measure Jacobian from the Calibration Inputs
boolean	calibratePreceedingManifestJacobian(java.lang.String strManifestMeasure, SegmentStateCalibrationInputs ssciPreceedingManifestSensitivity) Sensitivity Calibrator: Calibrate the Segment Preceeding Manifest Jacobian from the Calibration Parameter Set
boolean	calibrateState(SegmentStateCalibrationInputs ssciState) Main Calibrator: Calibrate the Segment State from the Calibration Parameter Set
LatentStateResponseModel	clipLeftOfPredictorOrdinate(double dblPredictorOrdinate) Clip the part of the Segment to the Right of the specified Predictor Ordinate.
LatentStateResponseModel	clipRightOfPredictorOrdinate(double dblPredictorOrdinate) Clip the part of the Segment to the Right of the specified Predictor Ordinate.
static LatentStateResponseModel	Create(double dblLeftPredictorOrdinate, double dblRightPredictorOrdinate, BasisEvaluator be, SegmentInelasticDesignControl sidc) Build the LatentStateResponseModel instance from the Basis Evaluator Set
static LatentStateResponseModel	Create(double dblLeftPredictorOrdinate, double dblRightPredictorOrdinate, FunctionSet fs, ResponseScalingShapeControl rssc, SegmentInelasticDesignControl sidc) Build the LatentStateResponseModel instance from the Basis Function/Shape Controller Set
double	curvatureDPE() Retrieve the Segment Curvature DPE
SegmentInelasticDesignControl	designControl() Retrieve the Segment Inelastic Design Control
java.lang.String	displayString() Display the string representation for diagnostic purposes
boolean	impactFade(java.lang.String strManifestMeasure) Retrieve the Manifest Measure Preceeding Manifest Impact Flag
WengertJacobian	jackDCoeffDEdgeInputs() Calculate the Jacobian of the Segment's Response Basis Function Coefficients to the Edge Inputs
WengertJacobian	jackDCoeffDEdgeParams(double[] adblPredictorOrdinate, double[] adblResponseValue, double[] adblLeftEdgeDeriv, double[] adblRightEdgeDeriv, SegmentBasisFlexureConstraint[] aSBFC, SegmentBestFitResponse sbfr) Calibrate the segment and calculate the Jacobian of the Segment's Response Basis Function Coefficients to the Edge Parameters
WengertJacobian	jackDCoeffDEdgeParams(double dblLeftValue, double dblLeftSlope, double dblRightValue, SegmentBestFitResponse sbfrState) Calibrate the Coefficients from the Edge Response Values and the Left Edge Response Value Slope and calculate the Jacobian of the Segment's Response Basis Function Coefficients to the Edge Parameters
WengertJacobian	jackDCoeffDEdgeParams(LatentStateResponseModel csPreceeding, java.lang.String strManifestMeasure, double dblRightStateValue, SegmentBestFitResponse sbfrState, double dblRightStateManifestSensitivity, SegmentBestFitResponse sbfrManifestSensitivity) Calibrate the coefficients from the prior Segment and the Response Value at the Right Predictor Ordinate and calculate the Jacobian of the Segment's Response Basis Function Coefficients to the Edge Parameters
WengertJacobian	jackDResponseDBasisCoeff(double dblPredictorOrdinate, int iOrder) Calculate the Jacobian of the Response to the Basis Coefficients at the given Predictor Ordinate
WengertJacobian	jackDResponseDEdgeInput(double dblPredictorOrdinate, int iOrder) Calculate the Jacobian of the Response to the Edge Inputs at the given Predictor Ordinate
double	lengthDPE() Retrieve the Segment Length DPE
boolean	manifestMeasureSensitivity(LatentStateResponseModel csPreceeding, java.lang.String strManifestMeasure, double dblRightStateManifestSensitivity, SegmentBestFitResponse sbfrManifestSensitivity) Compute the Local and the Preceeding Manifest Measure Sensitivity Coefficients from the Preceeding Segments, the Local Response Value Sensitivity at the Right Predictor Ordinate, and the Local Best Fit Response Sensitivity
boolean	manifestMeasureSensitivity(LatentStateResponseModel csPreceeding, java.lang.String strManifestMeasure, SegmentResponseValueConstraint srvcState, SegmentResponseValueConstraint srvcManifestSensitivity, SegmentBestFitResponse sbfrManifestSensitivity) Compute the Local and the Preceeding Manifest Measure Sensitivity Coefficients from the Preceeding Segment, the Local Response Value, the Local Response Value Manifest Measure Sensitivity, and the Local Best Fit Response Sensitivity
boolean	manifestMeasureSensitivity(java.lang.String strManifestMeasure, double dblLeftManifestSensitivity, double dblLeftSlopeManifestSensitivity, double dblRightManifestSensitivity, SegmentBestFitResponse sbfrManifestSensitivity) Compute the Local and the Preceeding Manifest Measure Sensitivity Coefficients from the Local Response Value Sensitivity at the Left/Right Predictor Ordinate, the Local Left Response Value Sensitivity Slope, and the Local Best Fit Response Sensitivity.
boolean	manifestMeasureSensitivity(java.lang.String strManifestMeasure, SegmentResponseValueConstraint wrvcStateLeft, SegmentResponseValueConstraint wrvcStateRight, double dblLeftSlopeManifestSensitivity, SegmentResponseValueConstraint wrvcStateLeftManifestSensitivity, SegmentResponseValueConstraint wrvcStateRightManifestSensitivity, SegmentBestFitResponse sbfrManifestSensitivity) Compute the Local and the Preceeding Manifest Measure Sensitivity Coefficients from the Local Response Value/Sensitivity Constraints at the Left/Right Predictor Ordinate, the Local Left Response Value Sensitivity Slope, and the Local Best Fit Response Sensitivity
Monotonocity	monotoneType() Indicate whether the given segment is monotone.
int	numParameters() Retrieve the Number of Parameters
double[]	responseBasisCoefficient() Retrieve the Array of Response Basis Coefficients
double	responseValue(double dblPredictorOrdinate) Calculate the Response Value at the given Predictor Ordinate
boolean	setPreceedingManifestSensitivityControl(java.lang.String strManifestMeasure, PreceedingManifestSensitivityControl pmsc) Set the Preceeding Manifest Sensitivity Control Parameters for the specified Manifest Measure

Methods inherited from class org.drip.spline.segment.LatentStateInelastic

compareTo, delocalize, hashCode, in, left, localize, right, width

Methods inherited from class java.lang.Object

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

Field Detail

LEFT_NODE_VALUE_PARAMETER_INDEX

public static final int LEFT_NODE_VALUE_PARAMETER_INDEX

LEFT NODE VALUE PARAMETER INDEX

See Also:

Constant Field Values

RIGHT_NODE_VALUE_PARAMETER_INDEX

public static final int RIGHT_NODE_VALUE_PARAMETER_INDEX

RIGHT NODE VALUE PARAMETER INDEX

See Also:

Constant Field Values

Method Detail

Create

public static final LatentStateResponseModel Create(double dblLeftPredictorOrdinate,
                                                    double dblRightPredictorOrdinate,
                                                    FunctionSet fs,
                                                    ResponseScalingShapeControl rssc,
                                                    SegmentInelasticDesignControl sidc)

Build the LatentStateResponseModel instance from the Basis Function/Shape Controller Set

Parameters:

dblLeftPredictorOrdinate - Left Predictor Ordinate

dblRightPredictorOrdinate - Right Predictor Ordinate

fs - Response Basis Function Set

rssc - Shape Controller

sidc - Segment Inelastic Design Parameters

Returns:

Instance of LatentStateResponseModel

Create

public static final LatentStateResponseModel Create(double dblLeftPredictorOrdinate,
                                                    double dblRightPredictorOrdinate,
                                                    BasisEvaluator be,
                                                    SegmentInelasticDesignControl sidc)

Build the LatentStateResponseModel instance from the Basis Evaluator Set

Parameters:

dblLeftPredictorOrdinate - Left Predictor Ordinate

dblRightPredictorOrdinate - Right Predictor Ordinate

be - Basis Evaluator

sidc - Segment Inelastic Design Parameters

Returns:

Instance of LatentStateResponseModel

setPreceedingManifestSensitivityControl

public boolean setPreceedingManifestSensitivityControl(java.lang.String strManifestMeasure,
                                                       PreceedingManifestSensitivityControl pmsc)

Set the Preceeding Manifest Sensitivity Control Parameters for the specified Manifest Measure

Parameters:

strManifestMeasure - The Manifest Measure

pmsc - The Preceeding Manifest Sensitivity Control Instance

Returns:

TRUE - Named Preceeding Manifest Sensitivity Control Instance Successfully Set

numParameters

public int numParameters()

Retrieve the Number of Parameters

Returns:

The Number of Parameters

basisEvaluator

public BasisEvaluator basisEvaluator()

Retrieve the Basis Evaluator

Returns:

The Basis Evaluator

responseBasisCoefficient

public double[] responseBasisCoefficient()

Retrieve the Array of Response Basis Coefficients

Returns:

The Array of Response Basis Coefficients

designControl

public SegmentInelasticDesignControl designControl()

Retrieve the Segment Inelastic Design Control

Returns:

The Segment Inelastic Design Control

calibrateState

public boolean calibrateState(SegmentStateCalibrationInputs ssciState)

Main Calibrator: Calibrate the Segment State from the Calibration Parameter Set

Parameters:

ssciState - The Segment State Calibration Inputs Set

Returns:

TRUE - Calibration Successful

calibrateManifestJacobian

public double[] calibrateManifestJacobian(SegmentStateCalibrationInputs ssciManifestSensitivity,
                                          SegmentBasisFlexureConstraint[] aSBFCState)

Sensitivity Calibrator: Calibrate the Segment Manifest Measure Jacobian from the Calibration Inputs

Parameters:

ssciManifestSensitivity - The Segment Manifest Calibration Sensitivity Inputs

aSBFCState - Array of Segment State Basis Flexure Constraints

Returns:

The Manifest Sensitivity Coefficients

calibrateLocalManifestJacobian

public boolean calibrateLocalManifestJacobian(java.lang.String strManifestMeasure,
                                              SegmentStateCalibrationInputs ssciManifestSensitivity,
                                              SegmentBasisFlexureConstraint[] aSBFCState)

Sensitivity Calibrator: Calibrate the Segment Local Manifest Jacobian from the Calibration Parameter Set

Parameters:

strManifestMeasure - Latent State Manifest Measure

ssciManifestSensitivity - The Segment Manifest Calibration Parameter Sensitivity

aSBFCState - Array of Segment State Basis Flexure Constraints

Returns:

TRUE - Local Manifest Sensitivity Calibration Successful

calibratePreceedingManifestJacobian

public boolean calibratePreceedingManifestJacobian(java.lang.String strManifestMeasure,
                                                   SegmentStateCalibrationInputs ssciPreceedingManifestSensitivity)

Sensitivity Calibrator: Calibrate the Segment Preceeding Manifest Jacobian from the Calibration Parameter Set

Parameters:

strManifestMeasure - Latent State Manifest

ssciPreceedingManifestSensitivity - The Segment Preceeding Manifest Calibration Parameter Sensitivity

Returns:

TRUE - Preceeding Manifest Sensitivity Calibration Successful

calibrate

public boolean calibrate(LatentStateResponseModel csPreceeding,
                         SegmentResponseValueConstraint srvcState,
                         SegmentBestFitResponse sbfrState)

Calibrate the coefficients from the prior Predictor/Response Segment, the Constraint, and fitness Weights

Parameters:

csPreceeding - Preceeding Predictor/Response Segment

srvcState - The Segment State Response Value Constraint

sbfrState - Segment's Best Fit Weighted State Response Values

Returns:

TRUE - If the calibration succeeds

calibrate

public boolean calibrate(LatentStateResponseModel csPreceeding,
                         double dblRightStateValue,
                         SegmentBestFitResponse sbfrState)

Calibrate the coefficients from the prior Segment and the Response Value at the Right Predictor Ordinate

Parameters:

csPreceeding - Preceeding Predictor/Response Segment

dblRightStateValue - Response Value at the Right Predictor Ordinate

sbfrState - Segment's Best Fit Weighted Response Values

Returns:

TRUE - If the calibration succeeds

calibrate

public boolean calibrate(double dblLeftValue,
                         double dblLeftSlope,
                         double dblRightValue,
                         SegmentBestFitResponse sbfrState)

Calibrate the Coefficients from the Edge Response Values and the Left Edge Response Slope

Parameters:

dblLeftValue - Left Edge Response Value

dblLeftSlope - Left Edge Response Slope

dblRightValue - Right Edge Response Value

sbfrState - Segment's Best Fit Weighted Response Values

Returns:

TRUE - The Calibration Succeeded

calibrate

public boolean calibrate(SegmentResponseValueConstraint wrvcStateLeft,
                         double dblLeftSlope,
                         SegmentResponseValueConstraint wrvcStateRight,
                         SegmentBestFitResponse sbfrState)

Calibrate the coefficients from the Left Edge Response Value Constraint, the Left Edge Response Value Slope, and the Right Edge Response Value Constraint

Parameters:

wrvcStateLeft - Left Edge Response Value Constraint

dblLeftSlope - Left Edge Response Value Slope

wrvcStateRight - Right Edge Response Value Constraint

sbfrState - Segment's Best Fit Weighted Response

Returns:

TRUE - If the calibration succeeds

manifestMeasureSensitivity

public boolean manifestMeasureSensitivity(LatentStateResponseModel csPreceeding,
                                          java.lang.String strManifestMeasure,
                                          SegmentResponseValueConstraint srvcState,
                                          SegmentResponseValueConstraint srvcManifestSensitivity,
                                          SegmentBestFitResponse sbfrManifestSensitivity)

Compute the Local and the Preceeding Manifest Measure Sensitivity Coefficients from the Preceeding Segment, the Local Response Value, the Local Response Value Manifest Measure Sensitivity, and the Local Best Fit Response Sensitivity

Parameters:

csPreceeding - Preceeding Predictor/Response Segment

strManifestMeasure - Manifest Measure whose Sensitivity is sought

srvcState - The Segment State Response Value Constraint

srvcManifestSensitivity - The Segment State Response Value Constraint Manifest Sensitivity

sbfrManifestSensitivity - Segment's Best Fit Weighted State Response Value Manifest Sensitivity

Returns:

TRUE - If the calibration succeeds

manifestMeasureSensitivity

public boolean manifestMeasureSensitivity(LatentStateResponseModel csPreceeding,
                                          java.lang.String strManifestMeasure,
                                          double dblRightStateManifestSensitivity,
                                          SegmentBestFitResponse sbfrManifestSensitivity)

Compute the Local and the Preceeding Manifest Measure Sensitivity Coefficients from the Preceeding Segments, the Local Response Value Sensitivity at the Right Predictor Ordinate, and the Local Best Fit Response Sensitivity

Parameters:

csPreceeding - Preceeding Predictor/Response Segment

strManifestMeasure - Manifest Measure whose Sensitivity is sought

dblRightStateManifestSensitivity - Response Value Manifest Sensitivity at the Right Predictor Ordinate

sbfrManifestSensitivity - Segment's Best Fit Weighted Response Value Manifest Sensitivity

Returns:

TRUE - If the calibration succeeds

manifestMeasureSensitivity

public boolean manifestMeasureSensitivity(java.lang.String strManifestMeasure,
                                          double dblLeftManifestSensitivity,
                                          double dblLeftSlopeManifestSensitivity,
                                          double dblRightManifestSensitivity,
                                          SegmentBestFitResponse sbfrManifestSensitivity)

Compute the Local and the Preceeding Manifest Measure Sensitivity Coefficients from the Local Response Value Sensitivity at the Left/Right Predictor Ordinate, the Local Left Response Value Sensitivity Slope, and the Local Best Fit Response Sensitivity.

Parameters:

strManifestMeasure - Manifest Measure whose Sensitivity is sought

dblLeftManifestSensitivity - Left Edge Response Value Manifest Sensitivity

dblLeftSlopeManifestSensitivity - Left Edge Response Slope Manifest Sensitivity

dblRightManifestSensitivity - Right Edge Response Value Manifest Sensitivity

sbfrManifestSensitivity - Segment's Best Fit Weighted Response Values Manifest Sensitivity

Returns:

TRUE - The Calibration Succeeded

manifestMeasureSensitivity

public boolean manifestMeasureSensitivity(java.lang.String strManifestMeasure,
                                          SegmentResponseValueConstraint wrvcStateLeft,
                                          SegmentResponseValueConstraint wrvcStateRight,
                                          double dblLeftSlopeManifestSensitivity,
                                          SegmentResponseValueConstraint wrvcStateLeftManifestSensitivity,
                                          SegmentResponseValueConstraint wrvcStateRightManifestSensitivity,
                                          SegmentBestFitResponse sbfrManifestSensitivity)

Compute the Local and the Preceeding Manifest Measure Sensitivity Coefficients from the Local Response Value/Sensitivity Constraints at the Left/Right Predictor Ordinate, the Local Left Response Value Sensitivity Slope, and the Local Best Fit Response Sensitivity

Parameters:

strManifestMeasure - Manifest Measure whose Sensitivity is sought

wrvcStateLeft - Left Edge Response Value Constraint

wrvcStateRight - Right Edge Response Value Constraint

dblLeftSlopeManifestSensitivity - Left Edge Response Value Slope Manifest Sensitivity

wrvcStateLeftManifestSensitivity - Left Edge Response Value Constraint Manifest Sensitivity

wrvcStateRightManifestSensitivity - Right Edge Response Value Constraint Manifest Sensitivity

sbfrManifestSensitivity - Segment's Best Fit Weighted Response Manifest Sensitivity

Returns:

TRUE - If the calibration succeeds

curvatureDPE

public double curvatureDPE()
                    throws java.lang.Exception

Retrieve the Segment Curvature DPE

Returns:

The Segment Curvature DPE

Throws:

java.lang.Exception - Thrown if the Segment Curvature DPE cannot be computed

lengthDPE

public double lengthDPE()
                 throws java.lang.Exception

Retrieve the Segment Length DPE

Returns:

The Segment Length DPE

Throws:

java.lang.Exception - Thrown if the Segment Length DPE cannot be computed

bestFitDPE

public double bestFitDPE(SegmentBestFitResponse sbfr)
                  throws java.lang.Exception

Retrieve the Segment Best Fit DPE

Parameters:

sbfr - The Segment's Best Fit Response Inputs

Returns:

The Segment Best Fit DPE

Throws:

java.lang.Exception - Thrown if the Segment Best Fit DPE cannot be computed

responseValue

public double responseValue(double dblPredictorOrdinate)
                     throws java.lang.Exception

Calculate the Response Value at the given Predictor Ordinate

Parameters:

dblPredictorOrdinate - Predictor Ordinate

Returns:

The Response Value

Throws:

java.lang.Exception - Thrown if the calculation did not succeed

calcResponseValueDerivative

public double calcResponseValueDerivative(double dblPredictorOrdinate,
                                          int iOrder)
                                   throws java.lang.Exception

Calculate the Ordered Response Value Derivative at the Predictor Ordinate

Parameters:

dblPredictorOrdinate - Predictor Ordinate at which the ordered Response Derivative is to be calculated

iOrder - Derivative Order

Returns:

Retrieve the Ordered Response Value Derivative

Throws:

java.lang.Exception - Thrown if the Ordered Response Value Derivative cannot be calculated

calcDResponseDManifest

public double calcDResponseDManifest(java.lang.String strManifestMeasure,
                                     double dblPredictorOrdinate,
                                     int iOrder)
                              throws java.lang.Exception

Calculate the Ordered Derivative of the Response to the Manifest

Parameters:

strManifestMeasure - Manifest Measure whose Sensitivity is sought

dblPredictorOrdinate - Predictor Ordinate at which the ordered Derivative of the Response to the Manifest is to be calculated

iOrder - Derivative Order

Returns:

Retrieve the Ordered Derivative of the Response to the Manifest

Throws:

java.lang.Exception - Thrown if the Ordered Derivative of the Response to the Manifest cannot be calculated

calcDResponseDPreceedingManifest

public double calcDResponseDPreceedingManifest(java.lang.String strManifestMeasure,
                                               double dblPredictorOrdinate,
                                               int iOrder)
                                        throws java.lang.Exception

Calculate the Ordered Derivative of the Response to the Preceeding Manifest

Parameters:

strManifestMeasure - Manifest Measure whose Sensitivity is sought

dblPredictorOrdinate - Predictor Ordinate at which the ordered Derivative of the Response to the Manifest is to be calculated

iOrder - Derivative Order

Returns:

Retrieve the Ordered Derivative of the Response to the Preceeding Manifest

Throws:

java.lang.Exception - Thrown if the Ordered Derivative of the Response to the Manifest cannot be calculated

impactFade

public boolean impactFade(java.lang.String strManifestMeasure)
                   throws java.lang.Exception

Retrieve the Manifest Measure Preceeding Manifest Impact Flag

Parameters:

strManifestMeasure - Manifest Measure whose Sensitivity is sought

Returns:

The Manifest Measure Preceeding Manifest Impact Flag

Throws:

java.lang.Exception - Thrown if the Inputs are Invalid

jackDCoeffDEdgeInputs

public WengertJacobian jackDCoeffDEdgeInputs()

Calculate the Jacobian of the Segment's Response Basis Function Coefficients to the Edge Inputs

Returns:

The Jacobian of the Segment's Response Basis Function Coefficients to the Edge Inputs

jackDResponseDEdgeInput

public WengertJacobian jackDResponseDEdgeInput(double dblPredictorOrdinate,
                                               int iOrder)

Calculate the Jacobian of the Response to the Edge Inputs at the given Predictor Ordinate

Parameters:

dblPredictorOrdinate - The Predictor Ordinate

iOrder - Order of the Derivative Desired

Returns:

The Jacobian of the Response to the Edge Inputs at the given Predictor Ordinate

jackDResponseDBasisCoeff

public WengertJacobian jackDResponseDBasisCoeff(double dblPredictorOrdinate,
                                                int iOrder)

Calculate the Jacobian of the Response to the Basis Coefficients at the given Predictor Ordinate

Parameters:

dblPredictorOrdinate - The Predictor Ordinate

iOrder - Order of the Derivative Desired

Returns:

The Jacobian of the Response to the Basis Coefficients at the given Predictor Ordinate

jackDCoeffDEdgeParams

public WengertJacobian jackDCoeffDEdgeParams(double[] adblPredictorOrdinate,
                                             double[] adblResponseValue,
                                             double[] adblLeftEdgeDeriv,
                                             double[] adblRightEdgeDeriv,
                                             SegmentBasisFlexureConstraint[] aSBFC,
                                             SegmentBestFitResponse sbfr)

Calibrate the segment and calculate the Jacobian of the Segment's Response Basis Function Coefficients to the Edge Parameters

Parameters:

adblPredictorOrdinate - Array of Predictor Ordinates

adblResponseValue - Array of Response Values

adblLeftEdgeDeriv - Array of Left Edge Derivatives

adblRightEdgeDeriv - Array of Right Edge Derivatives

aSBFC - Array of Segment Flexure Constraints, expressed as Basis Coefficients

sbfr - Segment Best Fit Response Instance

Returns:

The Jacobian of the Segment's Response Basis Function Coefficients to the Edge Parameters

jackDCoeffDEdgeParams

public WengertJacobian jackDCoeffDEdgeParams(double dblLeftValue,
                                             double dblLeftSlope,
                                             double dblRightValue,
                                             SegmentBestFitResponse sbfrState)

Calibrate the Coefficients from the Edge Response Values and the Left Edge Response Value Slope and calculate the Jacobian of the Segment's Response Basis Function Coefficients to the Edge Parameters

Parameters:

dblLeftValue - Left Edge Response Value

dblLeftSlope - Left Edge Response Slope

dblRightValue - Right Edge Response Value

sbfrState - Segment's Best Fit Weighted Response Values

Returns:

The Jacobian of the Segment's Response Basis Function Coefficients to the Edge Parameters

jackDCoeffDEdgeParams

public WengertJacobian jackDCoeffDEdgeParams(LatentStateResponseModel csPreceeding,
                                             java.lang.String strManifestMeasure,
                                             double dblRightStateValue,
                                             SegmentBestFitResponse sbfrState,
                                             double dblRightStateManifestSensitivity,
                                             SegmentBestFitResponse sbfrManifestSensitivity)

Calibrate the coefficients from the prior Segment and the Response Value at the Right Predictor Ordinate and calculate the Jacobian of the Segment's Response Basis Function Coefficients to the Edge Parameters

Parameters:

csPreceeding - Previous Predictor/Response Segment

strManifestMeasure - Manifest Measure whose Sensitivity is sought

dblRightStateValue - Response Value at the Right Predictor Ordinate

sbfrState - Segment's Best Fit Weighted Response Values

dblRightStateManifestSensitivity - Response Value Manifest Sensitivity at the Right Predictor Ordinate

sbfrManifestSensitivity - Segment's Best Fit Weighted Response Value Manifest Sensitivity

Returns:

The Jacobian

monotoneType

public Monotonocity monotoneType()

Indicate whether the given segment is monotone. If monotone, may optionally indicate the nature of the extrema contained inside (maxima/minima/infection).

Returns:

The monotone Type

clipLeftOfPredictorOrdinate

public LatentStateResponseModel clipLeftOfPredictorOrdinate(double dblPredictorOrdinate)

Clip the part of the Segment to the Right of the specified Predictor Ordinate. Retain all other constraints the same.

Parameters:

dblPredictorOrdinate - The Predictor Ordinate

Returns:

The Clipped Segment

clipRightOfPredictorOrdinate

public LatentStateResponseModel clipRightOfPredictorOrdinate(double dblPredictorOrdinate)

Clip the part of the Segment to the Right of the specified Predictor Ordinate. Retain all other constraints the same.

Parameters:

dblPredictorOrdinate - The Predictor Ordinate

Returns:

The Clipped Segment

displayString

public java.lang.String displayString()

Display the string representation for diagnostic purposes

Returns:

The string representation