Interface CanCreatePointMass<T, TDist>

Whether the distribution supports being a point mass.

Namespace: Microsoft.ML.Probabilistic.Distributions

Assembly: Microsoft.ML.Probabilistic.dll

Syntax

[Quality(QualityBand.Experimental)]
public interface CanCreatePointMass<T, out TDist>

Type Parameters

Name	Description
T	The type of objects in the domain, e.g. Vector or Matrix.
TDist	The type of the distribution.

Properties

IsPointMass

Gets whether the distribution parameters represent a point mass.

Declaration

bool IsPointMass { get; }

Property Value

Type	Description
Boolean

Point

Access the location of a point mass.

Declaration

T Point { get; }

Property Value

Type	Description
T

Remarks

If the distribution parameters do not represent a point mass, getting this property returns an undefined value (if T is a ValueType) or a storage area with undefined contents (if T is a reference type). It should not throw an exception.

If T is a reference type, then the result is volatile and its contents expire upon invoking any subsequent distribution method, unless T is immutable.

Point is a property because it is expected that each distribution would have a corresponding data field. Accessing the Point should take constant time.

Methods

CreatePointMass(T)

Creates a point mass distribution.

Declaration

TDist CreatePointMass(T point)

Parameters

Type	Name	Description
T	point	The location of the point mass.

Returns

Type	Description
TDist	The created distribution.