Package org.drip.function.definition

Class R3ToR1Property

java.lang.Object

org.drip.function.definition.RxToR1Property

org.drip.function.definition.R3ToR1Property

public class R3ToR1Property
extends RxToR1Property

R3ToR1Property evaluates the Specified Pair of R³ To R¹ Functions, and verifies the Properties.

• Module = Computational Core Module
• Library = Numerical Analysis Library
• Project = R^d To R^d Function Analysis
• Package = Function Implementation Ancillary Support Objects

Author:

Lakshmi Krishnamurthy

Field Summary

Fields inherited from class org.drip.function.definition.RxToR1Property

EQ, GT, GTE, LT, LTE, MISMATCH_TOLERANCE

Constructor Summary

Constructors

Constructor	Description
R3ToR1Property(java.lang.String type, R3ToR1 r3ToR1Left, R3ToR1 r3ToR1Right, double mismatchTolerance)	R3ToR1Property Constructor

Method Summary

Modifier and Type	Method	Description
R3ToR1	r3ToR1Left()	Retrieve the Left R3 To R1 Function
R3ToR1	r3ToR1Right()	Retrieve the Right R3 To R1 Function
R1PropertyVerification	verify(double x, double y, double z)	Verify the specified R2 To R1 Functions

Methods inherited from class org.drip.function.definition.RxToR1Property

mismatchTolerance, type, verify

Methods inherited from class java.lang.Object

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

Constructor Details

R3ToR1Property

public R3ToR1Property(java.lang.String type,
R3ToR1 r3ToR1Left,
R3ToR1 r3ToR1Right,
double mismatchTolerance)
               throws java.lang.Exception

R3ToR1Property Constructor

Parameters:

type - The Comparator Type

r3ToR1Left - The Left R³ To R¹ Function

r3ToR1Right - The Right R³ To R¹ Function

mismatchTolerance - The Mismatch Tolerance

Throws:

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

Method Details

r3ToR1Left

public R3ToR1 r3ToR1Left()

Retrieve the Left R³ To R¹ Function

Returns:

The Left R³ To R¹ Function

r3ToR1Right

public R3ToR1 r3ToR1Right()

Retrieve the Right R³ To R¹ Function

Returns:

The Right R³ To R¹ Function

verify

public R1PropertyVerification verify(double x,
double y,
double z)

Verify the specified R² To R¹ Functions

Parameters:

x - X

y - Y

z - Z

Returns:

Results of the Verification