org.drip.spline.params

Class ResponseScalingShapeControl

java.lang.Object

org.drip.spline.params.ResponseScalingShapeControl

public class ResponseScalingShapeControl
extends java.lang.Object

ResponseScalingShapeControl implements the segment level basis functions proportional adjustment to achieve the desired shape behavior of the response. In addition to the actual shape controller function, it interprets whether the control is applied on a local or global predicate ordinate basis.

Author:

Lakshmi Krishnamurthy

Constructor Summary

Constructors

Constructor and Description
ResponseScalingShapeControl(boolean bIsLocal, R1ToR1 auShapeControl) ResponseScalingShapeControl constructor

Method Summary

Modifier and Type	Method and Description
boolean	isLocal() Indicate if the Control is applied on a Local or a Global Predicate Ordinate Basis
R1ToR1	shapeController() Retrieve the Shape Control Univariate Function

Methods inherited from class java.lang.Object

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

Constructor Detail

ResponseScalingShapeControl

public ResponseScalingShapeControl(boolean bIsLocal,
                                   R1ToR1 auShapeControl)
                            throws java.lang.Exception

ResponseScalingShapeControl constructor

Parameters:

bIsLocal - TRUE - Shape Control is applied on a local segment basis

auShapeControl - - Univariate Shape Controller Function

Throws:

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

Method Detail

isLocal

public boolean isLocal()

Indicate if the Control is applied on a Local or a Global Predicate Ordinate Basis

Returns:

TRUE - Control is applied on a Local Predicate Ordinate Basis

shapeController

public R1ToR1 shapeController()

Retrieve the Shape Control Univariate Function

Returns:

The Shape Control Univariate Function