NonlinearModel Class

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

Represents a nonlinear optimization model that contains rows, variables. goals, and callback functions that define the values and possible gradients of the rows.

Inheritance Hierarchy

System.Object
  Microsoft.SolverFoundation.Services.RowVariableModel
    Microsoft.SolverFoundation.Services.RowVariableGoalModel
      Microsoft.SolverFoundation.Services.NonlinearModel

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

Syntax

'Declaration
Public Class NonlinearModel _
    Inherits RowVariableGoalModel _
    Implements INonlinearModel, IRowVariableModel, IGoalModel

public class NonlinearModel : RowVariableGoalModel, 
    INonlinearModel, IRowVariableModel, IGoalModel

public ref class NonlinearModel : public RowVariableGoalModel, 
    INonlinearModel, IRowVariableModel, IGoalModel

type NonlinearModel =  
    class
        inherit RowVariableGoalModel
        interface INonlinearModel
        interface IRowVariableModel
        interface IGoalModel
    end

public class NonlinearModel extends RowVariableGoalModel implements INonlinearModel, IRowVariableModel, IGoalModel

The NonlinearModel type exposes the following members.

Constructors

	Name	Description
	NonlinearModel()	Initializes a new instance of the NonlinearModel class.
	NonlinearModel(IEqualityComparer<Object>)	Initializes a new instance of the NonlinearModel class using the specified comparer.

Top

Properties

	Name	Description
	FunctionEvaluator	Gets or sets the value callback function that the solver invokes periodically in order to obtain function values for different variable values.
	GoalCount	Gets the number of goals in a linear model. (Inherited from RowVariableGoalModel.)
	Goals	Gets the collection of goals in a linear model. (Inherited from RowVariableGoalModel.)
	GradientEvaluator	Gets or sets the gradient callback function that the solver invokes periodically in order to obtain gradient information for different variable values.
	Indices	Gets the collection of row and variable indexes for a model. (Inherited from RowVariableModel.)
	IntegerIndexCount	Gets the number of integer variables in a model. (Inherited from RowVariableModel.)
	IsMipModel	Gets a value that indicates whether a model is a mixed integer programming (MIP) model. (Inherited from RowVariableModel.)
	JacobianSparsityPattern	Gets the sparsity pattern for a Jacobian computation.
	KeyComparer	Gets the object that is used to compare keys for rows or variables. (Inherited from RowVariableModel.)
	KeyCount	Gets the number of keys that are in a model. (Inherited from RowVariableModel.)
	Keys	Gets the variable key and row key collection. (Inherited from RowVariableModel.)
	RowCount	Gets the number of rows in a model. (Inherited from RowVariableModel.)
	RowIndices	Gets the collection of row indexes in a model. (Inherited from RowVariableModel.)
	RowKeys	Gets the collection of row keys. (Inherited from RowVariableModel.)
	VariableCount	Gets the number of variables in a model. (Inherited from RowVariableModel.)
	VariableIndices	Gets the collection of variable indexes. (Inherited from RowVariableModel.)
	VariableKeys	Gets the collection of variable keys. (Inherited from RowVariableModel.)

Top

Methods

	Name	Description
	AddGoal	Marks a row as a goal row. (Inherited from RowVariableGoalModel.)
	AddRow	Adds a row to a model. (Inherited from RowVariableModel.)
	AddVariable	Adds a user variable to a model. (Inherited from RowVariableModel.)
	ClearGoals	Clears all the goals in a model. (Inherited from RowVariableGoalModel.)
	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.)
	GetActiveVariables	Returns the active variables in a row.
	GetBounds	Returns the bounds for a variable. (Inherited from RowVariableModel.)
	GetGoalFromIndex	Returns a goal entry that is associated with a row index. (Inherited from RowVariableGoalModel.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetIgnoreBounds	Returns a value that indicates whether the bounds of a variable are ignored. (Inherited from RowVariableModel.)
	GetIndexFromKey	Returns the index that is associated with a specified key. (Inherited from RowVariableModel.)
	GetIntegrality	Returns a value that indicates whether a variable is an integer variable. (Inherited from RowVariableModel.)
	GetKeyFromIndex	Returns the key that is associated with the specified variable index. (Inherited from RowVariableModel.)
	GetProperty	Returns the value of a property that is at the specified index. (Inherited from RowVariableModel.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetValue	Returns the value that is associated with the specified variable index. (Inherited from RowVariableModel.)
	IsActiveVariable	Returns a value that indicates whether a variable is active in the specified row.
	IsGoal(Int32)	Returns a value that indicates whether a row index corresponds to a goal row. (Inherited from RowVariableGoalModel.)
	IsGoal(Int32, IGoal%)	Returns a value that indicates whether a row index corresponds to a goal row, and returns the goal entry. (Inherited from RowVariableGoalModel.)
	IsRow	Returns a value that indicates whether a variable index corresponds to a row. (Inherited from RowVariableModel.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	RemoveGoal	Removes a goal row. (Inherited from RowVariableGoalModel.)
	SetActiveVariable	Sets a variable in the specified row to either active or inactive.
	SetActiveVariables(Boolean)	Sets all variables in the model to either active or inactive.
	SetActiveVariables(Int32, Boolean)	Sets all variables in the specified row to either active or inactive.
	SetBounds	Sets the bounds for a row. (Inherited from RowVariableModel.)
	SetIgnoreBounds	Specifies whether the bounds of a variable should be respected or ignored during a solve attempt. (Inherited from RowVariableModel.)
	SetIntegrality	Specifies whether a variable is an integer variable. (Inherited from RowVariableModel.)
	SetLowerBound	Sets the lower bound of a variable. (Inherited from RowVariableModel.)
	SetProperty	Sets a property that is at the specified variable index. (Inherited from RowVariableModel.)
	SetUpperBound	Sets the upper bound of a variable. (Inherited from RowVariableModel.)
	SetValue	Sets the value for the specified variable index. (Inherited from RowVariableModel.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	TryGetIndexFromKey	Attempts to return the variable index that is associated with the specified key. (Inherited from RowVariableModel.)

Top

Fields

	Name	Description
	m_cvidInt	Represents the number of integer variables. (Inherited from RowVariableModel.)
	m_mpkeyvid	Represents the mapping from key to variable index. (Inherited from RowVariableModel.)

Top

Remarks

NonlinearModel is an implementation of INonlinearModel.

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