IGLib  1.7.2
The IGLib base library EXTENDED - with other lilbraries and applications.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Meta.Numerics.Statistics.Distributions.LogisticDistribution Class Reference

Represents a logistic distribution. More...

+ Inheritance diagram for Meta.Numerics.Statistics.Distributions.LogisticDistribution:
+ Collaboration diagram for Meta.Numerics.Statistics.Distributions.LogisticDistribution:

Public Member Functions

 LogisticDistribution ()
 Initializes a new standard logistic distribution. More...
 
 LogisticDistribution (double m, double s)
 Initializes a new logistic distribution with the given mean and width parameters. More...
 
override double ProbabilityDensity (double x)
 Returns the probability density at the given point.
Parameters
xThe reference point.
Returns
The probability density p(x).
The probability density function (PDF) gives the relative probability of obtaining different values. More...
 
override double LeftProbability (double x)
 Returns the cumulative probability to the left of (below) the given point.
Parameters
xThe reference point.
Returns
The integrated probability to obtain a result below the reference point.
The left probability function is commonly called the cumulative distribution function (CDF). More...
 
override double RightProbability (double x)
 Return the cumulative probability to the right of (above) the given point.
Parameters
xThe reference point.
Returns
The integrated probability 1-P(x1) to obtain a result above the reference point.
In survival analysis, the right probability function is commonly called the survival function, because it gives the fraction of the population remaining after the given time. More...
 
override double InverseLeftProbability (double P)
 Returns the point at which the cumulative distribution function attains a given value.
Parameters
PThe left cumulative probability P, which must lie between 0 and 1.
Returns
The value x at which LeftProbability equals P.
The inverse left probability is commonly called the quantile function. Given a quantile, it tells which variable value is the lower border of that quantile. More...
 
override double InverseRightProbability (double Q)
 Returns the point at which the right probability function attains the given value.
Parameters
QThe right cumulative probability, which must lie between 0 and 1.
Returns
The value x for which RightProbability equals Q.
More...
 
override double Moment (int r)
 Computes a raw moment of the distribution.
Parameters
rThe order of the moment to compute.
Returns
The rth raw moment of the distribution.
See also
Moment
More...
 
override double MomentAboutMean (int r)
 Computes a central moment of the distribution.
Parameters
rThe order of the moment to compute.
Returns
The rth central moment of the distribution.
See also
Moment
More...
 
override double Cumulant (int r)
 Computes a cumulant of the distribution.
Parameters
rThe index of the cumulant to compute.
Returns
The rth cumulant of the distribution.
More...
 
- Public Member Functions inherited from Meta.Numerics.Statistics.Distributions.Distribution
virtual double ExpectationValue (Func< double, double > f)
 Computes the expectation value of the given function. More...
 
virtual double GetRandomValue (Random rng)
 Returns a random value. More...
 

Properties

override double Mean [get]
 
override double Median [get]
 
override double StandardDeviation [get]
 
override double Variance [get]
 
override double Skewness [get]
 
override double ExcessKurtosis [get]
 
- Properties inherited from Meta.Numerics.Statistics.Distributions.Distribution
virtual double Median [get]
 Gets the median of the distribution. More...
 
virtual Interval Support [get]
 Gets the interval over which the distribution is nonvanishing. More...
 
- Properties inherited from Meta.Numerics.Statistics.Distributions.UnivariateDistribution
virtual double Mean [get]
 Gets the mean of the distribution. More...
 
virtual double Variance [get]
 Gets the variance of the distribution. More...
 
virtual double StandardDeviation [get]
 Gets the standard deviation of the distribution. More...
 
virtual double Skewness [get]
 Gets the skewness of the distribution. More...
 
virtual double ExcessKurtosis [get]
 Gets the excess kurtosis of the distribution. More...
 

Private Member Functions

double InverseProbability (double P, double Q)
 
double[]
IParameterizedDistribution. 
GetParameters ()
 Gets the parameter values of the distribution. More...
 
void IParameterizedDistribution. SetParameters (IList< double > parameters)
 Sets the parameter values of the distribution. More...
 
double IParameterizedDistribution. Likelihood (double x)
 Gets the likelihood of a value, given the current parameters. More...
 

Private Attributes

double m
 
double s
 

Detailed Description

Represents a logistic distribution.

Like the normal distribution, the logistic distribution is a symmetric, unimodal distribution distribution with exponentially supressed tails.

A logistic distribution with mean zero and standard deviation one is called a standard logistic distribution. Any logistic distribution can be converted to a standard logistic distribution by reparameterzing into z = (x-m)/s.

Constructor & Destructor Documentation

Meta.Numerics.Statistics.Distributions.LogisticDistribution.LogisticDistribution ( )
inline

Initializes a new standard logistic distribution.

The standard logistic distribution has zero mean and a unit width parameter.

Meta.Numerics.Statistics.Distributions.LogisticDistribution.LogisticDistribution ( double  m,
double  s 
)
inline

Initializes a new logistic distribution with the given mean and width parameters.

Parameters
mThe mean.
sThe width parameter.

Member Function Documentation

override double Meta.Numerics.Statistics.Distributions.LogisticDistribution.ProbabilityDensity ( double  x)
inlinevirtual

Returns the probability density at the given point.

Parameters
xThe reference point.
Returns
The probability density p(x).
The probability density function (PDF) gives the relative probability of obtaining different values.

