Camfort.Specification.Units.InferenceBackendFlint

Documentation

newtype FMPZ

Units of measure extension to Fortran: Flint backend components

Some notes on the Flint library to aid comprehension of the original C and this interface:

• They use a typedef TYPE TYPE_t[1] convention to do call-by-reference without an explicit pointer. It appears to be an unmentioned convention borrowed from related library & depedency GMP, explained in a GMP doc page: https://gmplib.org/manual/Parameter-Conventions . Any time one of these is a function parameter, it is correct to use 'Ptr a' in Haskell.
• Flint extensively uses two typedefs ulong and slong, which are "long integers" in unsigned and signed representations respectively. However, the story is more complicated in cross-platform contexts, because 64-bit Linux's longs are 64 bits (8 bytes), while 64-bit Windows kept them at 32 bits (4 bytes). That type is CLong in Haskell, and it doesn't match up with Flint's slong, so we roll our own newtypes instead. (See the definition for further explanation.)

typedef slong fmpz

GHC's generalized newtype deriving handles deriving all the instances we require for us.

Constructors

FMPZ

Fields

• unFMPZ :: SLong

Instances

Storable FMPZ

Defined in Camfort.Specification.Units.InferenceBackendFlint

Methods

sizeOf :: FMPZ -> Int

alignment :: FMPZ -> Int

peekElemOff :: Ptr FMPZ -> Int -> IO FMPZ

pokeElemOff :: Ptr FMPZ -> Int -> FMPZ -> IO ()

peekByteOff :: Ptr b -> Int -> IO FMPZ

pokeByteOff :: Ptr b -> Int -> FMPZ -> IO ()

peek :: Ptr FMPZ -> IO FMPZ

poke :: Ptr FMPZ -> FMPZ -> IO ()

Enum FMPZ

Defined in Camfort.Specification.Units.InferenceBackendFlint

Methods

succ :: FMPZ -> FMPZ

pred :: FMPZ -> FMPZ

toEnum :: Int -> FMPZ

fromEnum :: FMPZ -> Int

enumFrom :: FMPZ -> [FMPZ]

enumFromThen :: FMPZ -> FMPZ -> [FMPZ]

enumFromTo :: FMPZ -> FMPZ -> [FMPZ]

enumFromThenTo :: FMPZ -> FMPZ -> FMPZ -> [FMPZ]

Num FMPZ

Defined in Camfort.Specification.Units.InferenceBackendFlint

Methods

(+) :: FMPZ -> FMPZ -> FMPZ

(-) :: FMPZ -> FMPZ -> FMPZ

(*) :: FMPZ -> FMPZ -> FMPZ

negate :: FMPZ -> FMPZ

abs :: FMPZ -> FMPZ

signum :: FMPZ -> FMPZ

fromInteger :: Integer -> FMPZ

Integral FMPZ

Defined in Camfort.Specification.Units.InferenceBackendFlint

Methods

quot :: FMPZ -> FMPZ -> FMPZ

rem :: FMPZ -> FMPZ -> FMPZ

div :: FMPZ -> FMPZ -> FMPZ

mod :: FMPZ -> FMPZ -> FMPZ

quotRem :: FMPZ -> FMPZ -> (FMPZ, FMPZ)

divMod :: FMPZ -> FMPZ -> (FMPZ, FMPZ)

toInteger :: FMPZ -> Integer

Real FMPZ

Defined in Camfort.Specification.Units.InferenceBackendFlint

Methods

toRational :: FMPZ -> Rational

Eq FMPZ

Defined in Camfort.Specification.Units.InferenceBackendFlint

Methods

(==) :: FMPZ -> FMPZ -> Bool

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

Ord FMPZ

Defined in Camfort.Specification.Units.InferenceBackendFlint

Methods

compare :: FMPZ -> FMPZ -> Ordering

(<) :: FMPZ -> FMPZ -> Bool

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

(>) :: FMPZ -> FMPZ -> Bool

(>=) :: FMPZ -> FMPZ -> Bool

max :: FMPZ -> FMPZ -> FMPZ

min :: FMPZ -> FMPZ -> FMPZ

newtype SLong

Flint's long signed integer type slong (= GMP's mp_limb_signed_t).

As described in their Portability doc page https://flintlib.org/doc/portability.html , this replaces long (long signed integer). Importantly, it is *always* 64-bits, regardless of platform. long on Windows is usually 32-bits (whether on a 32-bit or 64-bit install), and you're meant to use long long instead.

We tie the typedef to Haskell's Int64, since that should be the appropriate size for any regular platform. Better would be to do some CPP or hsc2hs magic to check the size of an slong and use the appropriate Haskell signed integer type.

GHC's generalized newtype deriving handles deriving all the instances we require for us.

Constructors

SLong

Fields

• unSLong :: Int64

Instances

Storable SLong

Defined in Camfort.Specification.Units.InferenceBackendFlint

Methods

sizeOf :: SLong -> Int

alignment :: SLong -> Int

peekElemOff :: Ptr SLong -> Int -> IO SLong

pokeElemOff :: Ptr SLong -> Int -> SLong -> IO ()

peekByteOff :: Ptr b -> Int -> IO SLong

pokeByteOff :: Ptr b -> Int -> SLong -> IO ()

peek :: Ptr SLong -> IO SLong

poke :: Ptr SLong -> SLong -> IO ()

Enum SLong

Defined in Camfort.Specification.Units.InferenceBackendFlint

Methods

