RxToR1Property

java.lang.Object

org.drip.function.definition.RxToR1Property

Direct Known Subclasses:: R1ToR1Property, R2ToR1Property, R3ToR1Property

public abstract class RxToR1Property
extends java.lang.Object

RxToR1Property evaluates the Specified Pair of R^x 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
Modifier and Type	Field	Description
`static java.lang.String`	`EQ`	EQUAL To Comparison
`static java.lang.String`	`GT`	GREATER THAN To Comparison
`static java.lang.String`	`GTE`	GREATER THAN OR EQUAL To Comparison
`static java.lang.String`	`LT`	LESS THAN To Comparison
`static java.lang.String`	`LTE`	LESS THAN OR EQUAL To Comparison
`static double`	`MISMATCH_TOLERANCE`	Mismatch Tolerance

Method Summary

Modifier and Type	Method	Description
`double`	`mismatchTolerance()`	Retrieve the Mismatch Tolerance
`java.lang.String`	`type()`	Retrieve the Type of the Comparison
`R1PropertyVerification`	`verify(double leftValue, double rightValue)`	Verify the specified Left and Right Function Values

Methods inherited from class java.lang.Object

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

Field Details
- MISMATCH_TOLERANCE
  
  public static final double MISMATCH_TOLERANCE
  
  Mismatch Tolerance
  
  See Also:
  
  Constant Field Values
- EQ
  
  public static final java.lang.String EQ
  
  EQUAL To Comparison
  
  See Also:
  
  Constant Field Values
- LTE
  
  public static final java.lang.String LTE
  
  LESS THAN OR EQUAL To Comparison
  
  See Also:
  
  Constant Field Values
- GTE
  
  public static final java.lang.String GTE
  
  GREATER THAN OR EQUAL To Comparison
  
  See Also:
  
  Constant Field Values
- LT
  
  public static final java.lang.String LT
  
  LESS THAN To Comparison
  
  See Also:
  
  Constant Field Values
- GT
  
  public static final java.lang.String GT
  
  GREATER THAN To Comparison
  
  See Also:
  
  Constant Field Values
Method Details
- type
  
  public java.lang.String type()
  
  Retrieve the Type of the Comparison
  
  Returns:
  
  The Type of the Comparison
- mismatchTolerance
  
  public double mismatchTolerance()
  
  Retrieve the Mismatch Tolerance
  
  Returns:
  
  The Mismatch Tolerance
- verify
  
  public R1PropertyVerification verify(double leftValue, double rightValue)
  
  Verify the specified Left and Right Function Values
  
  Parameters:
  
  leftValue - Left Function Value
  
  rightValue - Right Function Value
  
  Returns:
  
  Results of the Verification