Clingo.Symbol

Functions for handling symbols and signatures with clingo.

Documentation

data Clingo s a

The Clingo monad provides a base monad for computations utilizing the clingo answer set solver. It uses an additional type parameter to ensure that values that are managed by the solver can not leave scope.

Instances

MonadSymbol Clingo

Methods

createSignature :: Text -> Natural -> Bool -> Clingo s (Signature s)

createNumber :: Integral a => a -> Clingo s (Symbol s)

createSupremum :: Clingo s (Symbol s)

createInfimum :: Clingo s (Symbol s)

createString :: Text -> Clingo s (Symbol s)

createFunction :: Text -> [Symbol s] -> Bool -> Clingo s (Symbol s)

MonadModel Clingo

Methods

modelType :: Model s -> Clingo s ModelType

modelNumber :: Model s -> Clingo s Natural

modelSymbols :: Model s -> SymbolSelection -> Clingo s [Symbol s]

contains :: Model s -> Symbol s -> Clingo s Bool

costVector :: Model s -> Clingo s [Integer]

optimalityProven :: Model s -> Clingo s Bool

context :: Model s -> Clingo s (SolveControl s)

modelAddClause :: Foldable t => SolveControl s -> t (SymbolicLiteral s) -> Clingo s ()

MonadSolve Clingo

Methods

getResult :: Solver s -> Clingo s SolveResult

getModel :: Solver s -> Clingo s (Maybe (Model s))

solverWait :: Solver s -> Double -> Clingo s ResultReady

solverResume :: Solver s -> Clingo s ()

solverCancel :: Solver s -> Clingo s ()

Monad (Clingo s)

Methods

(>>=) :: Clingo s a -> (a -> Clingo s b) -> Clingo s b

(>>) :: Clingo s a -> Clingo s b -> Clingo s b

return :: a -> Clingo s a

fail :: String -> Clingo s a

Functor (Clingo s)

Methods

fmap :: (a -> b) -> Clingo s a -> Clingo s b

(<$) :: a -> Clingo s b -> Clingo s a

MonadFix (Clingo s)

Methods

mfix :: (a -> Clingo s a) -> Clingo s a

Applicative (Clingo s)

Methods

pure :: a -> Clingo s a

(<*>) :: Clingo s (a -> b) -> Clingo s a -> Clingo s b

(*>) :: Clingo s a -> Clingo s b -> Clingo s b

(<*) :: Clingo s a -> Clingo s b -> Clingo s a

MonadIO (Clingo s)

Methods

liftIO :: IO a -> Clingo s a

Alternative (Clingo s)

Methods

empty :: Clingo s a

(<|>) :: Clingo s a -> Clingo s a -> Clingo s a

some :: Clingo s a -> Clingo s [a]

many :: Clingo s a -> Clingo s [a]

MonadPlus (Clingo s)

Methods

mzero :: Clingo s a

mplus :: Clingo s a -> Clingo s a -> Clingo s a

MonadThrow (Clingo s)

Methods

throwM :: Exception e => e -> Clingo s a

MonadCatch (Clingo s)

Methods

catch :: Exception e => Clingo s a -> (e -> Clingo s a) -> Clingo s a

MonadMask (Clingo s)

Methods

mask :: ((forall a. Clingo s a -> Clingo s a) -> Clingo s b) -> Clingo s b

uninterruptibleMask :: ((forall a. Clingo s a -> Clingo s a) -> Clingo s b) -> Clingo s b

data ClingoWarning

Instances

Show ClingoWarning

Methods

showsPrec :: Int -> ClingoWarning -> ShowS

show :: ClingoWarning -> String

showList :: [ClingoWarning] -> ShowS

Exception ClingoWarning

Methods

toException :: ClingoWarning -> SomeException

fromException :: SomeException -> Maybe ClingoWarning

displayException :: ClingoWarning -> String

warningString :: MonadIO m => ClingoWarning -> m Text

data Symbol s

Instances

Eq (Symbol s)

Methods

(==) :: Symbol s -> Symbol s -> Bool

(/=) :: Symbol s -> Symbol s -> Bool

Ord (Symbol s)

Methods

compare :: Symbol s -> Symbol s -> Ordering

(<) :: Symbol s -> Symbol s -> Bool

