Extreme Optimization™: Complexity made simple.

Math and Statistics
Libraries for .NET

  • Home
  • Features
    • Math Library
    • Vector and Matrix Library
    • Statistics Library
    • Performance
    • Usability
  • Documentation
    • Introduction
    • Math Library User's Guide
    • Vector and Matrix Library User's Guide
    • Data Analysis Library User's Guide
    • Statistics Library User's Guide
    • Reference
  • Resources
    • Downloads
    • QuickStart Samples
    • Sample Applications
    • Frequently Asked Questions
    • Technical Support
  • Blog
  • Order
  • Company
    • About us
    • Testimonials
    • Customers
    • Press Releases
    • Careers
    • Partners
    • Contact us
Introduction
Deployment Guide
Nuget packages
Configuration
Using Parallelism
Expand Mathematics Library User's GuideMathematics Library User's Guide
Expand Vector and Matrix Library User's GuideVector and Matrix Library User's Guide
Expand Data Analysis Library User's GuideData Analysis Library User's Guide
Expand Statistics Library User's GuideStatistics Library User's Guide
Expand Data Access Library User's GuideData Access Library User's Guide
Expand ReferenceReference
  • Extreme Optimization
    • Features
    • Solutions
    • Documentation
    • QuickStart Samples
    • Sample Applications
    • Downloads
    • Technical Support
    • Download trial
    • How to buy
    • Blog
    • Company
    • Resources
  • Documentation
    • Introduction
    • Deployment Guide
    • Nuget packages
    • Configuration
    • Using Parallelism
    • Mathematics Library User's Guide
    • Vector and Matrix Library User's Guide
    • Data Analysis Library User's Guide
    • Statistics Library User's Guide
    • Data Access Library User's Guide
    • Reference
  • Reference
    • Extreme
    • Extreme.Collections
    • Extreme.Data
    • Extreme.Data.Json
    • Extreme.Data.Matlab
    • Extreme.Data.R
    • Extreme.Data.Stata
    • Extreme.Data.Text
    • Extreme.DataAnalysis
    • Extreme.DataAnalysis.Linq
    • Extreme.DataAnalysis.Models
    • Extreme.Mathematics
    • Extreme.Mathematics.Algorithms
    • Extreme.Mathematics.Calculus
    • Extreme.Mathematics.Calculus.OrdinaryDifferentialEquations
    • Extreme.Mathematics.Curves
    • Extreme.Mathematics.Curves.Nonlinear
    • Extreme.Mathematics.Distributed
    • Extreme.Mathematics.EquationSolvers
    • Extreme.Mathematics.Generic
    • Extreme.Mathematics.LinearAlgebra
    • Extreme.Mathematics.LinearAlgebra.Implementation
    • Extreme.Mathematics.LinearAlgebra.IterativeSolvers
    • Extreme.Mathematics.LinearAlgebra.IterativeSolvers.Preconditioners
    • Extreme.Mathematics.Optimization
    • Extreme.Mathematics.Optimization.LineSearches
    • Extreme.Mathematics.Random
    • Extreme.Mathematics.SignalProcessing
    • Extreme.Providers
    • Extreme.Providers.InteropServices
    • Extreme.Statistics
    • Extreme.Statistics.Distributions
    • Extreme.Statistics.Multivariate
    • Extreme.Statistics.Tests
    • Extreme.Statistics.TimeSeriesAnalysis
  • Extreme.Mathematics.Optimization
    • BoundedQuasiNewtonOptimizer Class
    • BrentDerivativeOptimizer Class
    • BrentOptimizer Class
    • ConjugateGradientMethod Enumeration
    • ConjugateGradientOptimizer Class
    • Constraint Class
    • ConstraintCollection Class
    • ConstraintType Enumeration
    • DecisionVariable Class
    • DecisionVariableCollection Class
    • DirectionalOptimizer Class
    • ExtremumType Enumeration
    • GoldenSectionOptimizer Class
    • LeastSquaresOptimizer Class
    • LevenbergMarquardtOptimizer Class
    • LimitedMemoryBfgsOptimizer Class
    • LinearConstraint Class
    • LinearProgram Class
    • LinearProgramConstraint Class
    • LinearProgramSolver Class
    • LinearProgramVariable Class
    • MpsReader Class
    • MultidimensionalOptimizer Class
    • NelderMeadOptimizer Class
    • NonlinearConstraint Class
    • NonlinearProgram Class
    • OneDimensionalOptimizer Class
    • OptimizationModel Class
    • OptimizationModelEntity Class
    • OptimizationModelSolver(T) Class
    • OptimizationModelStatus Enumeration
    • OptimizationSolutionReport Class
    • PowellOptimizer Class
    • QuadraticProgram Class
    • QuasiNewtonMethod Enumeration
    • QuasiNewtonOptimizer Class
    • TrustRegionReflectiveOptimizer Class
  • NonlinearConstraint Class
    • Properties
    • Methods

