GHC.Arr

base-4.14.3.0: Basic libraries

Copyright | (c) The University of Glasgow 1994-2000
License | see libraries/base/LICENSE
Maintainer | cvs-ghc@haskell.org
Stability | internal
Portability | non-portable (GHC extensions)
Safe Haskell | Unsafe
Language | Haskell2010

GHC.Arr

Contents

- Unsafe operations

Description

GHC's array implementation.

Synopsis

- class Ord a => Ix a where
  - range :: (a, a) -> [a]
  - index :: (a, a) -> a -> Int
  - unsafeIndex :: (a, a) -> a -> Int
  - inRange :: (a, a) -> a -> Bool
  - rangeSize :: (a, a) -> Int
  - unsafeRangeSize :: (a, a) -> Int
- data Array i e = Array !i !i !Int (Array# e)
- data STArray s i e = STArray !i !i !Int (MutableArray# s e)
- arrEleBottom :: a
- array :: Ix i => (i, i) -> [(i, e)] -> Array i e
- listArray :: Ix i => (i, i) -> [e] -> Array i e
- (!) :: Ix i => Array i e -> i -> e
- safeRangeSize :: Ix i => (i, i) -> Int
- negRange :: Int
- safeIndex :: Ix i => (i, i) -> Int -> i -> Int
- badSafeIndex :: Int -> Int -> Int
- bounds :: Array i e -> (i, i)
- numElements :: Array i e -> Int
- numElementsSTArray :: STArray s i e -> Int
- indices :: Ix i => Array i e -> [i]
- elems :: Array i e -> [e]
- assocs :: Ix i => Array i e -> [(i, e)]
- accumArray :: Ix i => (e -> a -> e) -> e -> (i, i) -> [(i, a)] -> Array i e
- adjust :: (e -> a -> e) -> MutableArray# s e -> (Int, a) -> STRep s b -> STRep s b
- (//) :: Ix i => Array i e -> [(i, e)] -> Array i e
- accum :: Ix i => (e -> a -> e) -> Array i e -> [(i, a)] -> Array i e
- amap :: (a -> b) -> Array i a -> Array i b
- ixmap :: (Ix i, Ix j) => (i, i) -> (i -> j) -> Array j e -> Array i e
- eqArray :: (Ix i, Eq e) => Array i e -> Array i e -> Bool
- cmpArray :: (Ix i, Ord e) => Array i e -> Array i e -> Ordering
- cmpIntArray :: Ord e => Array Int e -> Array Int e -> Ordering
- newSTArray :: Ix i => (i, i) -> e -> ST s (STArray s i e)
- boundsSTArray :: STArray s i e -> (i, i)
- readSTArray :: Ix i => STArray s i e -> i -> ST s e
- writeSTArray :: Ix i => STArray s i e -> i -> e -> ST s ()
- freezeSTArray :: STArray s i e -> ST s (Array i e)
- thawSTArray :: Array i e -> ST s (STArray s i e)
- foldlElems :: (b -> a -> b) -> b -> Array i a -> b
- foldlElems' :: (b -> a -> b) -> b -> Array i a -> b
- foldl1Elems :: (a -> a -> a) -> Array i a -> a
- foldrElems :: (a -> b -> b) -> b -> Array i a -> b
- foldrElems' :: (a -> b -> b) -> b -> Array i a -> b
- foldr1Elems :: (a -> a -> a) -> Array i a -> a
- fill :: MutableArray# s e -> (Int, e) -> STRep s a -> STRep s a
- done :: i -> i -> Int -> MutableArray# s e -> STRep s (Array i e)
- unsafeArray :: Ix i => (i, i) -> [(Int, e)] -> Array i e
- unsafeArray' :: (i, i) -> Int -> [(Int, e)] -> Array i e
- lessSafeIndex :: Ix i => (i, i) -> Int -> i -> Int
- unsafeAt :: Array i e -> Int -> e
- unsafeReplace :: Array i e -> [(Int, e)] -> Array i e
- unsafeAccumArray :: Ix i => (e -> a -> e) -> e -> (i, i) -> [(Int, a)] -> Array i e
- unsafeAccumArray' :: (e -> a -> e) -> e -> (i, i) -> Int -> [(Int, a)] -> Array i e
- unsafeAccum :: (e -> a -> e) -> Array i e -> [(Int, a)] -> Array i e
- unsafeReadSTArray :: STArray s i e -> Int -> ST s e
- unsafeWriteSTArray :: STArray s i e -> Int -> e -> ST s ()
- unsafeFreezeSTArray :: STArray s i e -> ST s (Array i e)
- unsafeThawSTArray :: Array i e -> ST s (STArray s i e)

# Documentation

class Ord a => Ix a where Source #

The `Ix` class is used to map a contiguous subrange of values in a type onto integers. It is used primarily for array indexing (see the array package).

The first argument `(l,u)` of each of these operations is a pair specifying the lower and upper bounds of a contiguous subrange of values.

An implementation is entitled to assume the following laws about these operations:

- ``inRange` (l,u) i == `elem` i (`range` (l,u))` ``
- ``range` (l,u) `!!` `index` (l,u) i == i`, when ``inRange` (l,u) i`
- ``map` (`index` (l,u)) (`range` (l,u))) == [0..`rangeSize` (l,u)-1]` ``
- ``rangeSize` (l,u) == `length` (`range` (l,u))` ``

Minimal complete definition

range, (index | unsafeIndex), inRange

Methods

range :: (a, a) -> [a] Source #

The list of values in the subrange defined by a bounding pair.

index :: (a, a) -> a -> Int Source #

The position of a subscript in the subrange.

unsafeIndex :: (a, a) -> a -> Int Source #

Like `index`, but without checking that the value is in range.

inRange :: (a, a) -> a -> Bool Source #

Returns `True` the given subscript lies in the range defined the bounding pair.

rangeSize :: (a, a) -> Int Source #

The size of the subrange defined by a bounding pair.

unsafeRangeSize :: (a, a) -> Int Source #

like `rangeSize`, but without checking that the upper bound is in range.

#### Instances

Instances details

Ix Bool # | Since: base-2.1
Instance details Defined in GHC.Ix Methods range :: (Bool, Bool) -> [Bool] Source # index :: (Bool, Bool) -> Bool -> Int Source # unsafeIndex :: (Bool, Bool) -> Bool -> Int Source # inRange :: (Bool, Bool) -> Bool -> Bool Source # rangeSize :: (Bool, Bool) -> Int Source # unsafeRangeSize :: (Bool, Bool) -> Int Source #
Ix Char # | Since: base-2.1
Instance details Defined in GHC.Ix Methods range :: (Char, Char) -> [Char] Source # index :: (Char, Char) -> Char -> Int Source # unsafeIndex :: (Char, Char) -> Char -> Int Source # inRange :: (Char, Char) -> Char -> Bool Source # rangeSize :: (Char, Char) -> Int Source # unsafeRangeSize :: (Char, Char) -> Int Source #
Ix Int # | Since: base-2.1
Instance details Defined in GHC.Ix Methods range :: (Int, Int) -> [Int] Source # index :: (Int, Int) -> Int -> Int Source # unsafeIndex :: (Int, Int) -> Int -> Int Source # inRange :: (Int, Int) -> Int -> Bool Source # rangeSize :: (Int, Int) -> Int Source # unsafeRangeSize :: (Int, Int) -> Int Source #
Ix Int8 # | Since: base-2.1
Instance details Defined in GHC.Int Methods range :: (Int8, Int8) -> [Int8] Source # index :: (Int8, Int8) -> Int8 -> Int Source # unsafeIndex :: (Int8, Int8) -> Int8 -> Int Source # inRange :: (Int8, Int8) -> Int8 -> Bool Source # rangeSize :: (Int8, Int8) -> Int Source # unsafeRangeSize :: (Int8, Int8) -> Int Source #
Ix Int16 # | Since: base-2.1
Instance details Defined in GHC.Int Methods range :: (Int16, Int16) -> [Int16] Source # index :: (Int16, Int16) -> Int16 -> Int Source # unsafeIndex :: (Int16, Int16) -> Int16 -> Int Source # inRange :: (Int16, Int16) -> Int16 -> Bool Source # rangeSize :: (Int16, Int16) -> Int Source # unsafeRangeSize :: (Int16, Int16) -> Int Source #
Ix Int32 # | Since: base-2.1
Instance details Defined in GHC.Int Methods range :: (Int32, Int32) -> [Int32] Source # index :: (Int32, Int32) -> Int32 -> Int Source # unsafeIndex :: (Int32, Int32) -> Int32 -> Int Source # inRange :: (Int32, Int32) -> Int32 -> Bool Source # rangeSize :: (Int32, Int32) -> Int Source # unsafeRangeSize :: (Int32, Int32) -> Int Source #
Ix Int64 # | Since: base-2.1
Instance details Defined in GHC.Int Methods range :: (Int64, Int64) -> [Int64] Source # index :: (Int64, Int64) -> Int64 -> Int Source # unsafeIndex :: (Int64, Int64) -> Int64 -> Int Source # inRange :: (Int64, Int64) -> Int64 -> Bool Source # rangeSize :: (Int64, Int64) -> Int Source # unsafeRangeSize :: (Int64, Int64) -> Int Source #
Ix Integer # | Since: base-2.1
Instance details Defined in GHC.Ix Methods range :: (Integer, Integer) -> [Integer] Source # index :: (Integer, Integer) -> Integer -> Int Source # unsafeIndex :: (Integer, Integer) -> Integer -> Int Source # inRange :: (Integer, Integer) -> Integer -> Bool Source # rangeSize :: (Integer, Integer) -> Int Source # unsafeRangeSize :: (Integer, Integer) -> Int Source #
Ix Natural # | Since: base-4.8.0.0
Instance details Defined in GHC.Ix Methods range :: (Natural, Natural) -> [Natural] Source # index :: (Natural, Natural) -> Natural -> Int Source # unsafeIndex :: (Natural, Natural) -> Natural -> Int Source # inRange :: (Natural, Natural) -> Natural -> Bool Source # rangeSize :: (Natural, Natural) -> Int Source # unsafeRangeSize :: (Natural, Natural) -> Int Source #
Ix Ordering # | Since: base-2.1
Instance details Defined in GHC.Ix Methods range :: (Ordering, Ordering) -> [Ordering] Source # index :: (Ordering, Ordering) -> Ordering -> Int Source # unsafeIndex :: (Ordering, Ordering) -> Ordering -> Int Source # inRange :: (Ordering, Ordering) -> Ordering -> Bool Source # rangeSize :: (Ordering, Ordering) -> Int Source # unsafeRangeSize :: (Ordering, Ordering) -> Int Source #
Ix Word # | Since: base-4.6.0.0
Instance details Defined in GHC.Ix Methods range :: (Word, Word) -> [Word] Source # index :: (Word, Word) -> Word -> Int Source # unsafeIndex :: (Word, Word) -> Word -> Int Source # inRange :: (Word, Word) -> Word -> Bool Source # rangeSize :: (Word, Word) -> Int Source # unsafeRangeSize :: (Word, Word) -> Int Source #
Ix Word8 # | Since: base-2.1
Instance details Defined in GHC.Word Methods range :: (Word8, Word8) -> [Word8] Source # index :: (Word8, Word8) -> Word8 -> Int Source # unsafeIndex :: (Word8, Word8) -> Word8 -> Int Source # inRange :: (Word8, Word8) -> Word8 -> Bool Source # rangeSize :: (Word8, Word8) -> Int Source # unsafeRangeSize :: (Word8, Word8) -> Int Source #
Ix Word16 # | Since: base-2.1
Instance details Defined in GHC.Word Methods range :: (Word16, Word16) -> [Word16] Source # index :: (Word16, Word16) -> Word16 -> Int Source # unsafeIndex :: (Word16, Word16) -> Word16 -> Int Source # inRange :: (Word16, Word16) -> Word16 -> Bool Source # rangeSize :: (Word16, Word16) -> Int Source # unsafeRangeSize :: (Word16, Word16) -> Int Source #
Ix Word32 # | Since: base-2.1
Instance details Defined in GHC.Word Methods range :: (Word32, Word32) -> [Word32] Source # index :: (Word32, Word32) -> Word32 -> Int Source # unsafeIndex :: (Word32, Word32) -> Word32 -> Int Source # inRange :: (Word32, Word32) -> Word32 -> Bool Source # rangeSize :: (Word32, Word32) -> Int Source # unsafeRangeSize :: (Word32, Word32) -> Int Source #
Ix Word64 # | Since: base-2.1
Instance details Defined in GHC.Word Methods range :: (Word64, Word64) -> [Word64] Source # index :: (Word64, Word64) -> Word64 -> Int Source # unsafeIndex :: (Word64, Word64) -> Word64 -> Int Source # inRange :: (Word64, Word64) -> Word64 -> Bool Source # rangeSize :: (Word64, Word64) -> Int Source # unsafeRangeSize :: (Word64, Word64) -> Int Source #
Ix () # | Since: base-2.1
Instance details Defined in GHC.Ix Methods range :: ((), ()) -> [()] Source # index :: ((), ()) -> () -> Int Source # unsafeIndex :: ((), ()) -> () -> Int Source # inRange :: ((), ()) -> () -> Bool Source # rangeSize :: ((), ()) -> Int Source # unsafeRangeSize :: ((), ()) -> Int Source #
Ix GeneralCategory # | Since: base-2.1
Instance details Defined in GHC.Unicode Methods range :: (GeneralCategory, GeneralCategory) -> [GeneralCategory] Source # index :: (GeneralCategory, GeneralCategory) -> GeneralCategory -> Int Source # unsafeIndex :: (GeneralCategory, GeneralCategory) -> GeneralCategory -> Int Source # inRange :: (GeneralCategory, GeneralCategory) -> GeneralCategory -> Bool Source # rangeSize :: (GeneralCategory, GeneralCategory) -> Int Source # unsafeRangeSize :: (GeneralCategory, GeneralCategory) -> Int Source #
Ix IOMode # | Since: base-4.2.0.0
Instance details Defined in GHC.IO.IOMode Methods range :: (IOMode, IOMode) -> [IOMode] Source # index :: (IOMode, IOMode) -> IOMode -> Int Source # unsafeIndex :: (IOMode, IOMode) -> IOMode -> Int Source # inRange :: (IOMode, IOMode) -> IOMode -> Bool Source # rangeSize :: (IOMode, IOMode) -> Int Source # unsafeRangeSize :: (IOMode, IOMode) -> Int Source #
Ix DecidedStrictness # | Since: base-4.9.0.0
Instance details Defined in GHC.Generics Methods range :: (DecidedStrictness, DecidedStrictness) -> [DecidedStrictness] Source # index :: (DecidedStrictness, DecidedStrictness) -> DecidedStrictness -> Int Source # unsafeIndex :: (DecidedStrictness, DecidedStrictness) -> DecidedStrictness -> Int Source # inRange :: (DecidedStrictness, DecidedStrictness) -> DecidedStrictness -> Bool Source # rangeSize :: (DecidedStrictness, DecidedStrictness) -> Int Source # unsafeRangeSize :: (DecidedStrictness, DecidedStrictness) -> Int Source #
Ix SourceStrictness # | Since: base-4.9.0.0
Instance details Defined in GHC.Generics Methods range :: (SourceStrictness, SourceStrictness) -> [SourceStrictness] Source # index :: (SourceStrictness, SourceStrictness) -> SourceStrictness -> Int Source # unsafeIndex :: (SourceStrictness, SourceStrictness) -> SourceStrictness -> Int Source # inRange :: (SourceStrictness, SourceStrictness) -> SourceStrictness -> Bool Source # rangeSize :: (SourceStrictness, SourceStrictness) -> Int Source # unsafeRangeSize :: (SourceStrictness, SourceStrictness) -> Int Source #
Ix SourceUnpackedness # | Since: base-4.9.0.0
Instance details Defined in GHC.Generics Methods range :: (SourceUnpackedness, SourceUnpackedness) -> [SourceUnpackedness] Source # index :: (SourceUnpackedness, SourceUnpackedness) -> SourceUnpackedness -> Int Source # unsafeIndex :: (SourceUnpackedness, SourceUnpackedness) -> SourceUnpackedness -> Int Source # inRange :: (SourceUnpackedness, SourceUnpackedness) -> SourceUnpackedness -> Bool Source # rangeSize :: (SourceUnpackedness, SourceUnpackedness) -> Int Source # unsafeRangeSize :: (SourceUnpackedness, SourceUnpackedness) -> Int Source #
Ix Associativity # | Since: base-4.9.0.0
Instance details Defined in GHC.Generics Methods range :: (Associativity, Associativity) -> [Associativity] Source # index :: (Associativity, Associativity) -> Associativity -> Int Source # unsafeIndex :: (Associativity, Associativity) -> Associativity -> Int Source # inRange :: (Associativity, Associativity) -> Associativity -> Bool Source # rangeSize :: (Associativity, Associativity) -> Int Source # unsafeRangeSize :: (Associativity, Associativity) -> Int Source #
Ix SeekMode # | Since: base-4.2.0.0
Instance details Defined in GHC.IO.Device Methods range :: (SeekMode, SeekMode) -> [SeekMode] Source # index :: (SeekMode, SeekMode) -> SeekMode -> Int Source # unsafeIndex :: (SeekMode, SeekMode) -> SeekMode -> Int Source # inRange :: (SeekMode, SeekMode) -> SeekMode -> Bool Source # rangeSize :: (SeekMode, SeekMode) -> Int Source # unsafeRangeSize :: (SeekMode, SeekMode) -> Int Source #
Ix Void # | Since: base-4.8.0.0
Instance details Defined in Data.Void Methods range :: (Void, Void) -> [Void] Source # index :: (Void, Void) -> Void -> Int Source # unsafeIndex :: (Void, Void) -> Void -> Int Source # inRange :: (Void, Void) -> Void -> Bool Source # rangeSize :: (Void, Void) -> Int Source # unsafeRangeSize :: (Void, Void) -> Int Source #
Ix a => Ix (Down a) # | Since: base-4.14.0.0
Instance details Defined in Data.Ord Methods range :: (Down a, Down a) -> [Down a] Source # index :: (Down a, Down a) -> Down a -> Int Source # unsafeIndex :: (Down a, Down a) -> Down a -> Int Source # inRange :: (Down a, Down a) -> Down a -> Bool Source # rangeSize :: (Down a, Down a) -> Int Source # unsafeRangeSize :: (Down a, Down a) -> Int Source #
Ix a => Ix (Identity a) # | Since: base-4.9.0.0
Instance details Defined in Data.Functor.Identity Methods range :: (Identity a, Identity a) -> [Identity a] Source # index :: (Identity a, Identity a) -> Identity a -> Int Source # unsafeIndex :: (Identity a, Identity a) -> Identity a -> Int Source # inRange :: (Identity a, Identity a) -> Identity a -> Bool Source # rangeSize :: (Identity a, Identity a) -> Int Source # unsafeRangeSize :: (Identity a, Identity a) -> Int Source #
(Ix a, Ix b) => Ix (a, b) # | Since: base-2.1
Instance details Defined in GHC.Ix Methods range :: ((a, b), (a, b)) -> [(a, b)] Source # index :: ((a, b), (a, b)) -> (a, b) -> Int Source # unsafeIndex :: ((a, b), (a, b)) -> (a, b) -> Int Source # inRange :: ((a, b), (a, b)) -> (a, b) -> Bool Source # rangeSize :: ((a, b), (a, b)) -> Int Source # unsafeRangeSize :: ((a, b), (a, b)) -> Int Source #
Ix (Proxy s) # | Since: base-4.7.0.0
Instance details Defined in Data.Proxy Methods range :: (Proxy s, Proxy s) -> [Proxy s] Source # index :: (Proxy s, Proxy s) -> Proxy s -> Int Source # unsafeIndex :: (Proxy s, Proxy s) -> Proxy s -> Int Source # inRange :: (Proxy s, Proxy s) -> Proxy s -> Bool Source # rangeSize :: (Proxy s, Proxy s) -> Int Source # unsafeRangeSize :: (Proxy s, Proxy s) -> Int Source #
(Ix a1, Ix a2, Ix a3) => Ix (a1, a2, a3) # | Since: base-2.1
Instance details Defined in GHC.Ix Methods range :: ((a1, a2, a3), (a1, a2, a3)) -> [(a1, a2, a3)] Source # index :: ((a1, a2, a3), (a1, a2, a3)) -> (a1, a2, a3) -> Int Source # unsafeIndex :: ((a1, a2, a3), (a1, a2, a3)) -> (a1, a2, a3) -> Int Source # inRange :: ((a1, a2, a3), (a1, a2, a3)) -> (a1, a2, a3) -> Bool Source # rangeSize :: ((a1, a2, a3), (a1, a2, a3)) -> Int Source # unsafeRangeSize :: ((a1, a2, a3), (a1, a2, a3)) -> Int Source #
Ix a => Ix (Const a b) # | Since: base-4.9.0.0
Instance details Defined in Data.Functor.Const Methods range :: (Const a b, Const a b) -> [Const a b] Source # index :: (Const a b, Const a b) -> Const a b -> Int Source # unsafeIndex :: (Const a b, Const a b) -> Const a b -> Int Source # inRange :: (Const a b, Const a b) -> Const a b -> Bool Source # rangeSize :: (Const a b, Const a b) -> Int Source # unsafeRangeSize :: (Const a b, Const a b) -> Int Source #
(Ix a1, Ix a2, Ix a3, Ix a4) => Ix (a1, a2, a3, a4) # | Since: base-2.1
Instance details Defined in GHC.Ix Methods range :: ((a1, a2, a3, a4), (a1, a2, a3, a4)) -> [(a1, a2, a3, a4)] Source # index :: ((a1, a2, a3, a4), (a1, a2, a3, a4)) -> (a1, a2, a3, a4) -> Int Source # unsafeIndex :: ((a1, a2, a3, a4), (a1, a2, a3, a4)) -> (a1, a2, a3, a4) -> Int Source # inRange :: ((a1, a2, a3, a4), (a1, a2, a3, a4)) -> (a1, a2, a3, a4) -> Bool Source # rangeSize :: ((a1, a2, a3, a4), (a1, a2, a3, a4)) -> Int Source # unsafeRangeSize :: ((a1, a2, a3, a4), (a1, a2, a3, a4)) -> Int Source #
(Ix a1, Ix a2, Ix a3, Ix a4, Ix a5) => Ix (a1, a2, a3, a4, a5) # | Since: base-2.1
Instance details Defined in GHC.Ix Methods range :: ((a1, a2, a3, a4, a5), (a1, a2, a3, a4, a5)) -> [(a1, a2, a3, a4, a5)] Source # index :: ((a1, a2, a3, a4, a5), (a1, a2, a3, a4, a5)) -> (a1, a2, a3, a4, a5) -> Int Source # unsafeIndex :: ((a1, a2, a3, a4, a5), (a1, a2, a3, a4, a5)) -> (a1, a2, a3, a4, a5) -> Int Source # inRange :: ((a1, a2, a3, a4, a5), (a1, a2, a3, a4, a5)) -> (a1, a2, a3, a4, a5) -> Bool Source # rangeSize :: ((a1, a2, a3, a4, a5), (a1, a2, a3, a4, a5)) -> Int Source # unsafeRangeSize :: ((a1, a2, a3, a4, a5), (a1, a2, a3, a4, a5)) -> Int Source #

data Array i e Source #

The type of immutable non-strict (boxed) arrays with indices in `i` and elements in `e`.

Constructors

Array !i !i !Int (Array# e) |

#### Instances

Instances details

Functor (Array i) # | Since: base-2.1
Instance details Defined in GHC.Arr Methods fmap :: (a -> b) -> Array i a -> Array i b Source # (<$) :: a -> Array i b -> Array i a Source #
Foldable (Array i) # | Since: base-4.8.0.0
Instance details Defined in Data.Foldable Methods fold :: Monoid m => Array i m -> m Source # foldMap :: Monoid m => (a -> m) -> Array i a -> m Source # foldMap' :: Monoid m => (a -> m) -> Array i a -> m Source # foldr :: (a -> b -> b) -> b -> Array i a -> b Source # foldr' :: (a -> b -> b) -> b -> Array i a -> b Source # foldl :: (b -> a -> b) -> b -> Array i a -> b Source # foldl' :: (b -> a -> b) -> b -> Array i a -> b Source # foldr1 :: (a -> a -> a) -> Array i a -> a Source # foldl1 :: (a -> a -> a) -> Array i a -> a Source # toList :: Array i a -> [a] Source # null :: Array i a -> Bool Source # length :: Array i a -> Int Source # elem :: Eq a => a -> Array i a -> Bool Source # maximum :: Ord a => Array i a -> a Source # minimum :: Ord a => Array i a -> a Source # sum :: Num a => Array i a -> a Source # product :: Num a => Array i a -> a Source #
Ix i => Traversable (Array i) # | Since: base-2.1
Instance details Defined in Data.Traversable Methods traverse :: Applicative f => (a -> f b) -> Array i a -> f (Array i b) Source # sequenceA :: Applicative f => Array i (f a) -> f (Array i a) Source # mapM :: Monad m => (a -> m b) -> Array i a -> m (Array i b) Source # sequence :: Monad m => Array i (m a) -> m (Array i a) Source #
(Ix i, Eq e) => Eq (Array i e) # | Since: base-2.1
Instance details Defined in GHC.Arr Methods (==) :: Array i e -> Array i e -> Bool Source # (/=) :: Array i e -> Array i e -> Bool Source #
(Data a, Data b, Ix a) => Data (Array a b) # | Since: base-4.8.0.0
Instance details Defined in Data.Data Methods gfoldl :: (forall d b0. Data d => c (d -> b0) -> d -> c b0) -> (forall g. g -> c g) -> Array a b -> c (Array a b) Source # gunfold :: (forall b0 r. Data b0 => c (b0 -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (Array a b) Source # toConstr :: Array a b -> Constr Source # dataTypeOf :: Array a b -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (Array a b)) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (Array a b)) Source # gmapT :: (forall b0. Data b0 => b0 -> b0) -> Array a b -> Array a b Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Array a b -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Array a b -> r Source # gmapQ :: (forall d. Data d => d -> u) -> Array a b -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> Array a b -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Array a b -> m (Array a b) Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Array a b -> m (Array a b) Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Array a b -> m (Array a b) Source #
(Ix i, Ord e) => Ord (Array i e) # | Since: base-2.1
Instance details Defined in GHC.Arr Methods compare :: Array i e -> Array i e -> Ordering Source # (<) :: Array i e -> Array i e -> Bool Source # (<=) :: Array i e -> Array i e -> Bool Source # (>) :: Array i e -> Array i e -> Bool Source # (>=) :: Array i e -> Array i e -> Bool Source # max :: Array i e -> Array i e -> Array i e Source # min :: Array i e -> Array i e -> Array i e Source #
(Ix a, Read a, Read b) => Read (Array a b) # | Since: base-2.1
Instance details Defined in GHC.Read Methods readsPrec :: Int -> ReadS (Array a b) Source # readList :: ReadS [Array a b] Source # readPrec :: ReadPrec (Array a b) Source # readListPrec :: ReadPrec [Array a b] Source #
(Ix a, Show a, Show b) => Show (Array a b) # | Since: base-2.1
Instance details Defined in GHC.Arr Methods showsPrec :: Int -> Array a b -> ShowS Source # show :: Array a b -> String Source # showList :: [Array a b] -> ShowS Source #

data STArray s i e Source #

Mutable, boxed, non-strict arrays in the `ST` monad. The type arguments are as follows:

- `s`: the state variable argument for the `ST` type
- `i`: the index type of the array (should be an instance of `Ix`)
- `e`: the element type of the array.

Constructors

STArray !i !i !Int (MutableArray# s e) |

#### Instances

Instances details

Eq (STArray s i e) # | Since: base-2.1
Instance details Defined in GHC.Arr Methods (==) :: STArray s i e -> STArray s i e -> Bool Source # (/=) :: STArray s i e -> STArray s i e -> Bool Source #

arrEleBottom :: a Source #

array Source #

Arguments

:: Ix i |
=> (i, i) | a pair of bounds, each of the index type of the array. These bounds are the lowest and highest indices in the array, in that order. For example, a one-origin vector of length `10` has bounds `(1,10)`, and a one-origin `10` by `10` matrix has bounds `((1,1),(10,10))`.
-> [(i, e)] | a list of associations of the form (index, value). Typically, this list will be expressed as a comprehension. An association `(i, x)` defines the value of the array at index `i` to be `x`.
-> Array i e |

Construct an array with the specified bounds and containing values for given indices within these bounds.

The array is undefined (i.e. bottom) if any index in the list is out of bounds. The Haskell 2010 Report further specifies that if any two associations in the list have the same index, the value at that index is undefined (i.e. bottom). However in GHC's implementation, the value at such an index is the value part of the last association with that index in the list.

Because the indices must be checked for these errors, `array` is strict in the bounds argument and in the indices of the association list, but non-strict in the values. Thus, recurrences such as the following are possible:

    a = array (1,100) ((1,1) : [(i, i * a!(i-1)) | i <- [2..100]])

Not every index within the bounds of the array need appear in the association list, but the values associated with indices that do not appear will be undefined (i.e. bottom).

If, in any dimension, the lower bound is greater than the upper bound, then the array is legal, but empty. Indexing an empty array always gives an array-bounds error, but `bounds` still yields the bounds with which the array was constructed.

listArray :: Ix i => (i, i) -> [e] -> Array i e Source #

Construct an array from a pair of bounds and a list of values in index order.

(!) :: Ix i => Array i e -> i -> e infixl 9 Source #

The value at the given index in an array.

safeRangeSize :: Ix i => (i, i) -> Int Source #

negRange :: Int Source #

safeIndex :: Ix i => (i, i) -> Int -> i -> Int Source #

badSafeIndex :: Int -> Int -> Int Source #

bounds :: Array i e -> (i, i) Source #

The bounds with which an array was constructed.

numElements :: Array i e -> Int Source #

The number of elements in the array.

numElementsSTArray :: STArray s i e -> Int Source #

indices :: Ix i => Array i e -> [i] Source #

The list of indices of an array in ascending order.

elems :: Array i e -> [e] Source #

The list of elements of an array in index order.

assocs :: Ix i => Array i e -> [(i, e)] Source #

The list of associations of an array in index order.

accumArray Source #

Arguments

:: Ix i |
=> (e -> a -> e) | accumulating function
-> e | initial value
-> (i, i) | bounds of the array
-> [(i, a)] | association list
-> Array i e |

The `accumArray` function deals with repeated indices in the association list using an accumulating function which combines the values of associations with the same index.

For example, given a list of values of some index type, `hist` produces a histogram of the number of occurrences of each index within a specified range:

    hist :: (Ix a, Num b) => (a,a) -> [a] -> Array a b
    hist bnds is = accumArray (+) 0 bnds [(i, 1) | i<-is, inRange bnds i]

`accumArray` is strict in each result of applying the accumulating function, although it is lazy in the initial value. Thus, unlike arrays built with `array`, accumulated arrays should not in general be recursive.

adjust :: (e -> a -> e) -> MutableArray# s e -> (Int, a) -> STRep s b -> STRep s b Source #

(//) :: Ix i => Array i e -> [(i, e)] -> Array i e infixl 9 Source #

Constructs an array identical to the first argument except that it has been updated by the associations in the right argument. For example, if `m` is a 1-origin, `n` by `n` matrix, then

    m//[((i,i), 0) | i <- [1..n]]

is the same matrix, except with the diagonal zeroed.

Repeated indices in the association list are handled as for `array`: Haskell 2010 specifies that the resulting array is undefined (i.e. bottom), but GHC's implementation uses the last association for each index.

accum :: Ix i => (e -> a -> e) -> Array i e -> [(i, a)] -> Array i e Source #

``accum` f` takes an array and an association list and accumulates pairs from the list into the array with the accumulating function `f`. Thus `accumArray` can be defined using `accum`:

    accumArray f z b = accum f (array b [(i, z) | i <- range b])

`accum` is strict in all the results of applying the accumulation. However, it is lazy in the initial values of the array.

amap :: (a -> b) -> Array i a -> Array i b Source #

ixmap :: (Ix i, Ix j) => (i, i) -> (i -> j) -> Array j e -> Array i e Source #

`ixmap` allows for transformations on array indices. It may be thought of as providing function composition on the right with the mapping that the original array embodies.

A similar transformation of array values may be achieved using `fmap` from the `Array` instance of the `Functor` class.

eqArray :: (Ix i, Eq e) => Array i e -> Array i e -> Bool Source #

cmpArray :: (Ix i, Ord e) => Array i e -> Array i e -> Ordering Source #

cmpIntArray :: Ord e => Array Int e -> Array Int e -> Ordering Source #

newSTArray :: Ix i => (i, i) -> e -> ST s (STArray s i e) Source #

boundsSTArray :: STArray s i e -> (i, i) Source #

readSTArray :: Ix i => STArray s i e -> i -> ST s e Source #

writeSTArray :: Ix i => STArray s i e -> i -> e -> ST s () Source #

freezeSTArray :: STArray s i e -> ST s (Array i e) Source #

thawSTArray :: Array i e -> ST s (STArray s i e) Source #

foldlElems :: (b -> a -> b) -> b -> Array i a -> b Source #

A left fold over the elements

foldlElems' :: (b -> a -> b) -> b -> Array i a -> b Source #

A strict left fold over the elements

foldl1Elems :: (a -> a -> a) -> Array i a -> a Source #

A left fold over the elements with no starting value

foldrElems :: (a -> b -> b) -> b -> Array i a -> b Source #

A right fold over the elements

foldrElems' :: (a -> b -> b) -> b -> Array i a -> b Source #

A strict right fold over the elements

foldr1Elems :: (a -> a -> a) -> Array i a -> a Source #

A right fold over the elements with no starting value

# Unsafe operations

fill :: MutableArray# s e -> (Int, e) -> STRep s a -> STRep s a Source #

done :: i -> i -> Int -> MutableArray# s e -> STRep s (Array i e) Source #

unsafeArray :: Ix i => (i, i) -> [(Int, e)] -> Array i e Source #

unsafeArray' :: (i, i) -> Int -> [(Int, e)] -> Array i e Source #

lessSafeIndex :: Ix i => (i, i) -> Int -> i -> Int Source #

unsafeAt :: Array i e -> Int -> e Source #

unsafeReplace :: Array i e -> [(Int, e)] -> Array i e Source #

unsafeAccumArray :: Ix i => (e -> a -> e) -> e -> (i, i) -> [(Int, a)] -> Array i e Source #

unsafeAccumArray' :: (e -> a -> e) -> e -> (i, i) -> Int -> [(Int, a)] -> Array i e Source #

unsafeAccum :: (e -> a -> e) -> Array i e -> [(Int, a)] -> Array i e Source #

unsafeReadSTArray :: STArray s i e -> Int -> ST s e Source #

unsafeWriteSTArray :: STArray s i e -> Int -> e -> ST s () Source #

unsafeFreezeSTArray :: STArray s i e -> ST s (Array i e) Source #

unsafeThawSTArray :: Array i e -> ST s (STArray s i e) Source #