minizinc-process (empty) → 0.1.0.0

raw patch · 7 files changed

+539/−0 lines, 7 filesdep +aesondep +basedep +bytestringsetup-changed

Dependencies added: aeson, base, bytestring, containers, directory, hashable, process-extras, stringsearch, text

Files

CHANGELOG.md +5/−0
LICENSE +201/−0
README.md +77/−0
Setup.hs +2/−0
minizinc-process.cabal +53/−0
src/Process/Minizinc.hs +123/−0
src/Process/Minizinc/Inspect.hs +78/−0

+ CHANGELOG.md view

@@ -0,0 +1,5 @@+# Revision history for minizinc-process++## 0.1.0.0 -- YYYY-mm-dd++* Initial version.

+ LICENSE view

@@ -0,0 +1,201 @@+                                 Apache License+                           Version 2.0, January 2004+                        http://www.apache.org/licenses/++   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION++   1. Definitions.++      "License" shall mean the terms and conditions for use, reproduction,+      and distribution as defined by Sections 1 through 9 of this document.++      "Licensor" shall mean the copyright owner or entity authorized by+      the copyright owner that is granting the License.++      "Legal Entity" shall mean the union of the acting entity and all+      other entities that control, are controlled by, or are under common+      control with that entity. For the purposes of this definition,+      "control" means (i) the power, direct or indirect, to cause the+      direction or management of such entity, whether by contract or+      otherwise, or (ii) ownership of fifty percent (50%) or more of the+      outstanding shares, or (iii) beneficial ownership of such entity.++      "You" (or "Your") shall mean an individual or Legal Entity+      exercising permissions granted by this License.++      "Source" form shall mean the preferred form for making modifications,+      including but not limited to software source code, documentation+      source, and configuration files.++      "Object" form shall mean any form resulting from mechanical+      transformation or translation of a Source form, including but+      not limited to compiled object code, generated documentation,+      and conversions to other media types.++      "Work" shall mean the work of authorship, whether in Source or+      Object form, made available under the License, as indicated by a+      copyright notice that is included in or attached to the work+      (an example is provided in the Appendix below).++      "Derivative Works" shall mean any work, whether in Source or Object+      form, that is based on (or derived from) the Work and for which the+      editorial revisions, annotations, elaborations, or other modifications+      represent, as a whole, an original work of authorship. For the purposes+      of this License, Derivative Works shall not include works that remain+      separable from, or merely link (or bind by name) to the interfaces of,+      the Work and Derivative Works thereof.++      "Contribution" shall mean any work of authorship, including+      the original version of the Work and any modifications or additions+      to that Work or Derivative Works thereof, that is intentionally+      submitted to Licensor for inclusion in the Work by the copyright owner+      or by an individual or Legal Entity authorized to submit on behalf of+      the copyright owner. For the purposes of this definition, "submitted"+      means any form of electronic, verbal, or written communication sent+      to the Licensor or its representatives, including but not limited to+      communication on electronic mailing lists, source code control systems,+      and issue tracking systems that are managed by, or on behalf of, the+      Licensor for the purpose of discussing and improving the Work, but+      excluding communication that is conspicuously marked or otherwise+      designated in writing by the copyright owner as "Not a Contribution."++      "Contributor" shall mean Licensor and any individual or Legal Entity+      on behalf of whom a Contribution has been received by Licensor and+      subsequently incorporated within the Work.++   2. Grant of Copyright License. Subject to the terms and conditions of+      this License, each Contributor hereby grants to You a perpetual,+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable+      copyright license to reproduce, prepare Derivative Works of,+      publicly display, publicly perform, sublicense, and distribute the+      Work and such Derivative Works in Source or Object form.++   3. Grant of Patent License. Subject to the terms and conditions of+      this License, each Contributor hereby grants to You a perpetual,+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable+      (except as stated in this section) patent license to make, have made,+      use, offer to sell, sell, import, and otherwise transfer the Work,+      where such license applies only to those patent claims licensable+      by such Contributor that are necessarily infringed by their+      Contribution(s) alone or by combination of their Contribution(s)+      with the Work to which such Contribution(s) was submitted. If You+      institute patent litigation against any entity (including a+      cross-claim or counterclaim in a lawsuit) alleging that the Work+      or a Contribution incorporated within the Work constitutes direct+      or contributory patent infringement, then any patent licenses+      granted to You under this License for that Work shall terminate+      as of the date such litigation is filed.++   4. Redistribution. You may reproduce and distribute copies of the+      Work or Derivative Works thereof in any medium, with or without+      modifications, and in Source or Object form, provided that You+      meet the following conditions:++      (a) You must give any other recipients of the Work or+          Derivative Works a copy of this License; and++      (b) You must cause any modified files to carry prominent notices+          stating that You changed the files; and++      (c) You must retain, in the Source form of any Derivative Works+          that You distribute, all copyright, patent, trademark, and+          attribution notices from the Source form of the Work,+          excluding those notices that do not pertain to any part of+          the Derivative Works; and++      (d) If the Work includes a "NOTICE" text file as part of its+          distribution, then any Derivative Works that You distribute must+          include a readable copy of the attribution notices contained+          within such NOTICE file, excluding those notices that do not+          pertain to any part of the Derivative Works, in at least one+          of the following places: within a NOTICE text file distributed+          as part of the Derivative Works; within the Source form or+          documentation, if provided along with the Derivative Works; or,+          within a display generated by the Derivative Works, if and+          wherever such third-party notices normally appear. The contents+          of the NOTICE file are for informational purposes only and+          do not modify the License. You may add Your own attribution+          notices within Derivative Works that You distribute, alongside+          or as an addendum to the NOTICE text from the Work, provided+          that such additional attribution notices cannot be construed+          as modifying the License.++      You may add Your own copyright statement to Your modifications and+      may provide additional or different license terms and conditions+      for use, reproduction, or distribution of Your modifications, or+      for any such Derivative Works as a whole, provided Your use,+      reproduction, and distribution of the Work otherwise complies with+      the conditions stated in this License.++   5. Submission of Contributions. Unless You explicitly state otherwise,+      any Contribution intentionally submitted for inclusion in the Work+      by You to the Licensor shall be under the terms and conditions of+      this License, without any additional terms or conditions.+      Notwithstanding the above, nothing herein shall supersede or modify+      the terms of any separate license agreement you may have executed+      with Licensor regarding such Contributions.++   6. Trademarks. This License does not grant permission to use the trade+      names, trademarks, service marks, or product names of the Licensor,+      except as required for reasonable and customary use in describing the+      origin of the Work and reproducing the content of the NOTICE file.++   7. Disclaimer of Warranty. Unless required by applicable law or+      agreed to in writing, Licensor provides the Work (and each+      Contributor provides its Contributions) on an "AS IS" BASIS,+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or+      implied, including, without limitation, any warranties or conditions+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A+      PARTICULAR PURPOSE. You are solely responsible for determining the+      appropriateness of using or redistributing the Work and assume any+      risks associated with Your exercise of permissions under this License.++   8. Limitation of Liability. In no event and under no legal theory,+      whether in tort (including negligence), contract, or otherwise,+      unless required by applicable law (such as deliberate and grossly+      negligent acts) or agreed to in writing, shall any Contributor be+      liable to You for damages, including any direct, indirect, special,+      incidental, or consequential damages of any character arising as a+      result of this License or out of the use or inability to use the+      Work (including but not limited to damages for loss of goodwill,+      work stoppage, computer failure or malfunction, or any and all+      other commercial damages or losses), even if such Contributor+      has been advised of the possibility of such damages.++   9. Accepting Warranty or Additional Liability. While redistributing+      the Work or Derivative Works thereof, You may choose to offer,+      and charge a fee for, acceptance of support, warranty, indemnity,+      or other liability obligations and/or rights consistent with this+      License. However, in accepting such obligations, You may act only+      on Your own behalf and on Your sole responsibility, not on behalf+      of any other Contributor, and only if You agree to indemnify,+      defend, and hold each Contributor harmless for any liability+      incurred by, or claims asserted against, such Contributor by reason+      of your accepting any such warranty or additional liability.++   END OF TERMS AND CONDITIONS++   APPENDIX: How to apply the Apache License to your work.++      To apply the Apache License to your work, attach the following+      boilerplate notice, with the fields enclosed by brackets "{}"+      replaced with your own identifying information. (Don't include+      the brackets!)  The text should be enclosed in the appropriate+      comment syntax for the file format. We also recommend that a+      file or class name and description of purpose be included on the+      same "printed page" as the copyright notice for easier+      identification within third-party archives.++   Copyright 2020 Lucas DiCioccio.++   Licensed under the Apache License, Version 2.0 (the "License");+   you may not use this file except in compliance with the License.+   You may obtain a copy of the License at++       http://www.apache.org/licenses/LICENSE-2.0++   Unless required by applicable law or agreed to in writing, software+   distributed under the License is distributed on an "AS IS" BASIS,+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.+   See the License for the specific language governing permissions and+   limitations under the License.

