org.drip.spline.segment

Class SegmentBasisEvaluator

java.lang.Object

org.drip.spline.segment.SegmentBasisEvaluator

All Implemented Interfaces:

BasisEvaluator

public class SegmentBasisEvaluator
extends java.lang.Object
implements BasisEvaluator

This Class implements the BasisEvaluator interface for the given set of the Segment Basis Evaluator Functions.

Author:

Lakshmi Krishnamurthy

Constructor Summary

Constructors

Constructor and Description
SegmentBasisEvaluator(FunctionSet fs, ResponseScalingShapeControl rssc) SegmentBasisEvaluator constructor

Method Summary

Modifier and Type	Method and Description
int	numBasis() Retrieve the number of Segment's Basis Functions
BasisEvaluator	replicate() Clone/Replicate the current Basis Evaluator Instance
double	responseValue(double[] adblResponseBasisCoeff, double dblPredictorOrdinate) Compute the Response Value at the specified Predictor Ordinate
double	responseValueDerivative(double[] adblResponseBasisCoeff, double dblPredictorOrdinate, int iOrder) Compute the Response Value Derivative at the specified Predictor Ordinate
boolean	setContainingInelastics(LatentStateInelastic ics) Set the Inelastics that provides the enveloping Context the Basis Evaluation
double	shapedBasisFunctionDerivative(double dblPredictorOrdinate, int iOrder, int iBasisFunctionIndex) Compute the Ordered Derivative of the Response Value off of the indexed Basis Function at the specified Predictor Ordinate
double	shapedBasisFunctionResponse(double dblPredictorOrdinate, int iBasisFunctionIndex) Compute the Response Value of the indexed Basis Function at the specified Predictor Ordinate
double	unshapedBasisFunctionDerivative(double[] adblResponseBasisCoeff, double dblPredictorOrdinate, int iOrder) Compute the Ordered Derivative of the Response Value off of the Basis Function Set at the specified Predictor Ordinate
double	unshapedResponseValue(double[] adblResponseBasisCoeff, double dblPredictorOrdinate) Compute the Basis Function Value at the specified Predictor Ordinate

Methods inherited from class java.lang.Object

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

Constructor Detail

SegmentBasisEvaluator

public SegmentBasisEvaluator(FunctionSet fs,
                             ResponseScalingShapeControl rssc)
                      throws java.lang.Exception

SegmentBasisEvaluator constructor

Parameters:

fs - The Function Set Instance the contains the Basis Function Set

rssc - The Segment Wide Shape Controller

Throws:

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

Method Detail

numBasis

public int numBasis()

Description copied from interface: BasisEvaluator

Retrieve the number of Segment's Basis Functions

Specified by:

numBasis in interface BasisEvaluator

Returns:

The Number of Segment's Basis Functions

setContainingInelastics

public boolean setContainingInelastics(LatentStateInelastic ics)

Description copied from interface: BasisEvaluator

Set the Inelastics that provides the enveloping Context the Basis Evaluation

Specified by:

setContainingInelastics in interface BasisEvaluator

Parameters:

ics - The Inelastic Settings

Returns:

TRUE - The inelastics has been set

replicate

public BasisEvaluator replicate()

Description copied from interface: BasisEvaluator

Clone/Replicate the current Basis Evaluator Instance

Specified by:

replicate in interface BasisEvaluator

Returns:

TRUE - The Replicated Basis Evaluator Instance

shapedBasisFunctionResponse

public double shapedBasisFunctionResponse(double dblPredictorOrdinate,
                                          int iBasisFunctionIndex)
                                   throws java.lang.Exception

Description copied from interface: BasisEvaluator

Compute the Response Value of the indexed Basis Function at the specified Predictor Ordinate

Specified by:

shapedBasisFunctionResponse in interface BasisEvaluator

Parameters:

dblPredictorOrdinate - The specified Predictor Ordinate

iBasisFunctionIndex - Index representing the Basis Function in the Basis Function Set

Returns:

The Response Value of the indexed Basis Function at the specified Predictor Ordinate

Throws:

java.lang.Exception - Thrown if the Ordered Derivative cannot be computed

unshapedResponseValue

public double unshapedResponseValue(double[] adblResponseBasisCoeff,
                                    double dblPredictorOrdinate)
                             throws java.lang.Exception

Description copied from interface: BasisEvaluator

Compute the Basis Function Value at the specified Predictor Ordinate

Specified by:

unshapedResponseValue in interface BasisEvaluator

Parameters:

adblResponseBasisCoeff - Array of the Response Basis Coefficients

dblPredictorOrdinate - The specified Predictor Ordinate

Returns:

The Basis Function Value

Throws:

java.lang.Exception - Thrown if the Basis Function Value cannot be computed

responseValue

public double responseValue(double[] adblResponseBasisCoeff,
                            double dblPredictorOrdinate)
                     throws java.lang.Exception

Description copied from interface: BasisEvaluator

Compute the Response Value at the specified Predictor Ordinate

Specified by:

responseValue in interface BasisEvaluator

Parameters:

adblResponseBasisCoeff - Array of the Response Basis Coefficients

dblPredictorOrdinate - The specified Predictor Ordinate

Returns:

The Response Value

Throws:

java.lang.Exception - Thrown if the Basis Function Value cannot be computed

shapedBasisFunctionDerivative

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

Description copied from interface: BasisEvaluator

Compute the Ordered Derivative of the Response Value off of the indexed Basis Function at the specified Predictor Ordinate

Specified by:

shapedBasisFunctionDerivative in interface BasisEvaluator

Parameters:

dblPredictorOrdinate - The specified Predictor Ordinate

iOrder - Order of the Derivative

iBasisFunctionIndex - Index representing the Basis Function in the Basis Function Set

Returns:

The Ordered Derivative of the Response Value off of the Indexed Basis Function

Throws:

java.lang.Exception - Thrown if the Ordered Derivative cannot be computed

unshapedBasisFunctionDerivative

public double unshapedBasisFunctionDerivative(double[] adblResponseBasisCoeff,
                                              double dblPredictorOrdinate,
                                              int iOrder)
                                       throws java.lang.Exception

Description copied from interface: BasisEvaluator

Compute the Ordered Derivative of the Response Value off of the Basis Function Set at the specified Predictor Ordinate

Specified by:

unshapedBasisFunctionDerivative in interface BasisEvaluator

Parameters:

adblResponseBasisCoeff - Array of the Response Basis Coefficients

dblPredictorOrdinate - The specified Predictor Ordinate

iOrder - Order of the Derivative

Returns:

The Ordered Derivative of the Response Value off of the Basis Function Set

Throws:

java.lang.Exception - Thrown if the Ordered Derivative of the Basis Function Set cannot be computed

responseValueDerivative

public double responseValueDerivative(double[] adblResponseBasisCoeff,
                                      double dblPredictorOrdinate,
                                      int iOrder)
                               throws java.lang.Exception

Description copied from interface: BasisEvaluator

Compute the Response Value Derivative at the specified Predictor Ordinate

Specified by:

responseValueDerivative in interface BasisEvaluator

Parameters:

adblResponseBasisCoeff - Array of the Response Basis Coefficients

dblPredictorOrdinate - The specified Predictor Ordinate

iOrder - Order of the Derivative

Returns:

The Response Value Derivative

Throws:

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