Ipopt.Options

Documentation

ipopts :: QuasiQuoter

an expression-only quasiquote intended to be the second argument for solveNLP' (so solveNLP [ipopts| tol = 1e-3 |]). This is a shortcut for calling addIpoptNumOption addIpoptStrOption or addIpoptIntOption.

Refer to ipopt's options reference, the syntax is like option_name = value;option2 = value2. The semicolons are optional and whitespace alone can separate the option name from the value. A few examples of the parser:

>>> :set -XQuasiQuotes
>>> let f = [ipopts| tol = 1e-3; print_level = 0 |]
>>> :t f
f :: IpProblem -> IO ()

>>> let p x = uuParseTest parseOpts x
>>> p "tol = 3"
([("tol",ANum 3.0)],[])

>>> p "tol = 3 tol = 4" -- the last one wins. No warnings done (yet).
([("tol",ANum 3.0),("tol",ANum 4.0)],[])

>>> p "tol = 3\n\ntol = 4"
([("tol",ANum 3.0),("tol",ANum 4.0)],[])

>>> p "acceptable_iter = 25; output_file = foobar" -- quotation marks optional
([("acceptable_iter",AInt 25),("output_file",AStr "foobar")],[])

>>> p "output_file = \"foo bar\"" -- but needed here
([("output_file",AStr "foo bar")],[])

>>> putStrLn $ (++"...") $ take 100 $ show $ p "atol = 1.8" -- typo gets corrected
([("tol",ANum 1.8)],[--    Deleted   'a' at position LineColPos 0 0 0 expecting one of [Whitespace, ...

>>> p "tol = $xY" -- interpolating haskell variables
([("tol",AVar OptionNum "xY")],[])

uuParseTest :: (Show a1, ListLike s a1) => P (Str a1 s LineColPos) a -> s -> (a, [Error LineColPos])

addIpoptOpt :: Name -> String -> OptionVal -> ExpQ

liftDouble :: Double -> ExpQ

what lift should do for Double

parseOpts :: P (Str Char String LineColPos) [(String, OptionVal)]

parseOpt :: P (Str Char String LineColPos) (String, OptionVal)

data OptionVal

Constructors

ANum Double

AStr String

AInt Int

AVar OptionType String

$x

Instances

Show OptionVal

data OptionType

Constructors

OptionNum

OptionStr

OptionInt

OptionBool

actually string yes or string no

Instances

Eq OptionType

Show OptionType

ipoptOptions :: Map String OptionType

a list of all the options in http://www.coin-or.org/Ipopt/documentation/node39.html