Data.Pos

core type

data Pos

holds a positive number

Instances

Bounded Pos

Defined in Data.Pos

Methods

minBound :: Pos

maxBound :: Pos

Enum Pos

Enum instance for Pos

Defined in Data.Pos

Methods

succ :: Pos -> Pos

pred :: Pos -> Pos

toEnum :: Int -> Pos

fromEnum :: Pos -> Int

enumFrom :: Pos -> [Pos]

enumFromThen :: Pos -> Pos -> [Pos]

enumFromTo :: Pos -> Pos -> [Pos]

enumFromThenTo :: Pos -> Pos -> Pos -> [Pos]

Eq Pos

Defined in Data.Pos

Methods

(==) :: Pos -> Pos -> Bool

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

Ord Pos

Defined in Data.Pos

Methods

compare :: Pos -> Pos -> Ordering

(<) :: Pos -> Pos -> Bool

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

(>) :: Pos -> Pos -> Bool

(>=) :: Pos -> Pos -> Bool

max :: Pos -> Pos -> Pos

min :: Pos -> Pos -> Pos

Read Pos

Defined in Data.Pos

Methods

readsPrec :: Int -> ReadS Pos

readList :: ReadS [Pos]

readPrec :: ReadPrec Pos

readListPrec :: ReadPrec [Pos]

Show Pos

Defined in Data.Pos

Methods

showsPrec :: Int -> Pos -> ShowS

show :: Pos -> String

showList :: [Pos] -> ShowS

NFData Pos

Defined in Data.Pos

Methods

rnf :: Pos -> ()

destructors

pattern Pos :: Int -> Pos

readonly pattern synonym for Pos

unP :: Pos -> Int

unwrap Pos

constructors

_P :: forall n. PosC n => Pos

construct a valid Pos using a Nat

unsafePos :: HasCallStack => String -> Int -> Pos

try to convert an Int to a Pos

eitherPos :: Int -> Either String Pos

try to convert an Int to a Pos

values

_1P :: Pos

commonly used values for Pos

_2P :: Pos

commonly used values for Pos

_3P :: Pos

commonly used values for Pos

_4P :: Pos

commonly used values for Pos

_5P :: Pos

commonly used values for Pos

_6P :: Pos

commonly used values for Pos

_7P :: Pos

commonly used values for Pos

_8P :: Pos

commonly used values for Pos

_9P :: Pos

commonly used values for Pos

_10P :: Pos

commonly used values for Pos

_11P :: Pos

commonly used values for Pos

_12P :: Pos

commonly used values for Pos

_13P :: Pos

commonly used values for Pos

_14P :: Pos

commonly used values for Pos

_15P :: Pos

commonly used values for Pos

_16P :: Pos

commonly used values for Pos

_17P :: Pos

commonly used values for Pos

_18P :: Pos

commonly used values for Pos

_19P :: Pos

commonly used values for Pos

_20P :: Pos

commonly used values for Pos

arithmetic

(*!) :: Pos -> Pos -> Pos infixl 7

multiply two positive numbers

(+!) :: Pos -> Pos -> Pos infixl 6

add two positive numbers

minusP :: Pos -> Pos -> Either String Pos

subtract two positive numbers

productP :: Foldable t => t Pos -> Pos

product of list of Pos values is always positive

productPInt :: Foldable t => t Pos -> Int

product of list of Pos values is always positive

safeDivP :: Pos -> Pos -> Pos

safely divide Pos values but the result is increased by one to guarantee the result is still positive

divModP :: Int -> Pos -> (Int, Natural)

divMod for Pos returning Natural for the remainder

divModNextP :: Int -> Pos -> (Int, Pos)

divMod for Pos

maxP :: Pos -> Int -> Pos

max of a Pos and an Int

predP :: Pos -> Either String Pos

previous value for Pos

succP :: Pos -> Pos

next value for Pos (not redundant as it is always successful and never partial)

type level

class KnownNat n => PosC n where

constraint for positive numbers

Minimal complete definition

fromNP

Methods

fromNP :: Pos

fromN :: Int

Instances

(KnownNat n, FailUnless (1 <=? n) ('Text "PosC n: requires n >= 1 but found " :<>: 'ShowType n)) => PosC n

Defined in Data.Pos

Methods

fromNP :: Pos

fromN :: Int

class NS ns where

conversion from list of Nats to Positives

Minimal complete definition

fromNSP, nsLengthP

Methods

fromNSP :: NonEmpty Pos

fromNSTotalP :: Pos

nsLengthP :: Pos

Instances

(TypeError ('Text "NS: empty dimensions are not supported") :: Constraint) => NS ('[] :: [Nat])

Defined in Data.Pos

Methods

fromNSP :: NonEmpty Pos

fromNSTotalP :: Pos

nsLengthP :: Pos

(PosC n, NS (n1 ': ns)) => NS (n ': (n1 ': ns))

Defined in Data.Pos

Methods

fromNSP :: NonEmpty Pos

fromNSTotalP :: Pos

nsLengthP :: Pos

PosC n => NS '[n]

Defined in Data.Pos

Methods

fromNSP :: NonEmpty Pos

fromNSTotalP :: Pos

nsLengthP :: Pos

miscellaneous

fromPositives :: Foldable t => t Pos -> [Int]

converts a container of positives to a list of ints

toPositives :: Foldable t => t Int -> Either String (NonEmpty Pos)

converts a list of ints to a nonempty list of positives

posRange :: Int -> Int -> Either String (NonEmpty Pos)

enumerate a nonempty list of Pos from "i" to "j"

parsers

pPositives :: Char -> Char -> ReadP (NonEmpty Pos)

parser for a list of positive numbers as ints

pPos :: ReadP Pos

parser for a Pos

pPosInt :: ReadP Pos

parser for a Pos but just reading in a positive number

pInt :: ReadP Int

parser for an Int