Package org.drip.function.rdtor1
Interface BoundMultivariate
- All Known Implementing Classes:
AffineBoundMultivariate
public interface BoundMultivariate
BoundMultivariate Interface implements Rd To R1 Bounds.
- Module = Computational Core Module
- Library = Numerical Analysis Library
- Project = Rd To Rd Function Analysis
- Package = Built-in Rd To R1 Functions
- Author:
- Lakshmi Krishnamurthy
-
Method Summary
Modifier and Type Method Description double
boundValue()
Retrieve the Bound Valueint
boundVariateIndex()
Retrieve the Bound Variate Indexboolean
isUpper()
Retrieve the Bound Type Indicator Flagboolean
violated(double dblVariate)
Indicate if the Specified Bound has been violated by the Variate
-
Method Details
-
isUpper
boolean isUpper()Retrieve the Bound Type Indicator Flag- Returns:
- TRUE - Bound is Upper Type
-
boundVariateIndex
int boundVariateIndex()Retrieve the Bound Variate Index- Returns:
- The Bound Variate Index
-
boundValue
double boundValue()Retrieve the Bound Value- Returns:
- The Bound Value
-
violated
boolean violated(double dblVariate) throws java.lang.ExceptionIndicate if the Specified Bound has been violated by the Variate- Parameters:
dblVariate
- The Variate- Returns:
- TRUE - The Bound has been violated
- Throws:
java.lang.Exception
- Thrown if the Inputs are Invalid
-