RandomParameter Class

Article
12/06/2011

[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

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
	RandomParameter(String)	Initializes a new instance of the RandomParameter class.
	RandomParameter(String, array<Set[])	Initializes a new instance of the RandomParameter class with the specified index sets.

Top

Properties

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

Top

Methods

	Name	Description
	DataBind	Binds the data to the solver context.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetIndexes<T>	Returns the indexes from a parameter object.
	GetIndexFieldGetters<T>	Creates get accessors for each index.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	SetIndexSet	Returns the specified index set.
	ToString()	Converts a parameter to its equivalent string representation. (Overrides Object.ToString().)
	ToString(String, IFormatProvider)	Converts a term to its equivalent string representation. (Inherited from Term.)
	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.