Package org.drip.measure.distribution

Class R1ContinuousUniformPiecewiseDisplaced

java.lang.Object

org.drip.measure.distribution.R1Continuous

org.drip.measure.distribution.R1ContinuousUniform

org.drip.measure.distribution.R1ContinuousUniformPiecewiseDisplaced

public class R1ContinuousUniformPiecewiseDisplaced
extends R1ContinuousUniform

R1ContinuousUniformPiecewiseDisplaced implements the Continuous Uniform Displaced Piecewise Linear R¹ Distributions. It exports the Methods corresponding to the R¹ Lebesgue Base Class. It provides the following Functionality:

• Calibrate an R1ContinuousUniformPiecewiseDisplaced Lebesgue Instance
• R1ContinuousUniformPiecewiseDisplaced Constructor
• Retrieve the Array of Predictor Ordinates
• Retrieve the Array of Piecewise Density Slopes
• Retrieve the Density Displacement
• Compute the cumulative under the distribution to the given value
• Compute the inverse cumulative under the distribution corresponding to the given value
• Compute the Density under the Distribution at the given Variate
• Retrieve the Univariate Weighted Histogram

Module	Computational Core Module
Library	Numerical Analysis Library
Project	Rd Continuous/Discrete Probability Measures
Package	R1 and Rd Continuous Random Measure

Author:

Lakshmi Krishnamurthy

Constructor Summary

Constructors

Constructor	Description
R1ContinuousUniformPiecewiseDisplaced(double leftPredictorOrdinateEdge, double rightPredictorOrdinateEdge, double[] predictorOrdinateArray, double[] piecewiseDensitySlopeArray, double densityDisplacement)	R1ContinuousUniformPiecewiseDisplaced Constructor

Method Summary

Modifier and Type	Method	Description
double[]	_predictorOrdinateArray()	Retrieve the Array of Predictor Ordinates
double	cumulative(double x)	Compute the cumulative under the distribution to the given value
double	density(double x)	Compute the Density under the Distribution at the given Variate
double	densityDisplacement()	Retrieve the Density Displacement
Array2D	histogram()	Retrieve the Univariate Weighted Histogram
double	invCumulative(double y)	Compute the inverse cumulative under the distribution corresponding to the given value
double[]	piecewiseDensitySlopeArray()	Retrieve the Array of Piecewise Density Slopes
static R1ContinuousUniformPiecewiseDisplaced	Standard(double leftPredictorOrdinateEdge, double rightPredictorOrdinateEdge, double[] predictorOrdinateArray, double[] cumulativeProbabilityArray, double mean)	Calibrate an R1ContinuousUniformPiecewiseDisplaced Lebesgue Instance

Methods inherited from class org.drip.measure.distribution.R1ContinuousUniform

incremental, leftSupport, mean, random, rightSupport, Standard, support, supported, variance

Methods inherited from class org.drip.measure.distribution.R1Continuous

bPOE, centralMoment, cvar, differentialEntropy, excessKurtosis, expectedShortfall, fisherInformation, iqr, kullbackLeiblerDivergence, median, mode, nonCentralMoment, populationCentralMeasures, probabilityGeneratingFunction, quadratureEstimator, quantile, randomArray, skewness, tukeyAnomaly, tukeyCriterion

Methods inherited from class java.lang.Object

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

Constructor Details

R1ContinuousUniformPiecewiseDisplaced

public R1ContinuousUniformPiecewiseDisplaced(double leftPredictorOrdinateEdge,
double rightPredictorOrdinateEdge,
double[] predictorOrdinateArray,
double[] piecewiseDensitySlopeArray,
double densityDisplacement)
                                      throws java.lang.Exception

R1ContinuousUniformPiecewiseDisplaced Constructor

Parameters:

leftPredictorOrdinateEdge - Left Predictor Ordinate Edge

rightPredictorOrdinateEdge - Right Predictor Ordinate Edge

predictorOrdinateArray - Array of Intermediate Predictor Ordinates

piecewiseDensitySlopeArray - Array of corresponding Piece-wise Density Slopes

densityDisplacement - Uniform Density Displacement

Throws:

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

Method Details

Standard

public static final R1ContinuousUniformPiecewiseDisplaced Standard(double leftPredictorOrdinateEdge,
double rightPredictorOrdinateEdge,
double[] predictorOrdinateArray,
double[] cumulativeProbabilityArray,
double mean)

Calibrate an R1ContinuousUniformPiecewiseDisplaced Lebesgue Instance

Parameters:

leftPredictorOrdinateEdge - Left Predictor Ordinate Edge

rightPredictorOrdinateEdge - Right Predictor Ordinate Edge

predictorOrdinateArray - Array of Intermediate Predictor Ordinates

cumulativeProbabilityArray - Array of corresponding Cumulative Probabilities

mean - The Distribution Mean

Returns:

The R1ContinuousUniformPiecewiseDisplaced Instance

_predictorOrdinateArray

public double[] _predictorOrdinateArray()

Retrieve the Array of Predictor Ordinates

Returns:

The Array of Predictor Ordinates

piecewiseDensitySlopeArray

public double[] piecewiseDensitySlopeArray()

Retrieve the Array of Piecewise Density Slopes

Returns:

The Array of Piecewise Density Slopes

densityDisplacement

public double densityDisplacement()

Retrieve the Density Displacement

Returns:

The Density Displacement

cumulative

public double cumulative(double x)
                  throws java.lang.Exception

Compute the cumulative under the distribution to the given value

Overrides:

cumulative in class R1ContinuousUniform

Parameters:

x - Variate to which the cumulative is to be computed

Returns:

The cumulative

Throws:

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

invCumulative

public double invCumulative(double y)
                     throws java.lang.Exception

Compute the inverse cumulative under the distribution corresponding to the given value

Overrides:

invCumulative in class R1ContinuousUniform

Parameters:

y - Value corresponding to which the inverse cumulative is to be computed

Returns:

The inverse cumulative

Throws:

java.lang.Exception - Thrown if the Input is invalid

density

public double density(double x)
               throws java.lang.Exception

Compute the Density under the Distribution at the given Variate

Overrides:

density in class R1ContinuousUniform

Parameters:

x - Variate at which the Density needs to be computed

Returns:

The Density

Throws:

java.lang.Exception - Thrown if the input is invalid

histogram

public Array2D histogram()

Retrieve the Univariate Weighted Histogram

Overrides:

histogram in class R1ContinuousUniform

Returns:

The Univariate Weighted Histogram