base-4.11.1.0: Basic libraries

Copyright(c) The University of Glasgow 2001
LicenseBSD-style (see the file libraries/base/LICENSE)
Maintainerlibraries@haskell.org
Stabilitystable
Portabilityportable
Safe HaskellTrustworthy
LanguageHaskell2010

Data.Ix

Contents

Description

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

Synopsis
  • class Ord a => Ix a where

    The Ix class

    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:

    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.

    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.

    Instances
    Ix Bool #

    Since: base-2.1

    Instance details

    Defined in GHC.Arr

    Ix Char #

    Since: base-2.1

    Instance details

    Defined in GHC.Arr

    Ix Int #

    Since: base-2.1

    Instance details

    Defined in GHC.Arr

    Methods

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

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

    unsafeIndex :: (Int, Int) -> Int -> Int

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

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

    unsafeRangeSize :: (Int, Int) -> Int

    Ix Int8 #

    Since: base-2.1

    Instance details

    Defined in GHC.Int

    Ix Int16 #

    Since: base-2.1

    Instance details

    Defined in GHC.Int

    Ix Int32 #

    Since: base-2.1

    Instance details

    Defined in GHC.Int

    Ix Int64 #

    Since: base-2.1

    Instance details

    Defined in GHC.Int

    Ix Integer #

    Since: base-2.1

    Instance details

    Defined in GHC.Arr

    Ix Natural #

    Since: base-4.8.0.0

    Instance details

    Defined in GHC.Natural

    Ix Ordering #

    Since: base-2.1

    Instance details

    Defined in GHC.Arr

    Ix Word #

    Since: base-4.6.0.0

    Instance details

    Defined in GHC.Arr

    Ix Word8 #

    Since: base-2.1

    Instance details

    Defined in GHC.Word

    Ix Word16 #

    Since: base-2.1

    Instance details

    Defined in GHC.Word

    Ix Word32 #

    Since: base-2.1

    Instance details

    Defined in GHC.Word

    Ix Word64 #

    Since: base-2.1

    Instance details

    Defined in GHC.Word

    Ix () #

    Since: base-2.1

    Instance details

    Defined in GHC.Arr

    Methods

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

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

    unsafeIndex :: ((), ()) -> () -> Int

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

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

    unsafeRangeSize :: ((), ()) -> Int

    Ix GeneralCategory # 
    Instance details

    Defined in GHC.Unicode

    Ix IOMode # 
    Instance details

    Defined in GHC.IO.IOMode

    Ix DecidedStrictness # 
    Instance details

    Defined in GHC.Generics

    Ix SourceStrictness # 
    Instance details

    Defined in GHC.Generics

    Ix SourceUnpackedness # 
    Instance details

    Defined in GHC.Generics

    Ix Associativity # 
    Instance details

    Defined in GHC.Generics

    Ix SeekMode # 
    Instance details

    Defined in GHC.IO.Device

    Ix Void #

    Since: base-4.8.0.0

    Instance details

    Defined in Data.Void

    Ix a => Ix (Identity a) # 
    Instance details

    Defined in Data.Functor.Identity

    (Ix a, Ix b) => Ix (a, b) #

    Since: base-2.1

    Instance details

    Defined in GHC.Arr

    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

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

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

    unsafeRangeSize :: ((a, b), (a, b)) -> Int

    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

    inRange :: (Proxy s, Proxy s) -> Proxy s -> Bool Source #

    rangeSize :: (Proxy s, Proxy s) -> Int Source #

    unsafeRangeSize :: (Proxy s, Proxy s) -> Int

    (Ix a1, Ix a2, Ix a3) => Ix (a1, a2, a3) #

    Since: base-2.1

    Instance details

    Defined in GHC.Arr

    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

    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

    Ix a => Ix (Const a b) # 
    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

    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

    (Ix a1, Ix a2, Ix a3, Ix a4) => Ix (a1, a2, a3, a4) #

    Since: base-2.1

    Instance details

    Defined in GHC.Arr

    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

    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

    (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.Arr

    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

    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

    Deriving Instances of Ix

    Derived instance declarations for the class Ix are only possible for enumerations (i.e. datatypes having only nullary constructors) and single-constructor datatypes, including arbitrarily large tuples, whose constituent types are instances of Ix.

    • For an enumeration, the nullary constructors are assumed to be numbered left-to-right with the indices being 0 to n-1 inclusive. This is the same numbering defined by the Enum class. For example, given the datatype:
           data Colour = Red | Orange | Yellow | Green | Blue | Indigo | Violet

    we would have:

           range   (Yellow,Blue)        ==  [Yellow,Green,Blue]
           index   (Yellow,Blue) Green  ==  1
           inRange (Yellow,Blue) Red    ==  False