diff --git a/CHANGES b/CHANGES --- a/CHANGES +++ b/CHANGES @@ -1,5 +1,12 @@ -*- mode: outline -*- +* 1.2 +Reimplemented with lazy ByteStrings, for efficiency. It used to be very slow +on large CNF instances. + +(backwards-incompatible) Now use unboxed int-arrays for clauses, which is more +memory-efficient than lists. + * 1.1 (21 Mar 2008) Parser allows clauses to be split over multiple lines. diff --git a/COPYING b/COPYING deleted file mode 100644 --- a/COPYING +++ /dev/null @@ -1,165 +0,0 @@ - GNU LESSER GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - - This version of the GNU Lesser General Public License incorporates -the terms and conditions of version 3 of the GNU General Public -License, supplemented by the additional permissions listed below. - - 0. Additional Definitions. - - As used herein, "this License" refers to version 3 of the GNU Lesser -General Public License, and the "GNU GPL" refers to version 3 of the GNU -General Public License. - - "The Library" refers to a covered work governed by this License, -other than an Application or a Combined Work as defined below. - - An "Application" is any work that makes use of an interface provided -by the Library, but which is not otherwise based on the Library. -Defining a subclass of a class defined by the Library is deemed a mode -of using an interface provided by the Library. - - A "Combined Work" is a work produced by combining or linking an -Application with the Library. The particular version of the Library -with which the Combined Work was made is also called the "Linked -Version". - - The "Minimal Corresponding Source" for a Combined Work means the -Corresponding Source for the Combined Work, excluding any source code -for portions of the Combined Work that, considered in isolation, are -based on the Application, and not on the Linked Version. - - The "Corresponding Application Code" for a Combined Work means the -object code and/or source code for the Application, including any data -and utility programs needed for reproducing the Combined Work from the -Application, but excluding the System Libraries of the Combined Work. - - 1. Exception to Section 3 of the GNU GPL. - - You may convey a covered work under sections 3 and 4 of this License -without being bound by section 3 of the GNU GPL. - - 2. Conveying Modified Versions. - - If you modify a copy of the Library, and, in your modifications, a -facility refers to a function or data to be supplied by an Application -that uses the facility (other than as an argument passed when the -facility is invoked), then you may convey a copy of the modified -version: - - a) under this License, provided that you make a good faith effort to - ensure that, in the event an Application does not supply the - function or data, the facility still operates, and performs - whatever part of its purpose remains meaningful, or - - b) under the GNU GPL, with none of the additional permissions of - this License applicable to that copy. - - 3. Object Code Incorporating Material from Library Header Files. - - The object code form of an Application may incorporate material from -a header file that is part of the Library. You may convey such object -code under terms of your choice, provided that, if the incorporated -material is not limited to numerical parameters, data structure -layouts and accessors, or small macros, inline functions and templates -(ten or fewer lines in length), you do both of the following: - - a) Give prominent notice with each copy of the object code that the - Library is used in it and that the Library and its use are - covered by this License. - - b) Accompany the object code with a copy of the GNU GPL and this license - document. - - 4. Combined Works. - - You may convey a Combined Work under terms of your choice that, -taken together, effectively do not restrict modification of the -portions of the Library contained in the Combined Work and reverse -engineering for debugging such modifications, if you also do each of -the following: - - a) Give prominent notice with each copy of the Combined Work that - the Library is used in it and that the Library and its use are - covered by this License. - - b) Accompany the Combined Work with a copy of the GNU GPL and this license - document. - - c) For a Combined Work that displays copyright notices during - execution, include the copyright notice for the Library among - these notices, as well as a reference directing the user to the - copies of the GNU GPL and this license document. - - d) Do one of the following: - - 0) Convey the Minimal Corresponding Source under the terms of this - License, and the Corresponding Application Code in a form - suitable for, and under terms that permit, the user to - recombine or relink the Application with a modified version of - the Linked Version to produce a modified Combined Work, in the - manner specified by section 6 of the GNU GPL for conveying - Corresponding Source. - - 1) Use a suitable shared library mechanism for linking with the - Library. A suitable mechanism is one that (a) uses at run time - a copy of the Library already present on the user's computer - system, and (b) will operate properly with a modified version - of the Library that is interface-compatible with the Linked - Version. - - e) Provide Installation Information, but only if you would otherwise - be required to provide such information under section 6 of the - GNU GPL, and only to the extent that such information is - necessary to install and execute a modified version of the - Combined Work produced by recombining or relinking the - Application with a modified version of the Linked Version. (If - you use option 4d0, the Installation Information must accompany - the Minimal Corresponding Source and Corresponding Application - Code. If you use option 4d1, you must provide the Installation - Information in the manner specified by section 6 of the GNU GPL - for conveying Corresponding Source.) - - 5. Combined Libraries. - - You may place library facilities that are a work based on the -Library side by side in a single library together with other library -facilities that are not Applications and are not covered by this -License, and convey such a combined library under terms of your -choice, if you do both of the following: - - a) Accompany the combined library with a copy of the same work based - on the Library, uncombined with any other library facilities, - conveyed under the terms of this License. - - b) Give prominent notice with the combined library that part of it - is a work based on the Library, and explaining where to find the - accompanying uncombined form of the same work. - - 6. Revised Versions of the GNU Lesser General Public License. - - The Free Software Foundation may publish revised and/or new versions -of the GNU Lesser General Public License from time to time. Such new -versions will be similar in spirit to the present version, but may -differ in detail to address new problems or concerns. - - Each version is given a distinguishing version number. If the -Library as you received it specifies that a certain numbered version -of the GNU Lesser General Public License "or any later version" -applies to it, you have the option of following the terms and -conditions either of that published version or of any later version -published by the Free Software Foundation. If the Library as you -received it does not specify a version number of the GNU Lesser -General Public License, you may choose any version of the GNU Lesser -General Public License ever published by the Free Software Foundation. - - If the Library as you received it specifies that a proxy can decide -whether future versions of the GNU Lesser General Public License shall -apply, that proxy's public statement of acceptance of any version is -permanent authorization for you to choose that version for the -Library. diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,165 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. diff --git a/Language/CNF/Parse/ParseDIMACS.hs b/Language/CNF/Parse/ParseDIMACS.hs --- a/Language/CNF/Parse/ParseDIMACS.hs +++ b/Language/CNF/Parse/ParseDIMACS.hs @@ -15,63 +15,84 @@ Copyright 2008 Denis Bueno -} --- | A simple Parsec module for parsing CNF files in DIMACS format. +-- | A simple module for parsing CNF files in DIMACS format. module Language.CNF.Parse.ParseDIMACS - ( parseCNF, CNF(..) ) where + ( parseByteString + , parseFile + , CNF(..) + , Clause ) + where -import Text.ParserCombinators.Parsec +import Control.Monad +import Data.Array.Unboxed +import Data.ByteString.Lazy( ByteString ) +import Prelude hiding (readFile, map) +import Text.Parsec( ParseError, SourceName ) +import Text.Parsec.ByteString.Lazy +import Text.Parsec.Char +import Text.Parsec.Combinator +import Text.Parsec.Prim( try, unexpected, runParser ) +import qualified Text.Parsec.Token as T -data CNF = CNF {numVars :: Int - ,numClauses :: Int - ,clauses :: [[Int]]} - deriving Show -parseCNF :: String -- ^ The filename. Used to report errors. - -> String -- ^ The contents of the CNF file. - -> CNF -parseCNF title input = - case parse cnf title input of - Left parseError -> error $ "Parse error: " ++ show parseError - Right cs -> cs +data CNF = CNF + { numVars :: !Int + -- ^ The number of variables in the problem as reported by the cnf header. + , numClauses :: !Int + -- ^ The number of clauses in the problem as reported by the cnf header. + + , clauses :: ![Clause] } deriving Show +type Clause = UArray Int Int + +-- | Parse a file containing DIMACS CNF data. +parseFile :: FilePath -> IO (Either ParseError CNF) +parseFile = parseFromFile cnf + +-- | Parse a byte string containing DIMACS CNF data. The source name is only +-- | used in error messages and may be the empty string. +parseByteString :: SourceName -> ByteString -> Either ParseError CNF +parseByteString = runParser cnf () + -- A DIMACS CNF file contains a header of the form "p cnf -- " and then a bunch of 0-terminated clauses. cnf :: Parser CNF -cnf = - do many comment - char 'p' ; spaces - string "cnf" ; spaces - numVars <- many1 digit ; spaces - numClauses <- many1 digit - space `manyTill` newline - actualClauses <- many1 clause - return $ CNF (read numVars) (read numClauses) actualClauses +cnf = uncurry CNF `fmap` cnfHeader `ap` lexeme (many1 clause) -comment :: Parser String -comment = do char 'c' ; manyTill anyChar (try newline) +-- Parses into `(numVars, numClauses)'. +cnfHeader :: Parser (Int, Int) +cnfHeader = do + whiteSpace + char 'p' >> many1 space -- Can't use symbol here because it uses + -- whiteSpace, which will treat the following + -- "cnf" as a comment. + symbol "cnf" + (,) `fmap` natural `ap` natural -clause :: Parser [Int] -clause = do many (space <|> newline) - lits <- between (string "") (char '0') (many1 intSpaces) - many (space <|> newline) - return lits +clause :: Parser (UArray Int Int) +clause = do ints <- lexeme int `manyTill` try (symbol "0") + return $ listArray (0, length ints - 1) ints --- Consume all whitespace after the int so the `between' in `clause' matches --- on "0" at the end. -intSpaces = do i <- int - many1 (space <|> newline) - return i -int :: Parser Int -int = do parity <- option '+' $ choice $ map char "+-" - first <- posDigit - rest <- many digit - return . read $ - case parity of - '+' -> first : rest - '-' -> '-' : first : rest - _ -> error $ "unknown parity syntax: " ++ [parity] - -posDigit :: Parser Char -posDigit = oneOf ['1'..'9'] +-- token parser +tp = T.makeTokenParser $ T.LanguageDef + { T.commentStart = "" + , T.commentEnd = "" + , T.commentLine = "c" + , T.nestedComments = False + , T.identStart = unexpected "ParseDIMACS bug: shouldn't be parsing identifiers..." + , T.identLetter = unexpected "ParseDIMACS bug: shouldn't be parsing identifiers..." + , T.opStart = unexpected "ParseDIMACS bug: shouldn't be parsing operators..." + , T.opLetter = unexpected "ParseDIMACS bug: shouldn't be parsing operators..." + , T.reservedNames = ["p", "cnf"] + , T.reservedOpNames = [] + , T.caseSensitive = True + } +natural :: Parser Int +natural = fromIntegral `fmap` T.natural tp +int :: Parser Int +int = fromIntegral `fmap` T.integer tp +symbol = T.symbol tp +whiteSpace = T.whiteSpace tp +lexeme = T.lexeme tp diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/Setup.lhs b/Setup.lhs deleted file mode 100644 --- a/Setup.lhs +++ /dev/null @@ -1,4 +0,0 @@ -#! /usr/bin/env runhaskell - -> import Distribution.Simple -> main = defaultMain diff --git a/parse-dimacs.cabal b/parse-dimacs.cabal --- a/parse-dimacs.cabal +++ b/parse-dimacs.cabal @@ -1,17 +1,40 @@ Name: parse-dimacs -Version: 1.1 +Version: 1.2 +Cabal-Version: >= 1.2 Synopsis: DIMACS CNF parser library -Description: A DIMACS CNF parser library, implemented with Parsec. +Description: + + A DIMACS CNF parser library, implemented with Parsec 3, using ByteStrings. + DIMACS CNF is a file format for describing constraint problems in + conjunctive normal form. + Category: Parsing License: LGPL -License-file: COPYING +License-file: LICENSE Author: Denis Bueno Maintainer: Denis Bueno Stability: provisional -Build-Depends: base, parsec Build-type: Simple -Tested-with: GHC==6.8.2 +Tested-with: GHC==6.8.3 Extra-source-files: CHANGES -Exposed-modules: Language.CNF.Parse.ParseDIMACS -Ghc-options: -W + +-- Executable pdtest +-- Main-is: Main.hs +-- Build-depends: parsec >= 3, base, bytestring, array +-- Ghc-options: -funbox-strict-fields +-- -fwarn-incomplete-patterns +-- -fwarn-dodgy-imports -fwarn-incomplete-record-updates +-- -fwarn-unused-binds -fwarn-unused-imports +-- Ghc-prof-options: -auto-all +-- Hs-source-dirs: . tests +-- Other-modules: Language.CNF.Parse.ParseDIMACS + +Library + Exposed-modules: Language.CNF.Parse.ParseDIMACS + Build-depends: parsec >= 3, base, bytestring, array + Ghc-options: -fwarn-incomplete-patterns + -fwarn-dodgy-imports -fwarn-incomplete-record-updates + -fwarn-unused-binds -fwarn-unused-imports + +