Implements Meta.Numerics.Statistics.Distributions.Distribution.

override double Meta.Numerics.Statistics.Distributions.LogisticDistribution.LeftProbability ( double  x)
inlinevirtual

Returns the cumulative probability to the left of (below) the given point.

Parameters
xThe reference point.
Returns
The integrated probability to obtain a result below the reference point.
The left probability function is commonly called the cumulative distribution function (CDF).

Reimplemented from Meta.Numerics.Statistics.Distributions.Distribution.

override double Meta.Numerics.Statistics.Distributions.LogisticDistribution.RightProbability ( double  x)
inlinevirtual

Return the cumulative probability to the right of (above) the given point.

Parameters
xThe reference point.
Returns
The integrated probability 1-P(x1) to obtain a result above the reference point.
In survival analysis, the right probability function is commonly called the survival function, because it gives the fraction of the population remaining after the given time.

Reimplemented from Meta.Numerics.Statistics.Distributions.Distribution.

override double Meta.Numerics.Statistics.Distributions.LogisticDistribution.InverseLeftProbability ( double  P)
inlinevirtual

Returns the point at which the cumulative distribution function attains a given value.

Parameters
PThe left cumulative probability P, which must lie between 0 and 1.
Returns
The value x at which LeftProbability equals P.
The inverse left probability is commonly called the quantile function. Given a quantile, it tells which variable value is the lower border of that quantile.

Reimplemented from Meta.Numerics.Statistics.Distributions.Distribution.

override double Meta.Numerics.Statistics.Distributions.LogisticDistribution.InverseRightProbability ( double  Q)
inlinevirtual

Returns the point at which the right probability function attains the given value.

Parameters
QThe right cumulative probability, which must lie between 0 and 1.
Returns
The value x for which RightProbability equals Q.

Reimplemented from Meta.Numerics.Statistics.Distributions.Distribution.

double Meta.Numerics.Statistics.Distributions.LogisticDistribution.InverseProbability ( double  P,
double  Q 
)
inlineprivate
override double Meta.Numerics.Statistics.Distributions.LogisticDistribution.Moment ( int  r)
inlinevirtual

Computes a raw moment of the distribution.

Parameters
rThe order of the moment to compute.
Returns
The rth raw moment of the distribution.
See also
Moment

Reimplemented from Meta.Numerics.Statistics.Distributions.Distribution.

References Meta.Numerics.Statistics.Distributions.MomentMath.CentralToRaw().

override double Meta.Numerics.Statistics.Distributions.LogisticDistribution.MomentAboutMean ( int  r)
inlinevirtual

Computes a central moment of the distribution.

Parameters
rThe order of the moment to compute.
Returns
The rth central moment of the distribution.
See also
Moment

Reimplemented from Meta.Numerics.Statistics.Distributions.Distribution.

References Meta.Numerics.Functions.AdvancedMath.DirichletEta(), Meta.Numerics.Functions.AdvancedIntegerMath.Factorial(), and Meta.Numerics.MoreMath.Pow().

override double Meta.Numerics.Statistics.Distributions.LogisticDistribution.Cumulant ( int  r)
inlinevirtual

Computes a cumulant of the distribution.

Parameters
rThe index of the cumulant to compute.
Returns
The rth cumulant of the distribution.

Reimplemented from Meta.Numerics.Statistics.Distributions.UnivariateDistribution.

References Meta.Numerics.Functions.AdvancedIntegerMath.Factorial(), Meta.Numerics.MoreMath.Pow(), and Meta.Numerics.Functions.AdvancedMath.RiemannZeta().

double [] IParameterizedDistribution. Meta.Numerics.Statistics.Distributions.LogisticDistribution.GetParameters ( )
inlineprivate

Gets the parameter values of the distribution.

Returns
The parameter values characterizing the distribution.

Implements Meta.Numerics.Statistics.Distributions.IParameterizedDistribution.

void IParameterizedDistribution. Meta.Numerics.Statistics.Distributions.LogisticDistribution.SetParameters ( IList< double >  parameters)
inlineprivate

Sets the parameter values of the distribution.

Parameters
parametersA list of parameter values.

Implements Meta.Numerics.Statistics.Distributions.IParameterizedDistribution.

double IParameterizedDistribution. Meta.Numerics.Statistics.Distributions.LogisticDistribution.Likelihood ( double  x)
inlineprivate

Gets the likelihood of a value, given the current parameters.

Parameters
xThe value.
Returns
The likelihood of the value.

Implements Meta.Numerics.Statistics.Distributions.IParameterizedDistribution.

Member Data Documentation

double Meta.Numerics.Statistics.Distributions.LogisticDistribution.m
private
double Meta.Numerics.Statistics.Distributions.LogisticDistribution.s
private

Property Documentation

override double Meta.Numerics.Statistics.Distributions.LogisticDistribution.Mean
get

override double Meta.Numerics.Statistics.Distributions.LogisticDistribution.Median
get

override double Meta.Numerics.Statistics.Distributions.LogisticDistribution.StandardDeviation
get

override double Meta.Numerics.Statistics.Distributions.LogisticDistribution.Variance
get

override double Meta.Numerics.Statistics.Distributions.LogisticDistribution.Skewness
get

override double Meta.Numerics.Statistics.Distributions.LogisticDistribution.ExcessKurtosis
get


The documentation for this class was generated from the following file: