Initializing help system before first use

# MapFunction

An `R -> R` function. More...

Inheritance diagram for xpress::XPRSProblem::MapFunction:

## Public Member Functions
| MapFunction (XPRSProblem *prob, std::string name, MapFunctor functor)
auto | call (double value) -> double
virtual auto | call (int, std::vector< xpress::objects::Expression > arguments) -> xpress::objects::Expression override
  | Create an expression that represents a symbolic call to this function. 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 44.00
virtual auto | evaluate (int, xpress::SizedArray< double const > const &args) -> double override
  | Evaluate this function for the given values.Examples using `evaluate`: CapitalBudgeting.cpp PolygonObjects.cpp 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 44.00 Examples using `evaluate`:
virtual auto | isMultiOutput () -> bool override
| Check whether this is a function that produces more than one value for a single call. Returns `true` if the function has more than one output, `false` otherwise. Since 44.00
Public Member Functions inherited from xpress::XPRSProblem::AbstractUserFunction
auto | call (std::vector< xpress::objects::Expression > arguments) -> xpress::objects::Expression
| Create an expression that represents a symbolic call to this function.
auto | evaluate (xpress::SizedArray< double const > const &args) -> double
| Shorthand for `evaluate(1, args)`.
auto | getId () -> int
| Get the id for this function.
auto | getName () const -> std::string
| Get the name with which the function was registered.
auto | triggerEvalError (std::exception_ptr e) -> void
| Trigger a user function evaluation error with a specific exception.

## Public Attributes
MapFunctor const | functor
| The actual function represented by this instance.

## Detailed Description

An `R -> R` function.

Since
  44.00

## Constructor & Destructor Documentation

## MapFunction()

xpress::XPRSProblem::MapFunction::MapFunction | ( | XPRSProblem * | prob,
|  | std::string | name,
|  | MapFunctor | functor )
| inline

Since
  44.00

## Member Function Documentation

## call() [1/2]

auto xpress::XPRSProblem::MapFunction::call | ( | double | value | ) | -> double
| inline

Since
  44.00

## call() [2/2]

virtual auto xpress::XPRSProblem::MapFunction::call | ( | int | ,
|  | std::vector< xpress::objects::Expression > | arguments ) -> xpress::objects::Expression
| inline override virtual

Create an expression that represents a symbolic call to this function.

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
  44.00

Since
  44.00

Implements xpress::XPRSProblem::AbstractUserFunction.

## evaluate()

virtual auto xpress::XPRSProblem::MapFunction::evaluate | ( | int | ,
|  | xpress::SizedArray< double const > const & | args ) -> double
| inline override virtual

Evaluate this function for the given values.Examples using `evaluate`:

- CapitalBudgeting.cpp
- PolygonObjects.cpp

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
  44.00

Examples using `evaluate`:

- CapitalBudgeting.cpp
- PolygonObjects.cpp

Since
  44.00

Implements xpress::XPRSProblem::AbstractUserFunction.

## isMultiOutput()

virtual auto xpress::XPRSProblem::MapFunction::isMultiOutput | ( |  | ) | -> bool
| inline override virtual

Check whether this is a function that produces more than one value for a single call.

Returns
  `true` if the function has more than one output, `false` otherwise.

Since
  44.00

Since
  44.00

Implements xpress::XPRSProblem::AbstractUserFunction.

## Member Data Documentation

## functor

MapFunctor const xpress::XPRSProblem::MapFunction::functor

The actual function represented by this instance.

Since
  44.00

The documentation for this class was generated from the following file:

- xpress.hpp

Parent Topic XPRSProblem

© 2001-2026 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.