HybridLocalSearchSolver 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.]

A solver that uses simple, general-purpose local search strategies.

Inheritance Hierarchy

System.Object
Microsoft.SolverFoundation.Solvers.HybridLocalSearchModel
Microsoft.SolverFoundation.Solvers.HybridLocalSearchSolver

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

Syntax

'Declaration
Public Class HybridLocalSearchSolver _
    Inherits HybridLocalSearchModel _
    Implements ITermSolver, IRowVariableSolver, ISolver, ITermModel,  _
    IRowVariableModel, IGoalModel, INonlinearSolution, ISolverSolution, ISolverProperties,  _
    IReportProvider

public class HybridLocalSearchSolver : HybridLocalSearchModel, 
    ITermSolver, IRowVariableSolver, ISolver, ITermModel, IRowVariableModel, 
    IGoalModel, INonlinearSolution, ISolverSolution, ISolverProperties, IReportProvider

public ref class HybridLocalSearchSolver : public HybridLocalSearchModel, 
    ITermSolver, IRowVariableSolver, ISolver, ITermModel, IRowVariableModel, 
    IGoalModel, INonlinearSolution, ISolverSolution, ISolverProperties, IReportProvider

type HybridLocalSearchSolver =  
    class
        inherit HybridLocalSearchModel
        interface ITermSolver
        interface IRowVariableSolver
        interface ISolver
        interface ITermModel
        interface IRowVariableModel
        interface IGoalModel
        interface INonlinearSolution
        interface ISolverSolution
        interface ISolverProperties
        interface IReportProvider
    end

public class HybridLocalSearchSolver extends HybridLocalSearchModel implements ITermSolver, IRowVariableSolver, ISolver, ITermModel, IRowVariableModel, IGoalModel, INonlinearSolution, ISolverSolution, ISolverProperties, IReportProvider

The HybridLocalSearchSolver type exposes the following members.

Constructors

	Name	Description
	HybridLocalSearchSolver	Initializes a new instance of the HybridLocalSearchSolver class.

Top

Properties

	Name	Description
	ConstraintsCount	Specifies the number of constraints. (Inherited from HybridLocalSearchModel.)
	GoalsCount	Specifies the number of goals. (Inherited from HybridLocalSearchModel.)
	RandomSeed	Sets the random seed that (re)initializes the random number sequence generation. (Inherited from HybridLocalSearchModel.)
	Result	Returns a Non-linear Result.
	Step	Specifies the current step number of the search when it is running. (Inherited from HybridLocalSearchModel.)
	Violation	Identifies the violation of the current state. (Inherited from HybridLocalSearchModel.)

Top