+ README.md view

@@ -0,0 +1,77 @@+minizinc-process+================++MiniZinc is a language and a toolchain to solve discrete optimization problems.+This package offers wrappers around the `minizinc` executable to pass inputs and outputs.++Assume that a primitive MiniZinc model is available at the path `models/example001.mzn`.++```minizinc+0..100: x;+var int: y;+constraint x < y;+```++This model expects `x` as an Int and decides `y` as an Int if a solution is+found. Ideally we would like to use minizinc and this model like a function of+type `Int -> IO (Maybe Int)` function in Haskell.+This package provides building blocks to create such a mapping.++# Implementation++This package relies on JSON support for MiniZinc by using JSON as an+intermediary representation. On the Haskell side we picked the popular `aeson`+package for serializing values.++MiniZinc input binds names to variables, hence the `Int -> IO (Maybe Int)`+example above is insufficient: inputs and outputs need to translate to JSON+`Object` constructor of [Aeson's Value type](https://hackage.haskell.org/package/aeson-1.1.1.0/docs/Data-Aeson.html#t:Value).++# Example Use++The `runLastMinizincJSON` function requires some configuration object to+provide parameters like the solver backing MiniZinc, the timeout, where to+store MiniZinc data files. The `simpleMiniZinc` function provides a smart+constructor for building such an environment.++```haskell+{-# LANGUAGE DeriveGeneric #-}+{-# LANGUAGE TypeApplications #-}++module Main where++import Data.Aeson+import Data.Hashable+import GHC.Generics+import Process.Minizinc+import Process.Minizinc.Inspect++data Input = Input {x :: Int}+  deriving (Generic)++instance ToJSON Input -- required for `runLastMinizincJSON`++instance Hashable Input -- required for `runLastMinizincJSON`++data Output = Output {y :: Int}+  deriving (Show, Generic)++instance FromJSON Output -- required for `runLastMinizincJSON`++main :: IO ()+main = do+  inspect "models/example001.mzn" >>= print+  let mzn = simpleMiniZinc @Input @Output "models/example001.mzn" 1000 Gecode+  let problem = Input 10+  runLastMinizincJSON mzn problem >>= print+```++The `@Input` and `@Output` syntax allow to pass type parameters to+`simpleMiniZinc`, this style is optional but helps the GHC compiler inference+(in our example, this type application is the only indication needed to tell+the compiler to deserialize `Output` objects).++# Misc.++The author of this package is not affiliated with MiniZinc.+See also: [https://www.minizinc.org/](https://www.minizinc.org/).

