Class Curve

Represents a probability distribution.

Inheritance

object

Curve

Implements

IHasParameters

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: Microsoft.XboxStudios.BotBrain.Statistics

Assembly: BotBrain.Core.dll

Syntax

[JsonConverter(typeof(CurveConverter))]
public class Curve : IHasParameters

Fields

DefaultExponentialQuantile

The default quantile for the pivot value of an exponential distribution.

Declaration

public const float DefaultExponentialQuantile = 0.01

Field Value

Type	Description
float

DefaultLogLogisticQuantile

The default quantile for the pivot value of a log-logistic distribution.

Declaration

public const float DefaultLogLogisticQuantile = 0.05

Field Value

Type	Description
float

DefaultLogLogisticShape

The default shape for a log-logistic distribution.

Declaration

public const float DefaultLogLogisticShape = 2

Field Value

Type	Description
float

ScaleParameter

The name of the scale parameter.

Declaration

public const string ScaleParameter = "Scale"

Field Value

Type	Description
string

ShapeParameter

The name of the shape parameter.

Declaration

public const string ShapeParameter = "Shape"

Field Value

Type	Description
string

Properties

Direction

Gets or sets a value indicating whether or not the probabilities increase as the input increases.

Declaration

public CurveDirection? Direction { get; set; }

Property Value

Type	Description
CurveDirection?

Parameters

Gets or sets the curve's parameters.

Declaration

public IParameterManager Parameters { get; set; }

Property Value

Type	Description
IParameterManager

Type

Gets or sets the probability curve type.

Declaration

public ProbabilityCurve Type { get; set; }

Property Value

Type	Description
ProbabilityCurve

Methods

Evaluate(float, float)

Evaluates a value on the curve, returning its quantile or survival function.

Declaration

public float? Evaluate(float value, float maxValue)

Parameters

Type	Name	Description
float	value	The input value to evaluate.
float	maxValue	The maximum possible value that can be input.

Returns

Type	Description
float?	A value between 0 and 1.

ToString()

Returns a string that represents the current object.

Declaration

public override string ToString()

Returns

Type	Description
string	A string that represents the current object.

Overrides

object.ToString()

Implements

IHasParameters