NonlinearConstraint Class

Constraint with only linear terms.

Inheritance Hierarchy

SystemObject
Accord.Math.OptimizationNonlinearConstraint
Accord.Math.OptimizationQuadraticConstraint

Namespace: Accord.Math.Optimization
Assembly: Accord.Math (in Accord.Math.dll) Version: 3.8.0

Syntax

public class NonlinearConstraint : IConstraint, 
	IFormattable

Public Class NonlinearConstraint
	Implements IConstraint, IFormattable

The NonlinearConstraint type exposes the following members.

Constructors

	Name	Description
	NonlinearConstraint	Creates an empty nonlinear constraint.
	NonlinearConstraint(Int32, ExpressionFuncDouble, Boolean, FuncDouble, Double)	Constructs a new nonlinear constraint.
	NonlinearConstraint(IObjectiveFunction, ExpressionFuncDouble, Boolean, FuncDouble, Double)	Constructs a new nonlinear constraint.
	NonlinearConstraint(Int32, FuncDouble, Double, ConstraintType, Double, FuncDouble, Double, Double)	Constructs a new nonlinear constraint.
	NonlinearConstraint(IObjectiveFunction, FuncDouble, Double, ConstraintType, Double, FuncDouble, Double, Double)	Constructs a new nonlinear constraint.
	NonlinearConstraint(IObjectiveFunction, ExpressionFuncDouble, ConstraintType, Double, ExpressionFuncDouble, Double)	Constructs a new nonlinear constraint.

Properties

	Name	Description
	NumberOfVariables	Gets the number of variables in the constraint.
	ShouldBe	Gets the type of the constraint.
	Tolerance	Gets the violation tolerance for the constraint. Equality constraints should set this to a small positive value. Default is 1e-8.
	Value	Gets the value in the right hand side of the constraint equation. Default is 0.

Methods

	Name	Description
	Create	Creates a nonlinear constraint.
	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.)
	Function	Calculates the left hand side of the constraint equation given a vector x.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Gradient	Calculates the gradient of the constraint equation given a vector x
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a String that represents this instance. (Overrides ObjectToString.)
	ToString(String, IFormatProvider)	Returns a String that represents this instance.

Extension Methods

	Name	Description
	GetViolation	Gets how much the constraint is being violated. (Defined by ConstraintExtensions.)
	HasMethod	Checks whether an object implements a method with the given name. (Defined by ExtensionMethods.)
	IsEqual	Compares two objects for equality, performing an elementwise comparison if the elements are vectors or matrices. (Defined by Matrix.)
	IsViolated	Gets whether this constraint is being violated (within the current tolerance threshold). (Defined by ConstraintExtensions.)
	To(Type)	Overloaded. Converts an object into another type, irrespective of whether the conversion can be done at compile time or not. This can be used to convert generic types to numeric types during runtime. (Defined by ExtensionMethods.)
	ToT	Overloaded. Converts an object into another type, irrespective of whether the conversion can be done at compile time or not. This can be used to convert generic types to numeric types during runtime. (Defined by ExtensionMethods.)