org.drip.spline.params

Class SegmentResponseValueConstraint

java.lang.Object

org.drip.spline.params.SegmentResponseValueConstraint

public class SegmentResponseValueConstraint
extends java.lang.Object

SegmentResponseValueConstraint holds the following set of fields that characterize a single global linear constraint between the predictor and the response variables within a single segment, expressed linearly across the constituent nodes. Constraints are expressed as C = Sigma_j [W_j * y_j] = V where x_j - Predictor j y_j - Response j W_j - Weight at ordinate j V - Value of the Constraint SegmentResponseValueConstraint exports the following functionality: - Retrieve the Array of Predictor Ordinates. - Retrieve the Array of Response Weights at each Predictor Ordinate. - Retrieve the Constraint Value. - Convert the Segment Constraint onto Local Predictor Ordinates, the corresponding Response Basis Function, and the Shape Controller Realizations. - Get the Position of the Predictor Knot relative to the Constraints. - Generate a SegmentResponseValueConstraint instance from the given predictor/response pair. SegmentResponseValueConstraint can be viewed as the global response point value transform of SegmentBasisFlexureConstraint.

Author:

Lakshmi Krishnamurthy

Field Summary

Fields

Modifier and Type	Field and Description
static int	LEFT_OF_CONSTRAINT Indicator specifying that the knot is to the left of the constraint ordinates
static int	RIGHT_OF_CONSTRAINT Indicator specifying that the knot is to the right of the constraint ordinates
static int	SPLITS_CONSTRAINT Indicator specifying that the knot splits the constraint ordinates

Constructor Summary

Constructors

Constructor and Description
SegmentResponseValueConstraint(double[] adblPredictorOrdinate, double[] adblResponseValueWeight, double dblWeightedResponseValueConstraint) SegmentResponseValueConstraint constructor

Method Summary

Modifier and Type	Method and Description
double	constraintValue() Retrieve the Constraint Value
void	display(java.lang.String strComment)
static SegmentResponseValueConstraint	FromPredictorResponsePair(double dblPredictorOrdinate, double dblResponseValue) Generate a SegmentResponseValueConstraint instance from the given predictor/response pair.
int	knotPosition(double dblPredictorKnot) Get the Position of the Predictor Knot relative to the Constraints
double[]	predictorOrdinates() Retrieve the Array of Predictor Ordinates
SegmentBasisFlexureConstraint	responseIndexedBasisConstraint(BasisEvaluator lbe, LatentStateInelastic ics) Convert the Segment Constraint onto Local Predictor Ordinates, the corresponding Response Basis Function, and the Shape Controller Realizations
double[]	responseWeights() Retrieve the Array of Response Weights at each Predictor Ordinate

Methods inherited from class java.lang.Object

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

Field Detail

LEFT_OF_CONSTRAINT

public static final int LEFT_OF_CONSTRAINT

Indicator specifying that the knot is to the left of the constraint ordinates

See Also:

Constant Field Values

RIGHT_OF_CONSTRAINT

public static final int RIGHT_OF_CONSTRAINT

Indicator specifying that the knot is to the right of the constraint ordinates

See Also:

Constant Field Values

SPLITS_CONSTRAINT

public static final int SPLITS_CONSTRAINT

Indicator specifying that the knot splits the constraint ordinates

See Also:

Constant Field Values

Constructor Detail

SegmentResponseValueConstraint

public SegmentResponseValueConstraint(double[] adblPredictorOrdinate,
                                      double[] adblResponseValueWeight,
                                      double dblWeightedResponseValueConstraint)
                               throws java.lang.Exception

SegmentResponseValueConstraint constructor

Parameters:

adblPredictorOrdinate - The Array of Global Predictor Ordinates

adblResponseValueWeight - The Array of the Weights to be applied to the Response at each Predictor Ordinate

dblWeightedResponseValueConstraint - The Value of the Weighted Response Value Constraint

Throws:

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

Method Detail

FromPredictorResponsePair

public static final SegmentResponseValueConstraint FromPredictorResponsePair(double dblPredictorOrdinate,
                                                                             double dblResponseValue)

Generate a SegmentResponseValueConstraint instance from the given predictor/response pair.

Parameters:

dblPredictorOrdinate - The Predictor Ordinate

dblResponseValue - The Response Value

Returns:

The SegmentResponseValueConstraint instance

predictorOrdinates

public double[] predictorOrdinates()

Retrieve the Array of Predictor Ordinates

Returns:

The Array of Predictor Ordinates

responseWeights

public double[] responseWeights()

Retrieve the Array of Response Weights at each Predictor Ordinate

Returns:

The Array of Response Weights at each Predictor Ordinate

constraintValue

public double constraintValue()

Retrieve the Constraint Value

Returns:

The Constraint Value

display

public void display(java.lang.String strComment)

responseIndexedBasisConstraint

public SegmentBasisFlexureConstraint responseIndexedBasisConstraint(BasisEvaluator lbe,
                                                                    LatentStateInelastic ics)

Convert the Segment Constraint onto Local Predictor Ordinates, the corresponding Response Basis Function, and the Shape Controller Realizations

Parameters:

lbe - The Local Basis Evaluator

ics - Inelastics transformer to convert coordinate space to Local from Global

Returns:

The Segment Basis Function Constraint

knotPosition

public int knotPosition(double dblPredictorKnot)
                 throws java.lang.Exception

Get the Position of the Predictor Knot relative to the Constraints

Parameters:

dblPredictorKnot - The Predictor Knot Ordinate

Returns:

Indicator specifying whether the Knot is Left of the constraints, Right of the Constraints, or splits the Constraints

Throws:

java.lang.Exception - Thrown if Inputs are invalid