Initializing help system before first use

XPRSprob.AbstractUserFunction Class

Base class for user functions. You will usually not have to create an instance of this class or its subclasses yourself. Instead the way to create an instance is to use an XPRSprob instance as factory: 
MapFunction f = prob.NlpAddUserFunction("myf", 0, d -> 2 * d);
That is, you create an instance of MapFunctor, VecMapFunctor, MultiMapFunctor, MapDeltaFunctor, VecMapDeltaFunctor, or MultiMapDeltaFunctor and then pass that to the appropriate overload of nlpAddUserFunction. This will register the function with the Xpress problem object and return a user function instance that can then be used in the code to build formulas.
Inheritance Hierarchy
SystemObject
   OptimizerXPRSprobAbstractUserFunction
     More...

Namespace:   Optimizer
Assembly:  xprsdn (in xprsdn.dll) Version: 43.01.03
Syntax
C# 
public abstract class AbstractUserFunction

The XPRSprobAbstractUserFunction type exposes the following members.

Constructors
  Name Description
Protected method XPRSprobAbstractUserFunction
Initializes a new instance of the XPRSprobAbstractUserFunction class
Top
Methods
  Name Description
Public method Call(Expression)
Create an expression that represents a symbolic call to this function. Shorthand for Call(1, arguments).
Public method Call(Int32, Expression)
Create an expression that represents a symbolic call to this function.
Public method Equals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public method Evaluate(Double)
Shorthand for Evaluate(1, args).
Public method Evaluate(Int32, Double)
Evaluate this function for the given values.
Protected method Finalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public method GetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public method GetId
Get the id for this function. The id is used to identify this function in formulas that are specified as token/value arrays. @return This function's id.
Public method GetName
Get the name with which the function was registered. @return This function's name.
Public method GetType
Gets the Type of the current instance.
(Inherited from Object.)
Public method IsMultiOutput
Check whether this is a function that produces more than one value for a single call.
Protected method MemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public method ToString
Returns a String that represents the current Object.
(Inherited from Object.)
Top
See Also
Inheritance Hierarchy
Covered Topics
Parent Topic Optimizer

© 2001-2024 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.