Data.Rg

Documentation

class Rg rg where

Rg acts a bit like a Bounded Enum, but the size of the enumeration can be dynamically determined from each value in the type (see sizeRg)

Minimal complete definition

sizeRg, toRg, fromRg

Methods

sizeRg :: rg -> Int

the number of values in the enumeration; sizeRg sz > 0

toRg :: rg -> Int -> Maybe rg

the nth item in the enumeration (first is 0)

fromRg :: rg -> Int

place in the enumation (first is 0)

minRg :: rg -> rg

first item in the enumeration

maxRg :: rg -> rg

last item in the enumeration

succRg :: rg -> Maybe rg

next item in the enumeration (Nothing if already last)

predRg :: rg -> Maybe rg

previous item in the enumeration (Nothing if already first)

allListRg :: rg -> [rg]

list given items in the enumeration

listRg :: rg -> [Int] -> [rg]

list given items in the enumeration, stopping as soon as an index is out of range

allVectorRg :: rg -> [rg]

list given items in the enumeration as a Vector

vectorRg :: rg -> [Int] -> Vector rg

list the items in the enumeration as a Vector, stopping as soon as an index is out of range

Instances

Rg (Range a)

Defined in Data.Rg

Methods

sizeRg :: Range a -> Int

toRg :: Range a -> Int -> Maybe (Range a)

fromRg :: Range a -> Int

minRg :: Range a -> Range a

maxRg :: Range a -> Range a

succRg :: Range a -> Maybe (Range a)

predRg :: Range a -> Maybe (Range a)

allListRg :: Range a -> [Range a]

listRg :: Range a -> [Int] -> [Range a]

allVectorRg :: Range a -> [Range a]

vectorRg :: Range a -> [Int] -> Vector (Range a)

(Bounded i, Enum i) => Rg (BE i)

Defined in Data.Rg

Methods

sizeRg :: BE i -> Int

toRg :: BE i -> Int -> Maybe (BE i)

fromRg :: BE i -> Int

minRg :: BE i -> BE i

maxRg :: BE i -> BE i

succRg :: BE i -> Maybe (BE i)

predRg :: BE i -> Maybe (BE i)

allListRg :: BE i -> [BE i]

listRg :: BE i -> [Int] -> [BE i]

allVectorRg :: BE i -> [BE i]

vectorRg :: BE i -> [Int] -> Vector (BE i)

class (Rg e, Buildable e, Eq e, Ord e, Show e) => RgText e where

a class in which we can build things and parse them from Text

Minimal complete definition

Nothing

Methods

parseRgText :: e -> Text -> Possibly e

newtype BE a

a newtype wrapper used for deriving Rg instances from Bounded Enum

Constructors

BE

Fields

• _BE :: a

Instances

Bounded a => Bounded (BE a)

Defined in Data.Rg

Methods

minBound :: BE a

maxBound :: BE a

Enum a => Enum (BE a)

Defined in Data.Rg

Methods

succ :: BE a -> BE a

pred :: BE a -> BE a

toEnum :: Int -> BE a

fromEnum :: BE a -> Int

enumFrom :: BE a -> [BE a]

enumFromThen :: BE a -> BE a -> [BE a]

enumFromTo :: BE a -> BE a -> [BE a]

enumFromThenTo :: BE a -> BE a -> BE a -> [BE a]

Eq a => Eq (BE a)

Defined in Data.Rg

Methods

(==) :: BE a -> BE a -> Bool

(/=) :: BE a -> BE a -> Bool

Ord a => Ord (BE a)

Defined in Data.Rg

Methods

compare :: BE a -> BE a -> Ordering

(<) :: BE a -> BE a -> Bool

(<=) :: BE a -> BE a -> Bool

(>) :: BE a -> BE a -> Bool

(>=) :: BE a -> BE a -> Bool

max :: BE a -> BE a -> BE a

min :: BE a -> BE a -> BE a

Show a => Show (BE a)

Defined in Data.Rg

Methods

showsPrec :: Int -> BE a -> ShowS

show :: BE a -> String

showList :: [BE a] -> ShowS

(Bounded i, Enum i) => Rg (BE i)

Defined in Data.Rg

Methods

sizeRg :: BE i -> Int

toRg :: BE i -> Int -> Maybe (BE i)

fromRg :: BE i -> Int

minRg :: BE i -> BE i

maxRg :: BE i -> BE i

succRg :: BE i -> Maybe (BE i)

predRg :: BE i -> Maybe (BE i)

allListRg :: BE i -> [BE i]

listRg :: BE i -> [Int] -> [BE i]

allVectorRg :: BE i -> [BE i]

vectorRg :: BE i -> [Int] -> Vector (BE i)

data Range a

used to generate Rg values from lists of things

Instances

Show a => Show (Range a)

Defined in Data.Rg

Methods

showsPrec :: Int -> Range a -> ShowS

show :: Range a -> String

showList :: [Range a] -> ShowS

Rg (Range a)

Defined in Data.Rg

Methods

sizeRg :: Range a -> Int

toRg :: Range a -> Int -> Maybe (Range a)

fromRg :: Range a -> Int

minRg :: Range a -> Range a

maxRg :: Range a -> Range a

succRg :: Range a -> Maybe (Range a)

predRg :: Range a -> Maybe (Range a)

allListRg :: Range a -> [Range a]

listRg :: Range a -> [Int] -> [Range a]

allVectorRg :: Range a -> [Range a]

vectorRg :: Range a -> [Int] -> Vector (Range a)

newStartOfRangeFromList :: [a] -> Range a

generating a Range from a list

newStartOfRangeFromVector :: Vector a -> Range a

generating a Range from a Vector

extractRange :: Range a -> a

extracting the thing