(<=) :: Symbol s -> Symbol s -> Bool

(>) :: Symbol s -> Symbol s -> Bool

(>=) :: Symbol s -> Symbol s -> Bool

max :: Symbol s -> Symbol s -> Symbol s

min :: Symbol s -> Symbol s -> Symbol s

Generic (Symbol s)

Associated Types

type Rep (Symbol s) :: * -> *

Methods

from :: Symbol s -> Rep (Symbol s) x

to :: Rep (Symbol s) x -> Symbol s

NFData (Symbol s)

Methods

rnf :: Symbol s -> ()

Hashable (Symbol s)

Methods

hashWithSalt :: Int -> Symbol s -> Int

hash :: Symbol s -> Int

type Rep (Symbol s)

type Rep (Symbol s) = D1 (MetaData "Symbol" "Clingo.Internal.Types" "clingo-0.2.0.0-DzJnCg9nABaE1yAGw8EIsO" False) (C1 (MetaCons "Symbol" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "rawSymbol") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Symbol)) (S1 (MetaSel (Just Symbol "symType") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 SymbolType))) ((:*:) (S1 (MetaSel (Just Symbol "symHash") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Integer)) (S1 (MetaSel (Just Symbol "symNum") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Integer))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "symName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "symString") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "symArgs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Symbol s])) (S1 (MetaSel (Just Symbol "symPretty") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text))))))

data Location

Instances

Eq Location

Methods

(==) :: Location -> Location -> Bool

(/=) :: Location -> Location -> Bool

Ord Location

Methods

compare :: Location -> Location -> Ordering

(<) :: Location -> Location -> Bool

(<=) :: Location -> Location -> Bool

(>) :: Location -> Location -> Bool

(>=) :: Location -> Location -> Bool

max :: Location -> Location -> Location

min :: Location -> Location -> Location

Show Location

Methods

showsPrec :: Int -> Location -> ShowS

show :: Location -> String

showList :: [Location] -> ShowS

class Signed a where

Methods

positive :: a -> Bool

negative :: a -> Bool

Instances

Signed Bool

Methods

positive :: Bool -> Bool

negative :: Bool -> Bool

Signed (AspifLiteral s)

Methods

positive :: AspifLiteral s -> Bool

negative :: AspifLiteral s -> Bool

Signed (Literal s)

Methods

positive :: Literal s -> Bool

negative :: Literal s -> Bool

Signed (Signature s)

Methods

positive :: Signature s -> Bool

negative :: Signature s -> Bool

Signed (SymbolicLiteral s)

Methods

positive :: SymbolicLiteral s -> Bool

negative :: SymbolicLiteral s -> Bool

Signed (FunctionSymbol s)

Methods

positive :: FunctionSymbol s -> Bool

negative :: FunctionSymbol s -> Bool

Symbol types

newtype SymbolType

Constructors

SymbolType SymbolType

Instances

Eq SymbolType

Methods

(==) :: SymbolType -> SymbolType -> Bool

(/=) :: SymbolType -> SymbolType -> Bool

symbolType :: Symbol s -> SymbolType

Get the type of a symbol

pattern SymInfimum :: SymbolType

pattern SymNumber :: SymbolType

pattern SymString :: SymbolType

pattern SymFunction :: SymbolType

pattern SymSupremum :: SymbolType

Function symbols

data FunctionSymbol s

Instances

Eq (FunctionSymbol s)

Methods

(==) :: FunctionSymbol s -> FunctionSymbol s -> Bool

(/=) :: FunctionSymbol s -> FunctionSymbol s -> Bool

Ord (FunctionSymbol s)

Methods

compare :: FunctionSymbol s -> FunctionSymbol s -> Ordering

(<) :: FunctionSymbol s -> FunctionSymbol s -> Bool

(<=) :: FunctionSymbol s -> FunctionSymbol s -> Bool

(>) :: FunctionSymbol s -> FunctionSymbol s -> Bool

(>=) :: FunctionSymbol s -> FunctionSymbol s -> Bool

max :: FunctionSymbol s -> FunctionSymbol s -> FunctionSymbol s

min :: FunctionSymbol s -> FunctionSymbol s -> FunctionSymbol s

Signed (FunctionSymbol s)

