Share via


RandomParameter Class

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

Represents a group of terms that take stochastic values.

Inheritance Hierarchy

System.Object
  Microsoft.SolverFoundation.Services.Term
    Microsoft.SolverFoundation.Services.RandomParameter
      Microsoft.SolverFoundation.Services.BinomialDistributionParameter
      Microsoft.SolverFoundation.Services.ExponentialDistributionParameter
      Microsoft.SolverFoundation.Services.GeometricDistributionParameter
      Microsoft.SolverFoundation.Services.LogNormalDistributionParameter
      Microsoft.SolverFoundation.Services.NormalDistributionParameter
      Microsoft.SolverFoundation.Services.ScenariosParameter
      Microsoft.SolverFoundation.Services.UniformDistributionParameter

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

Syntax

'Declaration
Public MustInherit Class RandomParameter _
    Inherits Term
public abstract class RandomParameter : Term
public ref class RandomParameter abstract : public Term
[<AbstractClass>]
type RandomParameter =  
    class
        inherit Term
    end
public abstract class RandomParameter extends Term

The RandomParameter type exposes the following members.

Constructors

  Name Description
Protected method RandomParameter(String) Initializes a new instance of the RandomParameter class.
Protected method RandomParameter(String, array<Set[]) Initializes a new instance of the RandomParameter class with the specified index sets.

Top

Properties

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

Top

Methods

  Name Description
Protected method DataBind Binds the data to the solver context.
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 methodStatic member GetIndexes<T> Returns the indexes from a parameter object.
Protected method GetIndexFieldGetters<T> Creates get accessors for each index.
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 SetIndexSet Returns the specified index set.
Public method ToString() Converts a parameter to its equivalent string representation. (Overrides Object.ToString().)
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.

Top

Remarks

Random parameters are used to model randomness in input data. Random parameters can be discrete or continuous, and can be used where non-random parameters or constants would normally be used in constraints. The RandomParameter class is the base class for a number of commonly used random distributions, including uniform, normal, and log normal. ScenariosParameter is a special type of random parameter, for which each scenario contains a value and a probability.

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