succ :: SLong -> SLong

pred :: SLong -> SLong

toEnum :: Int -> SLong

fromEnum :: SLong -> Int

enumFrom :: SLong -> [SLong]

enumFromThen :: SLong -> SLong -> [SLong]

enumFromTo :: SLong -> SLong -> [SLong]

enumFromThenTo :: SLong -> SLong -> SLong -> [SLong]

Num SLong

Defined in Camfort.Specification.Units.InferenceBackendFlint

Methods

(+) :: SLong -> SLong -> SLong

(-) :: SLong -> SLong -> SLong

(*) :: SLong -> SLong -> SLong

negate :: SLong -> SLong

abs :: SLong -> SLong

signum :: SLong -> SLong

fromInteger :: Integer -> SLong

Integral SLong

Defined in Camfort.Specification.Units.InferenceBackendFlint

Methods

quot :: SLong -> SLong -> SLong

rem :: SLong -> SLong -> SLong

div :: SLong -> SLong -> SLong

mod :: SLong -> SLong -> SLong

quotRem :: SLong -> SLong -> (SLong, SLong)

divMod :: SLong -> SLong -> (SLong, SLong)

toInteger :: SLong -> Integer

Real SLong

Defined in Camfort.Specification.Units.InferenceBackendFlint

Methods

toRational :: SLong -> Rational

Eq SLong

Defined in Camfort.Specification.Units.InferenceBackendFlint

Methods

(==) :: SLong -> SLong -> Bool

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

Ord SLong

Defined in Camfort.Specification.Units.InferenceBackendFlint

Methods

compare :: SLong -> SLong -> Ordering

(<) :: SLong -> SLong -> Bool

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

(>) :: SLong -> SLong -> Bool

(>=) :: SLong -> SLong -> Bool

max :: SLong -> SLong -> SLong

min :: SLong -> SLong -> SLong

data FMPZMat

Instances

Storable FMPZMat

Defined in Camfort.Specification.Units.InferenceBackendFlint

Methods

sizeOf :: FMPZMat -> Int

alignment :: FMPZMat -> Int

peekElemOff :: Ptr FMPZMat -> Int -> IO FMPZMat

pokeElemOff :: Ptr FMPZMat -> Int -> FMPZMat -> IO ()

peekByteOff :: Ptr b -> Int -> IO FMPZMat

pokeByteOff :: Ptr b -> Int -> FMPZMat -> IO ()

peek :: Ptr FMPZMat -> IO FMPZMat

poke :: Ptr FMPZMat -> FMPZMat -> IO ()

fmpz_mat_init :: Ptr FMPZMat -> SLong -> SLong -> IO ()

fmpz_mat_set :: Ptr FMPZMat -> Ptr FMPZMat -> IO ()

fmpz_mat_entry :: Ptr FMPZMat -> SLong -> SLong -> IO (Ptr FMPZ)

fmpz_set_si :: Ptr FMPZ -> SLong -> IO ()

fmpz_get_si :: Ptr FMPZ -> IO SLong

fmpz_mat_clear :: Ptr FMPZMat -> IO ()

fmpz_mat_print_pretty :: Ptr FMPZMat -> IO ()

fmpz_mat_mul :: Ptr FMPZMat -> Ptr FMPZMat -> Ptr FMPZMat -> IO ()

fmpz_mat_window_init :: Ptr FMPZMat -> Ptr FMPZMat -> SLong -> SLong -> SLong -> SLong -> IO ()

fmpz_mat_window_clear :: Ptr FMPZMat -> IO ()

fmpz_mat_rref :: Ptr FMPZMat -> Ptr FMPZ -> Ptr FMPZMat -> IO SLong

fmpz_mat_inv :: Ptr FMPZMat -> Ptr FMPZ -> Ptr FMPZMat -> IO CInt

fmpz_mat_hnf :: Ptr FMPZMat -> Ptr FMPZMat -> IO ()

fmpz_mat_rank :: Ptr FMPZMat -> IO SLong

rref :: Matrix Double -> (Matrix Double, Int, Int)

hnf :: Matrix Double -> Matrix Double

inv :: Matrix Double -> Maybe (Matrix Double, Int)

withMatrix :: Matrix Double -> ((SLong, SLong, Ptr FMPZMat) -> IO b) -> IO b

withBlankMatrix :: SLong -> SLong -> (Ptr FMPZMat -> IO b) -> IO b

withWindow :: Ptr FMPZMat -> SLong -> SLong -> SLong -> SLong -> (Ptr FMPZMat -> IO b) -> IO b

flintToHMatrix :: SLong -> SLong -> Ptr FMPZMat -> IO (Matrix Double)

pokeM :: Ptr FMPZMat -> SLong -> SLong -> SLong -> IO ()

peekM :: Ptr FMPZMat -> SLong -> SLong -> IO SLong

copyMatrix :: Ptr FMPZMat -> Ptr FMPZMat -> SLong -> SLong -> SLong -> SLong -> IO ()

normHNF :: Matrix Double -> (Matrix Double, [Int])

normHNF' :: Matrix Double -> (Matrix Double, [Int])

normhnf :: (SLong, SLong, Ptr FMPZMat) -> IO (Matrix Double, [SLong])

elemrowscale :: Ptr FMPZMat -> SLong -> SLong -> IO [(SLong, SLong)]

elemrowadds :: Ptr FMPZMat -> SLong -> SLong -> [(SLong, SLong)] -> IO ()