//
// Math.NET Numerics, part of the Math.NET Project
// http://numerics.mathdotnet.com
// http://github.com/mathnet/mathnet-numerics
// http://mathnetnumerics.codeplex.com
//
// Copyright (c) 2009-2013 Math.NET
//
// Permission is hereby granted, free of charge, to any person
// obtaining a copy of this software and associated documentation
// files (the "Software"), to deal in the Software without
// restriction, including without limitation the rights to use,
// copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following
// conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
// OTHER DEALINGS IN THE SOFTWARE.
//
using System;
using System.Collections.Generic;
using MathNet.Numerics.Properties;
using MathNet.Numerics.Random;
namespace MathNet.Numerics.Distributions
{
///
/// Triangular distribution.
/// For details, see Wikipedia - Triangular distribution.
///
/// The distribution will use the by default.
/// Users can get/set the random number generator by using the property.
/// The statistics classes will check whether all the incoming parameters are in the allowed range. This might involve heavy computation. Optionally, by setting Control.CheckDistributionParameters
/// to false, all parameter checks can be turned off.
public class Triangular : IContinuousDistribution
{
System.Random _random;
double _lower;
double _upper;
double _mode;
///
/// Initializes a new instance of the Triangular class with the given lower bound, upper bound and mode.
///
/// Lower bound. Range: lower ≤ mode ≤ upper
/// Upper bound. Range: lower ≤ mode ≤ upper
/// Mode (most frequent value). Range: lower ≤ mode ≤ upper
/// If the upper bound is smaller than the mode or if the mode is smaller than the lower bound.
public Triangular(double lower, double upper, double mode)
{
_random = SystemRandomSource.Default;
SetParameters(lower, upper, mode);
}
///
/// Initializes a new instance of the Triangular class with the given lower bound, upper bound and mode.
///
/// Lower bound. Range: lower ≤ mode ≤ upper
/// Upper bound. Range: lower ≤ mode ≤ upper
/// Mode (most frequent value). Range: lower ≤ mode ≤ upper
/// The random number generator which is used to draw random samples.
/// If the upper bound is smaller than the mode or if the mode is smaller than the lower bound.
public Triangular(double lower, double upper, double mode, System.Random randomSource)
{
_random = randomSource ?? SystemRandomSource.Default;
SetParameters(lower, upper, mode);
}
///
/// A string representation of the distribution.
///
/// a string representation of the distribution.
public override string ToString()
{
return "Triangular(Lower = " + _lower + ", Upper = " + _upper + ", Mode = " + _mode + ")";
}
///
/// Sets the parameters of the distribution after checking their validity.
///
/// Lower bound. Range: lower ≤ mode ≤ upper
/// Upper bound. Range: lower ≤ mode ≤ upper
/// Mode (most frequent value). Range: lower ≤ mode ≤ upper
/// When the parameters are out of range.
void SetParameters(double lower, double upper, double mode)
{
if (upper < mode || mode < lower || Double.IsNaN(upper) || Double.IsNaN(lower) || Double.IsNaN(mode))
{
throw new ArgumentOutOfRangeException(Resources.InvalidDistributionParameters);
}
_lower = lower;
_upper = upper;
_mode = mode;
}
///
/// Gets or sets the lower bound of the distribution.
///
public double LowerBound
{
get { return _lower; }
set { SetParameters(value, _upper, _mode); }
}
///
/// Gets or sets the upper bound of the distribution.
///
public double UpperBound
{
get { return _upper; }
set { SetParameters(_lower, value, _mode); }
}
///
/// Gets or sets the random number generator which is used to draw random samples.
///
public System.Random RandomSource
{
get { return _random; }
set { _random = value ?? SystemRandomSource.Default; }
}
///
/// Gets the mean of the distribution.
///
public double Mean
{
get { return (_lower + _upper + _mode) / 3.0; }
}
///
/// Gets the variance of the distribution.
///
public double Variance
{
get
{
var a = _lower;
var b = _upper;
var c = _mode;
return (a * a + b * b + c * c - a * b - a * c - b * c) / 18.0;
}
}
///
/// Gets the standard deviation of the distribution.
///
public double StdDev
{
get { return Math.Sqrt(Variance); }
}
///
/// Gets the entropy of the distribution.
///
///
public double Entropy
{
get { return 0.5 + Math.Log((_upper - _lower) / 2); }
}
///
/// Gets the skewness of the distribution.
///
public double Skewness
{
get
{
var a = _lower;
var b = _upper;
var c = _mode;
var q = Math.Sqrt(2) * (a + b - 2 * c) * (2 * a - b - c) * (a - 2 * b + c);
var d = 5 * Math.Pow(a * a + b * b + c * c - a * b - a * c - b * c, 3.0 / 2);
return q / d;
}
}
///
/// Gets or sets the mode of the distribution.
///
public double Mode
{
get { return _mode; }
set { SetParameters(_lower, _upper, value); }
}
///
/// Gets the median of the distribution.
///
///
public double Median
{
get
{
var a = _lower;
var b = _upper;
var c = _mode;
return c >= (a + b) / 2
? a + Math.Sqrt((b - a) * (c - a) / 2)
: b - Math.Sqrt((b - a) * (b - c) / 2);
}
}
///
/// Gets the minimum of the distribution.
///
public double Minimum
{
get { return _lower; }
}
///
/// Gets the maximum of the distribution.
///
public double Maximum
{
get { return _upper; }
}
///
/// Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x.
///
/// The location at which to compute the density.
/// the density at .
///
public double Density(double x)
{
return PDF(_lower, _upper, _mode, x);
}
///
/// Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x).
///
/// The location at which to compute the log density.
/// the log density at .
///
public double DensityLn(double x)
{
return PDFLn(_lower, _upper, _mode, x);
}
///
/// Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x).
///
/// The location at which to compute the cumulative distribution function.
/// the cumulative distribution at location .
///
public double CumulativeDistribution(double x)
{
return CDF(_lower, _upper, _mode, x);
}
///
/// Computes the inverse of the cumulative distribution function (InvCDF) for the distribution
/// at the given probability. This is also known as the quantile or percent point function.
///
/// The location at which to compute the inverse cumulative density.
/// the inverse cumulative density at .
///
public double InverseCumulativeDistribution(double p)
{
return InvCDF(_lower, _upper, _mode, p);
}
///
/// Generates a sample from the Triangular distribution.
///
/// a sample from the distribution.
public double Sample()
{
return Sample(_random, _lower, _upper, _mode);
}
///
/// Generates a sequence of samples from the Triangular distribution.
///
/// a sequence of samples from the distribution.
public IEnumerable Samples()
{
return Samples(_random, _lower, _upper, _mode);
}
///
/// Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x.
///
/// Lower bound. Range: lower ≤ mode ≤ upper
/// Upper bound. Range: lower ≤ mode ≤ upper
/// Mode (most frequent value). Range: lower ≤ mode ≤ upper
/// The location at which to compute the density.
/// the density at .
///
public static double PDF(double lower, double upper, double mode, double x)
{
if (upper < mode) throw new ArgumentOutOfRangeException("upper", Resources.InvalidDistributionParameters);
if (mode < lower) throw new ArgumentOutOfRangeException("lower", Resources.InvalidDistributionParameters); // TODO: Is "lower" the appropriate argument here?
var a = lower;
var b = upper;
var c = mode;
if (a <= x && x <= c) return 2 * (x - a) / ((b - a) * (c - a));
if (c < x & x <= b) return 2 * (b - x) / ((b - a) * (b - c));
return 0;
}
///
/// Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x).
///
/// Lower bound. Range: lower ≤ mode ≤ upper
/// Upper bound. Range: lower ≤ mode ≤ upper
/// Mode (most frequent value). Range: lower ≤ mode ≤ upper
/// The location at which to compute the density.
/// the log density at .
///
public static double PDFLn(double lower, double upper, double mode, double x)
{
return Math.Log(PDF(lower, upper, mode, x));
}
///
/// Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x).
///
/// The location at which to compute the cumulative distribution function.
/// Lower bound. Range: lower ≤ mode ≤ upper
/// Upper bound. Range: lower ≤ mode ≤ upper
/// Mode (most frequent value). Range: lower ≤ mode ≤ upper
/// the cumulative distribution at location .
///
public static double CDF(double lower, double upper, double mode, double x)
{
if (upper < mode) throw new ArgumentOutOfRangeException("upper", Resources.InvalidDistributionParameters);
if (mode < lower) throw new ArgumentOutOfRangeException("lower", Resources.InvalidDistributionParameters); // TODO: Is "lower" the appropriate argument here?
var a = lower;
var b = upper;
var c = mode;
if (x < a) return 0;
if (a <= x && x <= c) return (x - a) * (x - a) / ((b - a) * (c - a));
if (c < x & x <= b) return 1 - (b - x) * (b - x) / ((b - a) * (b - c));
return 1;
}
///
/// Computes the inverse of the cumulative distribution function (InvCDF) for the distribution
/// at the given probability. This is also known as the quantile or percent point function.
///
/// The location at which to compute the inverse cumulative density.
/// Lower bound. Range: lower ≤ mode ≤ upper
/// Upper bound. Range: lower ≤ mode ≤ upper
/// Mode (most frequent value). Range: lower ≤ mode ≤ upper
/// the inverse cumulative density at .
///
public static double InvCDF(double lower, double upper, double mode, double p)
{
if (upper < mode) throw new ArgumentOutOfRangeException("upper", Resources.InvalidDistributionParameters);
if (mode < lower) throw new ArgumentOutOfRangeException("lower", Resources.InvalidDistributionParameters); // TODO: Is "lower" the appropriate argument here?
var a = lower;
var b = upper;
var c = mode;
if (p <= 0) return lower;
// Taken from http://www.ntrand.com/triangular-distribution/
if (p < (c - a) / (b - a)) return a + Math.Sqrt(p * (c - a) * (b - a));
if (p < 1) return b - Math.Sqrt((1 - p) * (b - c) * (b - a));
return upper;
}
///
/// Generates a sample from the Triangular distribution.
///
/// The random number generator to use.
/// Lower bound. Range: lower ≤ mode ≤ upper
/// Upper bound. Range: lower ≤ mode ≤ upper
/// Mode (most frequent value). Range: lower ≤ mode ≤ upper
/// a sample from the distribution.
public double Sample(System.Random rnd, double lower, double upper, double mode)
{
var a = lower;
var b = upper;
var c = mode;
var u = rnd.NextDouble();
return u < (c - a) / (b - a)
? a + Math.Sqrt(u * (b - a) * (c - a))
: b - Math.Sqrt((1 - u) * (b - a) * (b - c)); ;
}
///
/// Generates a sequence of samples from the Triangular distribution.
///
/// The random number generator to use.
/// Lower bound. Range: lower ≤ mode ≤ upper
/// Upper bound. Range: lower ≤ mode ≤ upper
/// Mode (most frequent value). Range: lower ≤ mode ≤ upper
/// a sequence of samples from the distribution.
public IEnumerable Samples(System.Random rnd, double lower, double upper, double mode)
{
while (true)
{
yield return Sample(rnd, lower, upper, mode);
}
}
}
}