Modulesop-extras-0.4.1.1Haskell2010

Data.SOP.OptNP

NP with optional values

Intended for qualified import

import           Data.SOP.OptNP (OptNP (..), ViewOptNP (..))
import qualified Data.SOP.OptNP as OptNP

3 types
11 values

Packagesop-extras-0.4.1.1
Exports14
LanguageHaskell2010
LicenceApache-2.0
SourceOptNP.hs

typetype NonEmptyOptNP = OptNP 'False

datadata OptNP (empty :: Bool) (f :: k -> Type) (xs :: [k]) where

Like an NP, but with optional values

Constructors

OptNil :: OptNP 'True f '[]
OptCons :: !f x -> !OptNP empty1 f xs1 -> OptNP 'False f (x ': xs1)
OptSkip :: !OptNP empty f xs1 -> OptNP empty f (x ': xs1)

Instances10HTrans, HAp, HSequence, HTraverse_, Eq, Show, …

HTrans (OptNP empty) (OptNP empty)Defined in sop-extras-0.4.1.1 · Data.SOP.OptNP
HAp (OptNP empty)Defined in sop-extras-0.4.1.1 · Data.SOP.OptNP
HSequence (OptNP empty)Defined in sop-extras-0.4.1.1 · Data.SOP.OptNP
HTraverse_ (OptNP empty)Defined in sop-extras-0.4.1.1 · Data.SOP.OptNP
All (Compose Eq f) xs => Eq (OptNP empty f xs)Defined in sop-extras-0.4.1.1 · Data.SOP.OptNP
All (Compose Show f) xs => Show (OptNP empty f xs)Defined in sop-extras-0.4.1.1 · Data.SOP.OptNP
type Prod (OptNP empty) = NPDefined in sop-extras-0.4.1.1 · Data.SOP.OptNP
type AllN (OptNP empty) c = All cDefined in sop-extras-0.4.1.1 · Data.SOP.OptNP
type Same (OptNP empty) = OptNP emptyDefined in sop-extras-0.4.1.1 · Data.SOP.OptNP
type SListIN (OptNP empty) = SListIDefined in sop-extras-0.4.1.1 · Data.SOP.OptNP

valueat :: SListI xs => f x -> Index xs x -> NonEmptyOptNP f xs

valueempty :: SListI xs => OptNP 'True f xs

valuefromNP :: (forall (empty :: Bool). OptNP empty f xs -> r) -> NP f xs -> r

valuefromNonEmptyNP :: IsNonEmpty xs => NP f xs -> NonEmptyOptNP f xs

valuefromSingleton :: NonEmptyOptNP f '[x] -> f x

If OptNP is not empty, it must contain at least one value

valuesingleton :: f x -> NonEmptyOptNP f '[x]

valuetoNP :: OptNP empty f xs -> NP (Maybe :.: f) xs

View

2 declarations

datadata ViewOptNP (f :: k -> Type) (xs :: [k]) where

Constructors

OptNP_ExactlyOne :: f x -> ViewOptNP f '[x]
OptNP_AtLeastTwo :: ViewOptNP f (x ': y ': zs)

valueview :: NonEmptyOptNP f xs -> ViewOptNP f xs

Combining

3 declarations

valuecombine

:: (SListI xs, HasCallStack)
=> Maybe (NonEmptyOptNP f xs)
-> Maybe (NonEmptyOptNP f xs)
-> Maybe (NonEmptyOptNP f xs)

Precondition: there is no overlap between the two given lists: if there is a Just at a given position in one, it must be Nothing at the same position in the other.

valuecombineWith

:: SListI xs
=> forall a. These1 f g a -> h a
-> Maybe (NonEmptyOptNP f xs)
-> Maybe (NonEmptyOptNP g xs)
-> Maybe (NonEmptyOptNP h xs)

valuezipWith

:: forall a. These1 f g a -> h a
-> NonEmptyOptNP f xs
-> NonEmptyOptNP g xs
-> NonEmptyOptNP h xs