Methods

positive :: FunctionSymbol s -> Bool

negative :: FunctionSymbol s -> Bool

functionSymbol :: Symbol s -> Maybe (FunctionSymbol s)

Obtain a FunctionSymbol if possible.

Signature parsing/inspection

data Signature s

Instances

Eq (Signature s)

Methods

(==) :: Signature s -> Signature s -> Bool

(/=) :: Signature s -> Signature s -> Bool

Ord (Signature s)

Methods

compare :: Signature s -> Signature s -> Ordering

(<) :: Signature s -> Signature s -> Bool

(<=) :: Signature s -> Signature s -> Bool

(>) :: Signature s -> Signature s -> Bool

(>=) :: Signature s -> Signature s -> Bool

max :: Signature s -> Signature s -> Signature s

min :: Signature s -> Signature s -> Signature s

Hashable (Signature s)

Methods

hashWithSalt :: Int -> Signature s -> Int

hash :: Signature s -> Int

Signed (Signature s)

Methods

positive :: Signature s -> Bool

negative :: Signature s -> Bool

parseTerm

Arguments

:: Text

Term as Text

-> Maybe (ClingoWarning -> Text -> IO ())

Logger callback

-> Natural

Callback limit

-> Clingo s (Symbol s)

Parse a term in string form. This does not return an AST Term!

signatureArity :: Signature s -> Natural

Get the arity of a signature.

signatureHash :: Signature s -> Integer

Hash a signature.

signatureName :: Signature s -> Text

Get the name of a signature.

Symbol and signature creation

class MonadSymbol m where

Minimal complete definition

createSignature, createNumber, createSupremum, createInfimum, createString, createFunction

Methods

createSignature :: Text -> Natural -> Bool -> m s (Signature s)

Create a new signature with the solver, taking a name, an arity and a bool determining the sign.

createNumber :: Integral a => a -> m s (Symbol s)

Create a number symbol.

createSupremum :: m s (Symbol s)

Create a supremum symbol, #sup.

createInfimum :: m s (Symbol s)

Create a infimum symbol, #inf.

createString :: Text -> m s (Symbol s)

Construct a symbol representing a string.

createFunction :: Text -> [Symbol s] -> Bool -> m s (Symbol s)

Construct a symbol representing a function or tuple from a name, arguments, and whether the sign is positive.

Instances

MonadSymbol Clingo

Methods

createSignature :: Text -> Natural -> Bool -> Clingo s (Signature s)

createNumber :: Integral a => a -> Clingo s (Symbol s)

createSupremum :: Clingo s (Symbol s)

createInfimum :: Clingo s (Symbol s)

createString :: Text -> Clingo s (Symbol s)

createFunction :: Text -> [Symbol s] -> Bool -> Clingo s (Symbol s)

MonadSymbol IOSym

Methods

createSignature :: Text -> Natural -> Bool -> IOSym s (Signature s)

createNumber :: Integral a => a -> IOSym s (Symbol s)

createSupremum :: IOSym s (Symbol s)

createInfimum :: IOSym s (Symbol s)

createString :: Text -> IOSym s (Symbol s)

createFunction :: Text -> [Symbol s] -> Bool -> IOSym s (Symbol s)

MonadSymbol (Propagation phase)

Methods

createSignature :: Text -> Natural -> Bool -> Propagation phase s (Signature s)

createNumber :: Integral a => a -> Propagation phase s (Symbol s)

createSupremum :: Propagation phase s (Symbol s)

createInfimum :: Propagation phase s (Symbol s)

createString :: Text -> Propagation phase s (Symbol s)

createFunction :: Text -> [Symbol s] -> Bool -> Propagation phase s (Symbol s)

createId :: MonadSymbol m => Text -> Bool -> m s (Symbol s)

Construct a symbol representing an id.

Symbol inspection

symbolArguments :: Symbol s -> [Symbol s]

Obtain the arguments of a symbol. May be empty.

symbolGetArg :: Symbol s -> Int -> Maybe (Symbol s)

Obtain the n-th argument of a symbol.

symbolHash :: Symbol s -> Integer

Hash a symbol

symbolName :: Symbol s -> Maybe Text

Obtain the name of a symbol when possible.

