XPRSprob.MultiMapFunction
- java.lang.Object
-
- com.dashoptimization.XPRSprob.AbstractUserFunction
-
- com.dashoptimization.XPRSprob.MultiMapFunction
-
- Enclosing class:
- XPRSprob
public final class XPRSprob.MultiMapFunction extends XPRSprob.AbstractUserFunction
AnR^n -> R^m
function.
-
-
Field Summary
Modifier and Type Field Description XPRSprob.MultiMapFunctor
functor
The actual function represented by this instance.int
nIn
Number of input arguments.int
nOut
Number of output arguments.
-
Constructor Summary
Constructor Description MultiMapFunction(XPRSprob prob, java.lang.String name, XPRSprob.MultiMapFunctor functor, int nIn, int nOut)
-
Method Summary
Modifier and Type Method Description double[]
call(double[] values)
Expression
call(int output, Expression... arguments)
Create an expression that represents a symbolic call to this function.double
evaluate(int output, double[] args)
Evaluate this function for the given values.boolean
isMultiOutput()
Check whether this is a function that produces more than one value for a single call.void
storeCBException(java.lang.Throwable ex)
-
Methods inherited from class com.dashoptimization.XPRSprob.AbstractUserFunction
call, evaluate, getId, getName
-
-
-
-
Field Detail
-
functor
public final XPRSprob.MultiMapFunctor functor
The actual function represented by this instance.
-
nIn
public final int nIn
Number of input arguments.
-
nOut
public final int nOut
Number of output arguments.
-
-
Constructor Detail
-
MultiMapFunction
public MultiMapFunction(XPRSprob prob, java.lang.String name, XPRSprob.MultiMapFunctor functor, int nIn, int nOut)
-
-
Method Detail
-
isMultiOutput
public boolean isMultiOutput()
Check whether this is a function that produces more than one value for a single call.- Specified by:
-
isMultiOutput
in classXPRSprob.AbstractUserFunction
- Returns:
-
true
if the function has more than one output,false
otherwise. - Since:
- 43.00
-
call
public double[] call(double[] values)
-
evaluate
public double evaluate(int output, double[] args)
Evaluate this function for the given values.- Specified by:
-
evaluate
in classXPRSprob.AbstractUserFunction
- Parameters:
-
output
- Output selector. In case the function returns multiple outputs then this selects which of them to return. Otherwise this argument is ignored. Note that the first output has index 1! -
args
- Arguments for the function call. - Returns:
- The result.
- Since:
- 43.00
-
call
public Expression call(int output, Expression... arguments)
Create an expression that represents a symbolic call to this function.- Specified by:
-
call
in classXPRSprob.AbstractUserFunction
- Parameters:
-
output
- If this is a multi-output function then this specifies which output to select. Note that the first output has index 1! -
arguments
- Arguments for the function call. - Returns:
- The expression representing a call to this function.
- Since:
- 43.00
-
storeCBException
public void storeCBException(java.lang.Throwable ex)
-
-
© 2001-2025 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.