Class TruncatableDistribution<T>
Inherited Members
Namespace: Microsoft.ML.Probabilistic.Distributions
Assembly: Microsoft.ML.Probabilistic.dll
Syntax
public class TruncatableDistribution<T> : ITruncatableDistribution<T>, CanGetProbLessThan<T>, CanGetQuantile<T>Type Parameters
| Name | Description |
|---|---|
| T |
Constructors
TruncatableDistribution(CanGetProbLessThan<T>)
Declaration
public TruncatableDistribution(CanGetProbLessThan<T> canGetProbLessThan)Parameters
| Type | Name | Description |
|---|---|---|
| CanGetProbLessThan<T> | canGetProbLessThan |
Properties
CanGetProbLessThan
Declaration
public CanGetProbLessThan<T> CanGetProbLessThan { get; }Property Value
| Type | Description |
|---|---|
| CanGetProbLessThan<T> |
Methods
GetProbBetween(T, T)
Returns the probability mass in an interval.
Declaration
public double GetProbBetween(T lowerBound, T upperBound)Parameters
| Type | Name | Description |
|---|---|---|
| T | lowerBound | Inclusive |
| T | upperBound | Exclusive |
Returns
| Type | Description |
|---|---|
| Double | A number between 0 and 1, inclusive. |
GetProbLessThan(T)
Returns the probability of drawing a sample less than x.
Declaration
public double GetProbLessThan(T x)Parameters
| Type | Name | Description |
|---|---|---|
| T | x | Any number. |
Returns
| Type | Description |
|---|---|
| Double | A real number in [0,1]. |
GetQuantile(Double)
Returns the largest value x such that GetProbLessThan(x) <= probability.
Declaration
public T GetQuantile(double probability)Parameters
| Type | Name | Description |
|---|---|---|
| Double | probability | A real number in [0,1]. |
Returns
| Type | Description |
|---|---|
| T | A number |
ToString()
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| String |
Overrides
Truncate(T, T)
Returns the distribution of values restricted to an interval.
Declaration
public ITruncatableDistribution<T> Truncate(T lowerBound, T upperBound)Parameters
| Type | Name | Description |
|---|---|---|
| T | lowerBound | Inclusive |
| T | upperBound | Exclusive |
Returns
| Type | Description |
|---|---|
| ITruncatableDistribution<T> |