NonlinearConstraint Class

Extreme Optimization Numerical Libraries for .NET Professional
Represents a row in a LinearProgram.
Inheritance Hierarchy

SystemObject
  Extreme.Mathematics.OptimizationOptimizationModelEntity
    Extreme.Mathematics.OptimizationConstraint
      Extreme.Mathematics.OptimizationNonlinearConstraint

Namespace:  Extreme.Mathematics.Optimization
Assembly:  Extreme.Numerics (in Extreme.Numerics.dll) Version: 8.1.1
Syntax

C#
VB
C++
F#
Copy
public class NonlinearConstraint : Constraint
Public Class NonlinearConstraint
	Inherits Constraint
public ref class NonlinearConstraint : public Constraint
type NonlinearConstraint =  
    class
        inherit Constraint
    end

The NonlinearConstraint type exposes the following members.

Properties

  NameDescription
Public propertyConstraintFunction
Gets or sets the constraint function.
Public propertyConstraintFunctionAndGradient
Gets or sets a delegate that evaluates the constraint value and its gradient.
Public propertyConstraintType
Gets the type of row.
(Inherited from Constraint.)
Public propertyFastConstraintGradient
Gets or sets the gradient of the constraint function.
Public propertyGradient
Gets the current value of the constraint gradient.
(Inherited from Constraint.)
Public propertyIsLinear
Gets whether the constraint is linear.
(Overrides ConstraintIsLinear.)
Public propertyLowerBound
Gets or sets the lower bound of the variable.
(Inherited from OptimizationModelEntity.)
Public propertyName
Gets the name of the variable.
(Inherited from OptimizationModelEntity.)
Public propertyPosition
Gets the position of the current instance in the collection.
(Inherited from OptimizationModelEntity.)
Public propertyUpperBound
Gets or sets the upper bound of the variable.
(Inherited from OptimizationModelEntity.)
Public propertyValue
Gets the current value of the constraint.
(Inherited from Constraint.)
Top
Methods

  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodEvaluate
Evaluates the constraint at the specified point.
(Overrides ConstraintEvaluate(VectorDouble).)
Public methodEvaluateConstraintAndGradient
Evaluates both the constrain value and its gradient in one operation.
(Overrides ConstraintEvaluateConstraintAndGradient(VectorDouble).)
Public methodEvaluateGradient
Evaluates the gradient of the constraint at the specified point.
(Overrides ConstraintEvaluateGradient(VectorDouble).)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Remarks

A NonlinearConstraint object represents a constraint in a NonlinearProgram. NonlinearConstraint objects are created using the [o:NonlinearProgram.AddNonlinearConstraint] method of the NonlinearProgram class.

Each constraint has a Name, which may be generated automatically. The LowerBound and UpperBound properties specify the left and right hand sides of the constraint. The ConstraintFunction property specifies the function whose value must lie between those bounds.

The FastConstraintGradient property specifies the gradient of the constraint function. If this value is , a numerical approximation is used.

See Also

Reference

Extreme.Mathematics.Optimization Namespace

Copyright (c) 2004-2021 ExoAnalytics Inc.

Send comments on this topic to support@extremeoptimization.com

Copyright © 2004-2021, Extreme Optimization. All rights reserved.
Extreme Optimization, Complexity made simple, M#, and M Sharp are trademarks of ExoAnalytics Inc.
Microsoft, Visual C#, Visual Basic, Visual Studio, Visual Studio.NET, and the Optimized for Visual Studio logo
are registered trademarks of Microsoft Corporation.