+ Setup.hs view

@@ -0,0 +1,2 @@+import Distribution.Simple+main = defaultMain

+ minizinc-process.cabal view

@@ -0,0 +1,53 @@+cabal-version:       >=1.10+-- Initial package description 'minizinc-process.cabal' generated by 'cabal+--  init'.  For further documentation, see+-- http://haskell.org/cabal/users-guide/++name:                minizinc-process+version:             0.1.0.0+synopsis:            A set of helpers to call minizinc models.+description:         MiniZinc is a language and a toolchain to solve discrete optimization problems. This package provides simple wrappers around the MiniZinc executable to pass inputs and read outputs.+homepage:       https://github.com/lucasdicioccio/minizinc-process#readme+bug-reports:    https://github.com/lucasdicioccio/minizinc-process/issues+license:             Apache-2.0+license-file:        LICENSE+author:              Lucas DiCioccio+maintainer:          lucas@dicioccio.fr+copyright:           Lucas DiCioccio (2020)+category:            Optimization+build-type:          Simple+extra-source-files:+  CHANGELOG.md+  README.md++source-repository head+  type: git+  location: https://github.com/lucasdicioccio/minizinc-process++library+  exposed-modules:+    Process.Minizinc+    Process.Minizinc.Inspect+  hs-source-dirs:+    src+  build-depends:       base >=4.13 && <4.14+                     , aeson+                     , bytestring+                     , containers+                     , directory+                     , hashable+                     , process-extras+                     , stringsearch+                     , text+  default-language:    Haskell2010++--executable minizinc-process-exe+--  main-is:             Main.hs+--  -- other-modules:+--  -- other-extensions:+--  build-depends:       base >=4.13 && <4.14+--                     , minizinc-process-lib+--                     , aeson+--                     , hashable+--                     , text+--  -- hs-source-dirs:

