GeometricDistributionParameter Class

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

A random parameter with geometric distribution.

Inheritance Hierarchy

System.Object
  Microsoft.SolverFoundation.Services.Term
    Microsoft.SolverFoundation.Services.RandomParameter
      Microsoft.SolverFoundation.Services.GeometricDistributionParameter

Namespace:  Microsoft.SolverFoundation.Services
Assembly:  Microsoft.Solver.Foundation (in Microsoft.Solver.Foundation.dll)

Syntax

'Declaration
Public NotInheritable Class GeometricDistributionParameter _
    Inherits RandomParameter
public sealed class GeometricDistributionParameter : RandomParameter
public ref class GeometricDistributionParameter sealed : public RandomParameter
[<Sealed>]
type GeometricDistributionParameter =  
    class
        inherit RandomParameter
    end
public final class GeometricDistributionParameter extends RandomParameter

The GeometricDistributionParameter type exposes the following members.

Constructors

  Name Description
Public method GeometricDistributionParameter(String) Creates a non-indexed geometric distribution parameter. Initializes a new instance of the GeometricDistributionParameter class.
Public method GeometricDistributionParameter(String, array<Set[]) Creates a non-indexed geometric distribution parameter. Initializes a new instance of the GeometricDistributionParameter class.
Public method GeometricDistributionParameter(String, Double) Creates a non-indexed geometric distribution parameter. Initializes a new instance of the GeometricDistributionParameter class.

Top

Properties

  Name Description
Public property Description Gets or sets a description of a parameter object. (Inherited from RandomParameter.)
Public property IndexSets Gets the index sets for a parameter object. (Inherited from RandomParameter.)
Public property Item Returns the random parameter specified by the indexes. (Inherited from RandomParameter.)
Public property Name Gets the name of a parameter. (Inherited from RandomParameter.)

Top

Methods

  Name Description
Protected method DataBind Binds the data to the solver context. (Inherited from RandomParameter.)
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Protected method GetIndexFieldGetters<T> Creates get accessors for each index. (Inherited from RandomParameter.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method SetBinding<T>(IEnumerable<T>, String) Binds the parameter to data.
Public method SetBinding<T>(IEnumerable<T>, String, array<String[]) Binds the parameter to data.
Public method SetIndexSet Returns the specified index set. (Inherited from RandomParameter.)
Public method ToString() Converts a parameter to its equivalent string representation. (Inherited from RandomParameter.)
Public method ToString(String, IFormatProvider) Converts a term to its equivalent string representation. (Inherited from Term.)
Protected method VerifyModelNotFrozen Verifies that the associated model is not frozen. (Inherited from RandomParameter.)

Top

Remarks

A geometric distribution is a discrete random distribution defined by a success probability parameter. The distribution describes a process where independent Bernoulli trials are taken with the given success probability. The probability distribution is of the number Y = X - 1 of Bernoulli trial failures before the first success, supported on the set { 0, 1, 2, 3, ... }. Note that this is different from an alternate convention which defines the distribution as the first successful trial supported on the set {1, 2, 3, ... }.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.SolverFoundation.Services Namespace