Methods

	Name	Description
	AddConstant	Adds a constant to the model. Constants are considered rows. (Inherited from HybridLocalSearchModel.)
	AddConstraint	Specifies that a numerical term is a constraint (Inherited from HybridLocalSearchModel.)
	AddFunction	(Inherited from HybridLocalSearchModel.)
	AddGoal	Specifies that a numerical term is a goal to minimize. Priorities are determined by the order in which the goals are added (first goals have higher priorities) (Inherited from HybridLocalSearchModel.)
	AddOperation(TermModelOperation, Int32%, Int32)	Adds an operation row to the model. (Inherited from HybridLocalSearchModel.)
	AddOperation(TermModelOperation, Int32%, Int32())	Adds an operation row to the model. (Inherited from HybridLocalSearchModel.)
	AddOperation(TermModelOperation, Int32%, Int32, Int32)	Adds an operation row to the model. (Inherited from HybridLocalSearchModel.)
	AddOperation(TermModelOperation, Int32%, Int32, Int32, Int32)	Adds an operation row to the model. (Inherited from HybridLocalSearchModel.)
	AddVariable(Int32%, IEnumerable<Rational>)	Adds a variable to the model, with a fixed set of possible values. (Inherited from HybridLocalSearchModel.)
	AddVariable(Object, Int32%, IEnumerable<Rational>)	Adds a variable to the model, with a fixed set of possible values. (Inherited from HybridLocalSearchModel.)
	AddVariable(Int32%, Rational, Rational, Boolean)	Adds a variable to the model, with bounds and integrality given at creation time. (Inherited from HybridLocalSearchModel.)
	AddVariable(Object, Int32%, Rational, Rational, Boolean)	Adds a variable to the model, with bounds and integrality given at creation time. (Inherited from HybridLocalSearchModel.)
	CreateBinaryFunction	(Inherited from HybridLocalSearchModel.)
	CreateNaryFunction	(Inherited from HybridLocalSearchModel.)
	CreateUnaryFunction	(Inherited from HybridLocalSearchModel.)
	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.)
	GetOperand	Gets an operand associated with a vid. (Inherited from HybridLocalSearchModel.)
	GetOperandCount	Gets the number of operands associated with a vid. (Inherited from HybridLocalSearchModel.)
	GetOperands	Gets the operands associated with a vid. (Inherited from HybridLocalSearchModel.)
	GetOperation	Gets the operation associated with a vid. (Inherited from HybridLocalSearchModel.)
	GetReport	Generates a report
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsConstant	Tests if a vid is a constant (not a variable or operation). (Inherited from HybridLocalSearchModel.)
	IsOperation	Tests if a vid is an operation (not a variable or constant). (Inherited from HybridLocalSearchModel.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	RemoveConstraint	Removes a Boolean term from the set of constraints (Inherited from HybridLocalSearchModel.)
	RequestTermination	Requests the end of the search algorithm (Inherited from HybridLocalSearchModel.)
	Solve	Solves the model using the given parameter instance.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Fields

	Name	Description
	goalList	Represents the goals, or objectives to minimize or maximize (Inherited from HybridLocalSearchModel.)

Top

Explicit Interface Implementations

	Name	Description
	IGoalModel.AddGoal	Adds a goal to the collection. (Inherited from HybridLocalSearchModel.)
	IGoalModel.ClearGoals	Clears all the goals from a model. (Inherited from HybridLocalSearchModel.)
	IGoalModel.GetGoalFromIndex	Returns a goal entry if the row index is associated with a goal row. (Inherited from HybridLocalSearchModel.)
	IGoalModel.GoalCount	Gets a count of the number of goals for the search model. (Inherited from HybridLocalSearchModel.)
	IGoalModel.Goals	Gets the goals for the search model. (Inherited from HybridLocalSearchModel.)
	IGoalModel.IsGoal(Int32)	Returns a value that specifies whether a row index is a goal row. (Inherited from HybridLocalSearchModel.)
	IGoalModel.IsGoal(Int32, IGoal%)	Returns a value that specifies whether a row index is a goal row, and returns the associated goal. (Inherited from HybridLocalSearchModel.)
	IGoalModel.RemoveGoal	Removes the specified goal. (Inherited from HybridLocalSearchModel.)
	INonlinearSolution.GetSolutionValue	Returns the objective value of a goal.
	INonlinearSolution.GetSolvedGoal	Returns information about a solved goal.
	INonlinearSolution.GetValue	Returns the value of the specified variable.
	INonlinearSolution.SolvedGoalCount	Gets the number of goals that are being solved.
	IRowVariableModel.AddRow	Adds a row to a model. (Inherited from HybridLocalSearchModel.)
	IRowVariableModel.AddVariable	Adds a user variable to a model. (Inherited from HybridLocalSearchModel.)
	IRowVariableModel.GetBounds	Returns the bounds for a variable. (Inherited from HybridLocalSearchModel.)
	IRowVariableModel.GetIgnoreBounds	Returns a value that indicates whether the bounds of a variable are ignored. (Inherited from HybridLocalSearchModel.)
	IRowVariableModel.GetIndexFromKey	(Inherited from HybridLocalSearchModel.)
	IRowVariableModel.GetIntegrality	Gets the integrality of the goal identified by the specified index. (Inherited from HybridLocalSearchModel.)
	IRowVariableModel.GetKeyFromIndex	(Inherited from HybridLocalSearchModel.)
	IRowVariableModel.GetValue	Returns the value that is associated with a variable index. (Inherited from HybridLocalSearchModel.)
	IRowVariableModel.Indices	Gets the indices for the search model. (Inherited from HybridLocalSearchModel.)
	IRowVariableModel.IntegerIndexCount	Gets the index count as an integer for the search model. (Inherited from HybridLocalSearchModel.)
	IRowVariableModel.IsRow	Returns a value that indicates whether a variable index is a row. (Inherited from HybridLocalSearchModel.)
	IRowVariableModel.KeyComparer	Gets the value of the key comparer for the search model. (Inherited from HybridLocalSearchModel.)
	IRowVariableModel.KeyCount	Gets the count of the number of keys for the search model. (Inherited from HybridLocalSearchModel.)
	IRowVariableModel.Keys	Gets the keys for the search model. (Inherited from HybridLocalSearchModel.)
	IRowVariableModel.RowCount	Gets the row count for the search model. (Inherited from HybridLocalSearchModel.)
	IRowVariableModel.RowIndices	Gets the row indices for the search model. (Inherited from HybridLocalSearchModel.)
	IRowVariableModel.RowKeys	Gets the row keys for the search model. (Inherited from HybridLocalSearchModel.)
	IRowVariableModel.SetBounds	Sets the bounds for a variable. (Inherited from HybridLocalSearchModel.)
	IRowVariableModel.SetIgnoreBounds	Specifies whether the bounds of a variable index should be respected or ignored during a solve process. (Inherited from HybridLocalSearchModel.)
	IRowVariableModel.SetIntegrality	Specifies that a variable is an integer variable. (Inherited from HybridLocalSearchModel.)
	IRowVariableModel.SetLowerBound	Sets the lower bound of a variable. (Inherited from HybridLocalSearchModel.)
	IRowVariableModel.SetUpperBound	Sets the upper bound of a variable. (Inherited from HybridLocalSearchModel.)
	IRowVariableModel.SetValue	Sets the value for the specified variable index. (Inherited from HybridLocalSearchModel.)
	IRowVariableModel.TryGetIndexFromKey	Attempts to return the variable index associated with a key. (Inherited from HybridLocalSearchModel.)
	IRowVariableModel.VariableCount	Gets the variable count for the search model. (Inherited from HybridLocalSearchModel.)
	IRowVariableModel.VariableIndices	Gets the variable indices for the search model. (Inherited from HybridLocalSearchModel.)
	IRowVariableModel.VariableKeys	Gets the variable keys for the search model. (Inherited from HybridLocalSearchModel.)
	ISolver.Shutdown	Shuts down a solver instance.
	ISolverProperties.GetProperty	Returns the value of a property.
	ISolverProperties.SetProperty	Sets the value of a property.
	ITermSolver.SupportedOperations	Gets the operations that are supported by the solver.

Top

Remarks

The solver can be used for discrete and continuous, linear and non-linear, satisfaction and/or optimization models. This solver is incomplete: it does not guarantee global optimality.

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.