XPRSprob.AbstractUserFunction
- java.lang.Object
-
- com.dashoptimization.XPRSprob.AbstractUserFunction
-
- Direct Known Subclasses:
- XPRSprob.MapDeltaFunction, XPRSprob.MapFunction, XPRSprob.MultiMapDeltaFunction, XPRSprob.MultiMapFunction, XPRSprob.VecMapDeltaFunction, XPRSprob.VecMapFunction
- Enclosing class:
- XPRSprob
public abstract class XPRSprob.AbstractUserFunction extends java.lang.ObjectBase 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 anXPRSprobinstance as factory:MapFunction f = prob.nlpAddUserFunction("myf", 0, d -> 2 * d);That is, you create an instance ofXPRSprob.MapFunctor,XPRSprob.VecMapFunctor,XPRSprob.MultiMapFunctor,XPRSprob.MapDeltaFunctor,XPRSprob.VecMapDeltaFunctor, orXPRSprob.MultiMapDeltaFunctorand then pass that to the appropriate overload ofnlpAddUserFunction. 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.
-
-
Method Summary
Modifier and Type Method and Description intgetId()Get the id for this function.java.lang.StringgetName()Get the name with which the function was registered.voidstoreCBException(java.lang.Throwable ex)
-
-
-
Method Detail
-
getId
public int getId()
Get the id for this function. The id is used to identify this function in formulas that are specified as token/value arrays.- Returns:
- This function's id.
-
getName
public java.lang.String getName()
Get the name with which the function was registered.- Returns:
- This function's name.
-
storeCBException
public void storeCBException(java.lang.Throwable ex)
-
-
© 2001-2023 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.