Options¶

Whether lowered programs and executables are stored in the cache directory.

The directory is CYXLA_CACHE_DIR if set, and ~/.cache/cyxla otherwise.

Whether executions read and write host memory directly when the plugin allows it.

The Hessian of the Lagrangian is compiled and evaluated at every iteration.

Ipopt approximates the Hessian from gradients, so no Hessian is compiled.

asdex when it is installed, and dense derivatives with a warning when it is not.

asdex detects the patterns, colors them and evaluates the compressed derivatives.

A pattern that a problem gives replaces the detected one.

JAX differentiates densely and the programs keep the entries of the pattern.

A problem without patterns gets all entries, and asdex is not needed.

Ipopt's tol, the tolerance on the scaled optimality error.

Seconds of wall time after which Ipopt stops, or None for no limit.

Ipopt's print_level from 0, which prints nothing, to 12.

Threads of OpenBLAS, or None to leave the setting as it is.

One thread suits the sparse factorizations of problems that fit in a few million entries, since the linear algebra calls are small.

Further option values, applied after the fields above.

A function called at the end of every iteration, or None.

Ipopt stops with Status.USER_REQUESTED_STOP when it returns False. Returning nothing continues. The function runs with the GIL, so it slows a solve down.

The name of the option, as in Ipopt's documentation.