+ src/Process/Minizinc.hs view

@@ -0,0 +1,123 @@+{-# LANGUAGE LambdaCase #-}+{-# LANGUAGE OverloadedStrings #-}++-- | A set of types and functions to help calling Minizinc as an external binary.+--+-- Current strategy is to use JSON encode/decoding for passing in inputs and+-- reading outputs.+-- At this time, only a primitive output parser is supported.+module Process.Minizinc+  ( MiniZinc (..),+    simpleMiniZinc,+    Solver (..),+    SolverName,+    MilliSeconds,+    runLastMinizincJSON,+  )+where++import Control.Monad ((>=>))+import Data.Aeson (FromJSON, ToJSON, decode, encode)+import Data.ByteString (ByteString)+import qualified Data.ByteString as ByteString+import qualified Data.ByteString.Lazy as LByteString+import Data.ByteString.Lazy (fromStrict)+import Data.ByteString.Search.DFA (split)+import Data.Hashable (Hashable, hash)+import qualified Data.List as List+import System.Process.ByteString (readProcessWithExitCode)++-- | Type alias asking for milliseconds.+type MilliSeconds a = Int++-- | Name of a solver to be passed to the minizinc binary.+type SolverName = String++-- | Supported solvers or 'Other'.+data Solver = Chuffed | COIN_BC | CPLEX | Gecode | Gurobi | SCIP | Xpress | Other SolverName++-- | An object helping to run MiniZinc.+data MiniZinc input answer+  = MiniZinc+      { -- | a file path to a model+        model :: FilePath,+        -- | a file path to hold, must be writable and readable+        mkTmpDataPath :: input -> FilePath,+        -- | a timelimit in seconds (an Int)+        mkTimeLimit :: input -> MilliSeconds Int,+        -- | the solver to use (see `minizinc --solvers`)+        mkSolver :: input -> Solver,+        -- | other arguments that get appended before the path to the model and data paths+        mkExtraArgs :: input -> [String]+      }++-- | A constructor for MiniZinc object for simple situations.+simpleMiniZinc ::+  Hashable input =>+  FilePath ->+  MilliSeconds Int ->+  Solver ->+  MiniZinc input answer+simpleMiniZinc path timeout solver =+  MiniZinc+    path+    (\obj -> show (hash obj) ++ ".json")+    (const timeout)+    (const solver)+    (const [])++-- | Runs MiniZinc on the input and parses output for the last answer.+--+-- The parser for now is primitive and all the parsing occurs after processing+-- with no guarantee to run on bounded-memory. This matters if your MiniZinc+-- model returns so many solutions that the output is large.+runLastMinizincJSON ::+  (ToJSON input, FromJSON answer) =>+  MiniZinc input answer ->+  input ->+  IO (Maybe answer)+runLastMinizincJSON minizinc obj = do+  LByteString.writeFile fullPath $ encode obj+  (_, out, err) <- readProcessWithExitCode "minizinc" args ""+  seq (ByteString.length err) $ pure $ locateLastAnswer out+  where+    fullPath :: FilePath+    fullPath = mkTmpDataPath minizinc obj+    locateLastAnswer :: FromJSON answer => ByteString -> Maybe answer+    locateLastAnswer = locateLastOutput >=> decode . fromStrict+    args :: [String]+    args =+      [ "--time-limit",+        show (mkTimeLimit minizinc obj),+        "--solver",+        showSolver (mkSolver minizinc obj),+        "--output-mode",+        "json"+      ]+        ++ (mkExtraArgs minizinc obj)+        ++ [ model minizinc,+             fullPath+           ]++showSolver :: Solver -> String+showSolver = \case+  Chuffed -> "Chuffed"+  COIN_BC -> "COIN-BC"+  CPLEX -> "CPLEX"+  Gecode -> "Gecode"+  Gurobi -> "Gurobi"+  SCIP -> "SCIP"+  Xpress -> "Xpress"+  Other n -> n++locateLastOutput :: ByteString -> Maybe ByteString+locateLastOutput =+  safehead+    . reverse+    . List.filter (ByteString.isPrefixOf openCurlybrace)+    . split resultSeparator+  where+    safehead [] = Nothing+    safehead xs = Just $ head xs+    resultSeparator = "\n----------\n"+    openCurlybrace = "{"

+ src/Process/Minizinc/Inspect.hs view

@@ -0,0 +1,78 @@+{-# LANGUAGE OverloadedStrings #-}++-- | Provides primitives for inspecting the interface of a model.+module Process.Minizinc.Inspect+  ( inspect,+    TypeInfo (..),+    TypeDeclarations,+    Method (..),+    Interface (..),+  )+where++import Data.Aeson+import qualified Data.ByteString as ByteString+import qualified Data.ByteString.Lazy as LByteString+import Data.Map (Map)+import Data.Text (Text)+import qualified Data.Text as Text+import System.Process.ByteString (readProcessWithExitCode)++-- | Name of variables.+type Name = Text++-- | Information regarding one name.+data TypeInfo+  = TypeInfo+      { _type :: Text,+        _set :: Bool,+        _dim :: Maybe Int+      }+  deriving (Show)++instance FromJSON TypeInfo where+  parseJSON = withObject "TypeInfo" $ \v ->+    TypeInfo+      <$> v .: "type"+      <*> v .:? "set" .!= False+      <*> v .:? "dim"++-- | Type declarations of the minizinc model.+type TypeDeclarations = Map Name TypeInfo++-- | Optimization method.+data Method = Minimize | Maximize | Satisfy+  deriving (Show)++instance FromJSON Method where+  parseJSON = withText "Method" $ \s -> case s of+    "max" -> pure Maximize+    "min" -> pure Minimize+    "sat" -> pure Satisfy+    v -> fail $ "unsupported method: " ++ Text.unpack v++-- | A description of the model input/output.+data Interface+  = Interface+      { _method :: Method,+        _has_output_item :: Bool,+        _input :: TypeDeclarations,+        _output :: TypeDeclarations+      }+  deriving (Show)++instance FromJSON Interface where+  parseJSON = withObject "Interface" $ \v ->+    Interface+      <$> v .: "method"+      <*> v .: "has_output_item"+      <*> v .: "input"+      <*> v .: "output"++-- | Calls the minizinc binary to output the model interface.+inspect :: FilePath -> IO (Maybe Interface)+inspect path = do+  (_, out, err) <- readProcessWithExitCode "minizinc" args ""+  seq (ByteString.length err) $ pure $ decode $ LByteString.fromStrict out+  where+    args = ["-c", "--model-interface-only", path]