org.drip.function.rdtor1

Interface BoundMultivariate

All Known Implementing Classes:

AffineBoundMultivariate

public interface BoundMultivariate

BoundMultivariate Interface implements R^d To R^1 Bounds.

Author:

Lakshmi Krishnamurthy

Method Summary

Modifier and Type	Method and Description
double	boundValue() Retrieve the Bound Value
int	boundVariateIndex() Retrieve the Bound Variate Index
boolean	isUpper() Retrieve the Bound Type Indicator Flag
boolean	violated(double dblVariate) Indicate if the Specified Bound has been violated by the Variate

Method Detail

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.Exception

Indicate 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