Safe Haskell | None |
---|---|
Language | Haskell2010 |
GHC.Utils.Misc
Contents
- Flags dependent on the compiler build
- Miscellaneous higher-order functions
- General list processing
- Tuples
- List operations controlled by another list
- Sorting
- Comparisons
- Edit distance
- Transitive closures
- Strictness
- Module names
- Argument processing
- Integers
- Floating point
- IO-ish utilities
- Filenames and paths
- Utils for defining Data instances
- Utils for printing C code
- Hashing
- Call stacks
- Utils for flags
Description
Highly random utility functions
Synopsis
- ghciSupported :: Bool
- debugIsOn :: Bool
- isWindowsHost :: Bool
- isDarwinHost :: Bool
- applyWhen :: Bool -> (a -> a) -> a -> a
- nTimes :: Int -> (a -> a) -> a -> a
- zipEqual :: String -> [a] -> [b] -> [(a, b)]
- zipWithEqual :: String -> (a -> b -> c) -> [a] -> [b] -> [c]
- zipWith3Equal :: String -> (a -> b -> c -> d) -> [a] -> [b] -> [c] -> [d]
- zipWith4Equal :: String -> (a -> b -> c -> d -> e) -> [a] -> [b] -> [c] -> [d] -> [e]
- zipLazy :: [a] -> [b] -> [(a, b)]
- stretchZipWith :: (a -> Bool) -> b -> (a -> b -> c) -> [a] -> [b] -> [c]
- zipWithAndUnzip :: (a -> b -> (c, d)) -> [a] -> [b] -> ([c], [d])
- zipAndUnzip :: [a] -> [b] -> ([a], [b])
- zipWithLazy :: (a -> b -> c) -> [a] -> [b] -> [c]
- zipWith3Lazy :: (a -> b -> c -> d) -> [a] -> [b] -> [c] -> [d]
- filterByList :: [Bool] -> [a] -> [a]
- filterByLists :: [Bool] -> [a] -> [a] -> [a]
- partitionByList :: [Bool] -> [a] -> ([a], [a])
- unzipWith :: (a -> b -> c) -> [(a, b)] -> [c]
- mapFst :: (a -> c) -> [(a, b)] -> [(c, b)]
- mapSnd :: (b -> c) -> [(a, b)] -> [(a, c)]
- chkAppend :: [a] -> [a] -> [a]
- mapAndUnzip :: (a -> (b, c)) -> [a] -> ([b], [c])
- mapAndUnzip3 :: (a -> (b, c, d)) -> [a] -> ([b], [c], [d])
- filterOut :: (a -> Bool) -> [a] -> [a]
- partitionWith :: (a -> Either b c) -> [a] -> ([b], [c])
- dropWhileEndLE :: (a -> Bool) -> [a] -> [a]
- spanEnd :: (a -> Bool) -> [a] -> ([a], [a])
- last2 :: [a] -> (a, a)
- lastMaybe :: [a] -> Maybe a
- foldl1' :: (a -> a -> a) -> [a] -> a
- foldl2 :: (acc -> a -> b -> acc) -> acc -> [a] -> [b] -> acc
- count :: (a -> Bool) -> [a] -> Int
- countWhile :: (a -> Bool) -> [a] -> Int
- all2 :: (a -> b -> Bool) -> [a] -> [b] -> Bool
- lengthExceeds :: [a] -> Int -> Bool
- lengthIs :: [a] -> Int -> Bool
- lengthIsNot :: [a] -> Int -> Bool
- lengthAtLeast :: [a] -> Int -> Bool
- lengthAtMost :: [a] -> Int -> Bool
- lengthLessThan :: [a] -> Int -> Bool
- listLengthCmp :: [a] -> Int -> Ordering
- atLength :: ([a] -> b) -> b -> [a] -> Int -> b
- equalLength :: [a] -> [b] -> Bool
- compareLength :: [a] -> [b] -> Ordering
- leLength :: [a] -> [b] -> Bool
- ltLength :: [a] -> [b] -> Bool
- isSingleton :: [a] -> Bool
- only :: [a] -> a
- singleton :: a -> [a]
- notNull :: [a] -> Bool
- snocView :: [a] -> Maybe ([a], a)
- isIn :: Eq a => String -> a -> [a] -> Bool
- isn'tIn :: Eq a => String -> a -> [a] -> Bool
- chunkList :: Int -> [a] -> [[a]]
- changeLast :: [a] -> a -> [a]
- mapLastM :: Functor f => (a -> f a) -> [a] -> f [a]
- whenNonEmpty :: Applicative m => [a] -> (NonEmpty a -> m ()) -> m ()
- mergeListsBy :: forall a. (a -> a -> Ordering) -> [[a]] -> [a]
- isSortedBy :: (a -> a -> Ordering) -> [a] -> Bool
- fstOf3 :: (a, b, c) -> a
- sndOf3 :: (a, b, c) -> b
- thdOf3 :: (a, b, c) -> c
- firstM :: Monad m => (a -> m c) -> (a, b) -> m (c, b)
- first3M :: Monad m => (a -> m d) -> (a, b, c) -> m (d, b, c)
- secondM :: Monad m => (b -> m c) -> (a, b) -> m (a, c)
- fst3 :: (a -> d) -> (a, b, c) -> (d, b, c)
- snd3 :: (b -> d) -> (a, b, c) -> (a, d, c)
- third3 :: (c -> d) -> (a, b, c) -> (a, b, d)
- uncurry3 :: (a -> b -> c -> d) -> (a, b, c) -> d
- liftFst :: (a -> b) -> (a, c) -> (b, c)
- liftSnd :: (a -> b) -> (c, a) -> (c, b)
- takeList :: [b] -> [a] -> [a]
- dropList :: [b] -> [a] -> [a]
- splitAtList :: [b] -> [a] -> ([a], [a])
- split :: Char -> String -> [String]
- dropTail :: Int -> [a] -> [a]
- capitalise :: String -> String
- sortWith :: Ord b => (a -> b) -> [a] -> [a]
- minWith :: Ord b => (a -> b) -> [a] -> a
- nubSort :: Ord a => [a] -> [a]
- ordNub :: Ord a => [a] -> [a]
- isEqual :: Ordering -> Bool
- eqListBy :: (a -> a -> Bool) -> [a] -> [a] -> Bool
- eqMaybeBy :: (a -> a -> Bool) -> Maybe a -> Maybe a -> Bool
- thenCmp :: Ordering -> Ordering -> Ordering
- cmpList :: (a -> a -> Ordering) -> [a] -> [a] -> Ordering
- removeSpaces :: String -> String
- (<&&>) :: Applicative f => f Bool -> f Bool -> f Bool
- (<||>) :: Applicative f => f Bool -> f Bool -> f Bool
- fuzzyMatch :: String -> [String] -> [String]
- fuzzyLookup :: String -> [(String, a)] -> [a]
- transitiveClosure :: (a -> [a]) -> (a -> a -> Bool) -> [a] -> [a]
- seqList :: [a] -> b -> b
- strictMap :: (a -> b) -> [a] -> [b]
- looksLikeModuleName :: String -> Bool
- looksLikePackageName :: String -> Bool
- getCmd :: String -> Either String (String, String)
- toCmdArgs :: String -> Either String (String, [String])
- toArgs :: String -> Either String [String]
- exactLog2 :: Integer -> Maybe Integer
- readRational :: String -> Rational
- readHexRational :: String -> Rational
- doesDirNameExist :: FilePath -> IO Bool
- getModificationUTCTime :: FilePath -> IO UTCTime
- modificationTimeIfExists :: FilePath -> IO (Maybe UTCTime)
- withAtomicRename :: MonadIO m => FilePath -> (FilePath -> m a) -> m a
- global :: a -> IORef a
- consIORef :: IORef [a] -> a -> IO ()
- globalM :: IO a -> IORef a
- sharedGlobal :: a -> (Ptr (IORef a) -> IO (Ptr (IORef a))) -> IORef a
- sharedGlobalM :: IO a -> (Ptr (IORef a) -> IO (Ptr (IORef a))) -> IORef a
- type Suffix = String
- splitLongestPrefix :: String -> (Char -> Bool) -> (String, String)
- escapeSpaces :: String -> String
- data Direction
- reslash :: Direction -> FilePath -> FilePath
- makeRelativeTo :: FilePath -> FilePath -> FilePath
- abstractConstr :: String -> Constr
- abstractDataType :: String -> DataType
- mkNoRepType :: String -> DataType
- charToC :: Word8 -> String
- hashString :: String -> Int32
- type HasCallStack = ?callStack :: CallStack
- type HasDebugCallStack = (() :: Constraint)
- data OverridingBool
- overrideWith :: Bool -> OverridingBool -> Bool
Flags dependent on the compiler build
ghciSupported :: Bool Source #
isWindowsHost :: Bool Source #
isDarwinHost :: Bool Source #
Miscellaneous higher-order functions
nTimes :: Int -> (a -> a) -> a -> a Source #
A for loop: Compose a function with itself n times. (nth rather than twice)
General list processing
zipWithEqual :: String -> (a -> b -> c) -> [a] -> [b] -> [c] Source #
zipWith3Equal :: String -> (a -> b -> c -> d) -> [a] -> [b] -> [c] -> [d] Source #
zipWith4Equal :: String -> (a -> b -> c -> d -> e) -> [a] -> [b] -> [c] -> [d] -> [e] Source #
stretchZipWith :: (a -> Bool) -> b -> (a -> b -> c) -> [a] -> [b] -> [c] Source #
stretchZipWith p z f xs ys
stretches ys
by inserting z
in
the places where p
returns True
zipWithAndUnzip :: (a -> b -> (c, d)) -> [a] -> [b] -> ([c], [d]) Source #
zipAndUnzip :: [a] -> [b] -> ([a], [b]) Source #
This has the effect of making the two lists have equal length by dropping the tail of the longer one.
zipWithLazy :: (a -> b -> c) -> [a] -> [b] -> [c] Source #
zipWithLazy
is like zipWith
but is lazy in the second list.
The length of the output is always the same as the length of the first
list.
zipWith3Lazy :: (a -> b -> c -> d) -> [a] -> [b] -> [c] -> [d] Source #
zipWith3Lazy
is like zipWith3
but is lazy in the second and third lists.
The length of the output is always the same as the length of the first
list.
filterByList :: [Bool] -> [a] -> [a] Source #
filterByList
takes a list of Bools and a list of some elements and
filters out these elements for which the corresponding value in the list of
Bools is False. This function does not check whether the lists have equal
length.
filterByLists :: [Bool] -> [a] -> [a] -> [a] Source #
filterByLists
takes a list of Bools and two lists as input, and
outputs a new list consisting of elements from the last two input lists. For
each Bool in the list, if it is True
, then it takes an element from the
former list. If it is False
, it takes an element from the latter list.
The elements taken correspond to the index of the Bool in its list.
For example:
filterByLists [True, False, True, False] "abcd" "wxyz" = "axcz"
This function does not check whether the lists have equal length.
partitionByList :: [Bool] -> [a] -> ([a], [a]) Source #
partitionByList
takes a list of Bools and a list of some elements and
partitions the list according to the list of Bools. Elements corresponding
to True
go to the left; elements corresponding to False
go to the right.
For example, partitionByList [True, False, True] [1,2,3] == ([1,3], [2])
This function does not check whether the lists have equal
length; when one list runs out, the function stops.
mapAndUnzip :: (a -> (b, c)) -> [a] -> ([b], [c]) Source #
mapAndUnzip3 :: (a -> (b, c, d)) -> [a] -> ([b], [c], [d]) Source #
partitionWith :: (a -> Either b c) -> [a] -> ([b], [c]) Source #
Uses a function to determine which of two output lists an input element should join
dropWhileEndLE :: (a -> Bool) -> [a] -> [a] Source #
spanEnd :: (a -> Bool) -> [a] -> ([a], [a]) Source #
spanEnd p l == reverse (span p (reverse l))
. The first list
returns actually comes after the second list (when you look at the
input list).
countWhile :: (a -> Bool) -> [a] -> Int Source #
lengthExceeds :: [a] -> Int -> Bool Source #
(lengthExceeds xs n) = (length xs > n)
lengthIsNot :: [a] -> Int -> Bool Source #
(lengthIsNot xs n) = (length xs /= n)
lengthAtLeast :: [a] -> Int -> Bool Source #
(lengthAtLeast xs n) = (length xs >= n)
lengthAtMost :: [a] -> Int -> Bool Source #
(lengthAtMost xs n) = (length xs <= n)
lengthLessThan :: [a] -> Int -> Bool Source #
(lengthLessThan xs n) == (length xs < n)
listLengthCmp :: [a] -> Int -> Ordering Source #
atLength :: ([a] -> b) -> b -> [a] -> Int -> b Source #
atLength atLen atEnd ls n
unravels list ls
to position n
. Precisely:
atLength atLenPred atEndPred ls n | n < 0 = atLenPred ls | length ls < n = atEndPred (n - length ls) | otherwise = atLenPred (drop n ls)
equalLength :: [a] -> [b] -> Bool Source #
True if length xs == length ys
compareLength :: [a] -> [b] -> Ordering Source #
isSingleton :: [a] -> Bool Source #
snocView :: [a] -> Maybe ([a], a) Source #
Split a list into its last element and the initial part of the list.
snocView xs = Just (init xs, last xs)
for non-empty lists.
snocView xs = Nothing
otherwise.
Unless both parts of the result are guaranteed to be used
prefer separate calls to last
+ init
.
If you are guaranteed to use both, this will
be more efficient.
changeLast :: [a] -> a -> [a] Source #
Replace the last element of a list with another element.
mapLastM :: Functor f => (a -> f a) -> [a] -> f [a] Source #
Apply an effectful function to the last list element. Assumes a non-empty list (panics otherwise).
whenNonEmpty :: Applicative m => [a] -> (NonEmpty a -> m ()) -> m () Source #
mergeListsBy :: forall a. (a -> a -> Ordering) -> [[a]] -> [a] Source #
Merge an unsorted list of sorted lists, for example:
mergeListsBy compare [ [2,5,15], [1,10,100] ] = [1,2,5,10,15,100]
\( O(n \log{} k) \)
isSortedBy :: (a -> a -> Ordering) -> [a] -> Bool Source #
Tuples
List operations controlled by another list
splitAtList :: [b] -> [a] -> ([a], [a]) Source #
capitalise :: String -> String Source #
Convert a word to title case by capitalising the first letter
Sorting
sortWith :: Ord b => (a -> b) -> [a] -> [a] Source #
The sortWith
function sorts a list of elements using the
user supplied function to project something out of each element
Comparisons
removeSpaces :: String -> String Source #
Edit distance
fuzzyLookup :: String -> [(String, a)] -> [a] Source #
Search for possible matches to the users input in the given list, returning a small number of ranked results
Transitive closures
transitiveClosure :: (a -> [a]) -> (a -> a -> Bool) -> [a] -> [a] Source #
Strictness
Module names
looksLikeModuleName :: String -> Bool Source #
looksLikePackageName :: String -> Bool Source #
Argument processing
Integers
Floating point
readRational :: String -> Rational Source #
readHexRational :: String -> Rational Source #
IO-ish utilities
Filenames and paths
escapeSpaces :: String -> String Source #
Utils for defining Data instances
abstractConstr :: String -> Constr Source #
abstractDataType :: String -> DataType Source #
mkNoRepType :: String -> DataType Source #
Constructs a non-representation for a non-representable type
Utils for printing C code
Hashing
hashString :: String -> Int32 Source #
A sample hash function for Strings. We keep multiplying by the golden ratio and adding. The implementation is:
hashString = foldl' f golden where f m c = fromIntegral (ord c) * magic + hashInt32 m magic = 0xdeadbeef
Where hashInt32 works just as hashInt shown above.
Knuth argues that repeated multiplication by the golden ratio will minimize gaps in the hash space, and thus it's a good choice for combining together multiple keys to form one.
Here we know that individual characters c are often small, and this produces frequent collisions if we use ord c alone. A particular problem are the shorter low ASCII and ISO-8859-1 character strings. We pre-multiply by a magic twiddle factor to obtain a good distribution. In fact, given the following test:
testp :: Int32 -> Int testp k = (n - ) . length . group . sort . map hs . take n $ ls where ls = [] : [c : l | l <- ls, c <- ['\0'..'\xff']] hs = foldl' f golden f m c = fromIntegral (ord c) * k + hashInt32 m n = 100000
We discover that testp magic = 0.
Call stacks
type HasCallStack = ?callStack :: CallStack Source #
Request a CallStack.
NOTE: The implicit parameter ?callStack :: CallStack
is an
implementation detail and should not be considered part of the
CallStack
API, we may decide to change the implementation in the
future.
Since: base-4.9.0.0
type HasDebugCallStack = (() :: Constraint) Source #
A call stack constraint, but only when isDebugOn
.
Utils for flags
data OverridingBool Source #
Instances
Show OverridingBool # | |
Defined in GHC.Utils.Misc |
overrideWith :: Bool -> OverridingBool -> Bool Source #