symbolNumber :: Symbol s -> Maybe Integer

Obtain number from symbol. Will fail for invalid symbol types.

symbolString :: Symbol s -> Maybe Text

Obtain the string from a suitable symbol.

prettySymbol :: Symbol s -> Text

Pretty print a symbol into a Text.

Pure types

data PureSymbol

PureSymbol represents a completely pure Haskell alternative to the handled Symbol type of the clingo library.

Constructors

PureInfimum

PureSupremum

PureNumber Integer

PureFunction Text [PureSymbol] Bool

PureString Text

Instances

Eq PureSymbol

Methods

(==) :: PureSymbol -> PureSymbol -> Bool

(/=) :: PureSymbol -> PureSymbol -> Bool

Ord PureSymbol

Methods

compare :: PureSymbol -> PureSymbol -> Ordering

(<) :: PureSymbol -> PureSymbol -> Bool

(<=) :: PureSymbol -> PureSymbol -> Bool

(>) :: PureSymbol -> PureSymbol -> Bool

(>=) :: PureSymbol -> PureSymbol -> Bool

max :: PureSymbol -> PureSymbol -> PureSymbol

min :: PureSymbol -> PureSymbol -> PureSymbol

Show PureSymbol

Methods

showsPrec :: Int -> PureSymbol -> ShowS

show :: PureSymbol -> String

showList :: [PureSymbol] -> ShowS

Generic PureSymbol

Associated Types

type Rep PureSymbol :: * -> *

Methods

from :: PureSymbol -> Rep PureSymbol x

to :: Rep PureSymbol x -> PureSymbol

Pretty PureSymbol

Methods

pretty :: PureSymbol -> Doc

prettyList :: [PureSymbol] -> Doc

type Rep PureSymbol

type Rep PureSymbol = D1 (MetaData "PureSymbol" "Clingo.Symbol" "clingo-0.2.0.0-DzJnCg9nABaE1yAGw8EIsO" False) ((:+:) ((:+:) (C1 (MetaCons "PureInfimum" PrefixI False) U1) (C1 (MetaCons "PureSupremum" PrefixI False) U1)) ((:+:) (C1 (MetaCons "PureNumber" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Integer))) ((:+:) (C1 (MetaCons "PureFunction" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [PureSymbol])) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool))))) (C1 (MetaCons "PureString" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text))))))

unpureSymbol :: (Monad (m s), MonadSymbol m) => PureSymbol -> m s (Symbol s)

Create a Symbol in the solver from a PureSymbol

toPureSymbol :: Symbol s -> PureSymbol

data PureSignature

PureSignature represents a completely pure Haskell alternative to the handled Signature type of the clingo library.

Constructors

PureSignature Text Natural Bool

Instances

Eq PureSignature

Methods

(==) :: PureSignature -> PureSignature -> Bool

(/=) :: PureSignature -> PureSignature -> Bool

Ord PureSignature

Methods

compare :: PureSignature -> PureSignature -> Ordering

(<) :: PureSignature -> PureSignature -> Bool

(<=) :: PureSignature -> PureSignature -> Bool

(>) :: PureSignature -> PureSignature -> Bool

(>=) :: PureSignature -> PureSignature -> Bool

max :: PureSignature -> PureSignature -> PureSignature

min :: PureSignature -> PureSignature -> PureSignature

Show PureSignature

Methods

showsPrec :: Int -> PureSignature -> ShowS

show :: PureSignature -> String

showList :: [PureSignature] -> ShowS

Generic PureSignature

Associated Types

type Rep PureSignature :: * -> *

Methods

from :: PureSignature -> Rep PureSignature x

to :: Rep PureSignature x -> PureSignature

Pretty PureSignature

Methods

pretty :: PureSignature -> Doc

prettyList :: [PureSignature] -> Doc

type Rep PureSignature

type Rep PureSignature = D1 (MetaData "PureSignature" "Clingo.Symbol" "clingo-0.2.0.0-DzJnCg9nABaE1yAGw8EIsO" False) (C1 (MetaCons "PureSignature" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Natural)) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)))))

unpureSignature :: MonadSymbol m => PureSignature -> m s (Signature s)

Create a Signature in the solver from a PureSignature

toPureSignature :: Signature s -> PureSignature