Safe Haskell	None
Language	Haskell2010

Numeric.Data.NonNegative

Contents

Type
Creation
Elimination
Optics

Description

Provides the NonNegative type for enforcing a nonnegative invariant.

Since: 0.1

Synopsis

data NonNegative a where
- pattern MkNonNegative :: a -> NonNegative a
mkNonNegativeTH :: (AMonoid a, Lift a, Ord a, Show a) => a -> Code Q (NonNegative a)
mkNonNegative :: (AMonoid a, Ord a, Show a) => a -> Either String (NonNegative a)
unsafeNonNegative :: (AMonoid a, HasCallStack, Ord a, Show a) => a -> NonNegative a
(*!) :: (AMonoid a, HasCallStack, Ord a, Show a) => a -> NonNegative a
reallyUnsafeNonNegative :: a -> NonNegative a
unNonNegative :: NonNegative a -> a
_MkNonNegative :: (AMonoid a, Ord a, Show a) => ReversedPrism' (NonNegative a) a
rmatching :: (Is (ReversedOptic k) An_AffineTraversal, ReversibleOptic k) => Optic k NoIx b a t s -> s -> Either t a

Type

data NonNegative a where Source #

Newtype wrapper that attaches a NonNegative invariant to some a. NonNegative is a Semifield i.e. supports addition, multiplication, and division.

Since: 0.1

Bundled Patterns

pattern MkNonNegative :: a -> NonNegative a

Unidirectional pattern synonym for NonNegative. This allows us to pattern match on a non-negative term without exposing the unsafe internal details.

Since: 0.1

Instances

Instances details

Foldable NonNegative Source #

Since: 0.1

Instance details

Defined in Numeric.Data.NonNegative.Internal

Methods

fold :: Monoid m => NonNegative m -> m #

foldMap :: Monoid m => (a -> m) -> NonNegative a -> m #

foldMap' :: Monoid m => (a -> m) -> NonNegative a -> m #

foldr :: (a -> b -> b) -> b -> NonNegative a -> b #

foldr' :: (a -> b -> b) -> b -> NonNegative a -> b #

foldl :: (b -> a -> b) -> b -> NonNegative a -> b #

foldl' :: (b -> a -> b) -> b -> NonNegative a -> b #

foldr1 :: (a -> a -> a) -> NonNegative a -> a #

foldl1 :: (a -> a -> a) -> NonNegative a -> a #

toList :: NonNegative a -> [a] #

null :: NonNegative a -> Bool #

length :: NonNegative a -> Int #

elem :: Eq a => a -> NonNegative a -> Bool #

maximum :: Ord a => NonNegative a -> a #

minimum :: Ord a => NonNegative a -> a #

sum :: Num a => NonNegative a -> a #

product :: Num a => NonNegative a -> a #

HasField "unNonNegative" (NonNegative a) a Source #

Since: 0.1

Instance details

Defined in Numeric.Data.NonNegative.Internal

Methods

getField :: NonNegative a -> a #

(k ~ A_Getter, x ~ a, y ~ a) => LabelOptic "unNonNegative" k (NonNegative a) (NonNegative a) x y Source #

Since: 0.1

Instance details

Defined in Numeric.Data.NonNegative.Internal

Methods

labelOptic :: Optic k NoIx (NonNegative a) (NonNegative a) x y Source #

Lift a => Lift (NonNegative a :: Type) Source #

Since: 0.1

Instance details

Defined in Numeric.Data.NonNegative.Internal

Methods

lift :: Quote m => NonNegative a -> m Exp #

liftTyped :: forall (m :: Type -> Type). Quote m => NonNegative a -> Code m (NonNegative a) #

AMonoid a => AMonoid (NonNegative a) Source #

Since: 0.1

Instance details

Defined in Numeric.Data.NonNegative.Internal

Methods

zero :: NonNegative a Source #

ASemigroup a => ASemigroup (NonNegative a) Source #

Since: 0.1

Instance details

Defined in Numeric.Data.NonNegative.Internal

Methods

(.+.) :: NonNegative a -> NonNegative a -> NonNegative a Source #

MetricSpace a => MetricSpace (NonNegative a) Source #

Since: 0.1

Instance details

Defined in Numeric.Data.NonNegative.Internal

Methods

diffR :: NonNegative a -> NonNegative a -> Double Source #

MEuclidean a => MEuclidean (NonNegative a) Source #

Since: 0.1

Instance details

Defined in Numeric.Data.NonNegative.Internal

Methods

mdivMod :: NonNegative a -> NonNegative a -> (NonNegative a, NonNegative a) Source #

MGroup a => MGroup (NonNegative a) Source #

Since: 0.1

Instance details

Defined in Numeric.Data.NonNegative.Internal

Methods

(.%.) :: NonNegative a -> NonNegative a -> NonNegative a Source #

MMonoid a => MMonoid (NonNegative a) Source #

Since: 0.1

Instance details

Defined in Numeric.Data.NonNegative.Internal

Methods

one :: NonNegative a Source #

MSemigroup a => MSemigroup (NonNegative a) Source #

Since: 0.1

Instance details

Defined in Numeric.Data.NonNegative.Internal

Methods

(.*.) :: NonNegative a -> NonNegative a -> NonNegative a Source #

Normed a => Normed (NonNegative a) Source #

Since: 0.1

Instance details

Defined in Numeric.Data.NonNegative.Internal

Methods

norm :: NonNegative a -> NonNegative a Source #

sgn :: NonNegative a -> NonNegative a Source #

Semifield a => Semifield (NonNegative a) Source #

Since: 0.1

Instance details

Defined in Numeric.Data.NonNegative.Internal

Semiring a => Semiring (NonNegative a) Source #

Since: 0.1

Instance details

Defined in Numeric.Data.NonNegative.Internal

(AMonoid a, FromInteger a, Ord a, Show a) => FromInteger (NonNegative a) Source #

WARNING: Partial

Since: 0.1

Instance details

Defined in Numeric.Data.NonNegative.Internal

Methods

fromZ :: Integer -> NonNegative a Source #

(AMonoid a, FromRational a, Ord a, Show a) => FromRational (NonNegative a) Source #

WARNING: Partial

Since: 0.1

Instance details

Defined in Numeric.Data.NonNegative.Internal

Methods

fromQ :: Rational -> NonNegative a Source #

(AMonoid a, FromReal a, Ord a, Show a) => FromReal (NonNegative a) Source #

WARNING: Partial

Since: 0.1

Instance details

Defined in Numeric.Data.NonNegative.Internal

Methods

fromR :: Double -> NonNegative a Source #

ToInteger a => ToInteger (NonNegative a) Source #

Since: 0.1

Instance details

Defined in Numeric.Data.NonNegative.Internal

Methods

toZ :: NonNegative a -> Integer Source #

ToRational a => ToRational (NonNegative a) Source #

Since: 0.1

Instance details

Defined in Numeric.Data.NonNegative.Internal

Methods

toQ :: NonNegative a -> Rational Source #

ToReal a => ToReal (NonNegative a) Source #

Since: 0.1

Instance details

Defined in Numeric.Data.NonNegative.Internal

Methods

toR :: NonNegative a -> Double Source #

AMonoid a => LowerBounded (NonNegative a) Source #

Since: 0.1

Instance details

Defined in Numeric.Data.NonNegative.Internal

Methods

lowerBound :: NonNegative a Source #

AMonoid a => MaybeLowerBounded (NonNegative a) Source #

Since: 0.1

Instance details

Defined in Numeric.Data.NonNegative.Internal

Methods

maybeLowerBound :: Maybe (NonNegative a) Source #

MaybeUpperBounded a => MaybeUpperBounded (NonNegative a) Source #

Since: 0.1

Instance details

Defined in Numeric.Data.NonNegative.Internal

Methods

maybeUpperBound :: Maybe (NonNegative a) Source #

UpperBounded a => UpperBounded (NonNegative a) Source #

Since: 0.1

Instance details

Defined in Numeric.Data.NonNegative.Internal

Methods

upperBound :: NonNegative a Source #

UpperBoundless (NonNegative a) Source #

Since: 0.1

Instance details

Defined in Numeric.Data.NonNegative.Internal

NFData a => NFData (NonNegative a) Source #

Since: 0.1

Instance details

Defined in Numeric.Data.NonNegative.Internal

Methods

rnf :: NonNegative a -> () #

(AMonoid a, UpperBounded a) => Bounded (NonNegative a) Source #

Since: 0.1

Instance details

Defined in Numeric.Data.NonNegative.Internal

Methods

minBound :: NonNegative a #

maxBound :: NonNegative a #

Generic (NonNegative a) Source #

Instance details

Defined in Numeric.Data.NonNegative.Internal

Associated Types

type Rep (NonNegative a)	Since: smart-math-0.1
Instance details Defined in Numeric.Data.NonNegative.Internal type Rep (NonNegative a) = D1 ('MetaData "NonNegative" "Numeric.Data.NonNegative.Internal" "smart-math-0.1-inplace" 'True) (C1 ('MetaCons "UnsafeNonNegative" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)))

Methods

from :: NonNegative a -> Rep (NonNegative a) x #

to :: Rep (NonNegative a) x -> NonNegative a #

Show a => Show (NonNegative a) Source #

Since: 0.1

Instance details

Defined in Numeric.Data.NonNegative.Internal

Methods

showsPrec :: Int -> NonNegative a -> ShowS #

show :: NonNegative a -> String #

showList :: [NonNegative a] -> ShowS #

Eq a => Eq (NonNegative a) Source #

Since: 0.1

Instance details

Defined in Numeric.Data.NonNegative.Internal

Methods

(==) :: NonNegative a -> NonNegative a -> Bool #

(/=) :: NonNegative a -> NonNegative a -> Bool #

Ord a => Ord (NonNegative a) Source #

Since: 0.1

Instance details

Defined in Numeric.Data.NonNegative.Internal

Methods

compare :: NonNegative a -> NonNegative a -> Ordering #

(<) :: NonNegative a -> NonNegative a -> Bool #

(<=) :: NonNegative a -> NonNegative a -> Bool #

(>) :: NonNegative a -> NonNegative a -> Bool #

(>=) :: NonNegative a -> NonNegative a -> Bool #

max :: NonNegative a -> NonNegative a -> NonNegative a #

min :: NonNegative a -> NonNegative a -> NonNegative a #

Hashable a => Hashable (NonNegative a) Source #

Since: 0.1

Instance details

Defined in Numeric.Data.NonNegative.Internal

Methods

hashWithSalt :: Int -> NonNegative a -> Int Source #

hash :: NonNegative a -> Int Source #

Show a => Display (NonNegative a) Source #

Since: 0.1

Instance details

Defined in Numeric.Data.NonNegative.Internal

Methods

displayBuilder :: NonNegative a -> Builder Source #

displayList :: [NonNegative a] -> Builder Source #

displayPrec :: Int -> NonNegative a -> Builder Source #

type Rep (NonNegative a) Source #

Since: 0.1

Instance details

Defined in Numeric.Data.NonNegative.Internal

type Rep (NonNegative a) = D1 ('MetaData "NonNegative" "Numeric.Data.NonNegative.Internal" "smart-math-0.1-inplace" 'True) (C1 ('MetaCons "UnsafeNonNegative" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)))

Creation

mkNonNegativeTH :: (AMonoid a, Lift a, Ord a, Show a) => a -> Code Q (NonNegative a) Source #

Template haskell for creating a NonNegative at compile-time.

Examples

Expand

>>> $$(mkNonNegativeTH 1)
UnsafeNonNegative 1

Since: 0.1

mkNonNegative :: (AMonoid a, Ord a, Show a) => a -> Either String (NonNegative a) Source #

Smart constructor for NonNegative. Returns Nothing if the second parameter is < 0.

Examples

Expand

>>> mkNonNegative 0
Right (UnsafeNonNegative 0)

>>> mkNonNegative (-2)
Left "Numeric.Data.NonNegative: Received value < zero: -2"

Since: 0.1

unsafeNonNegative :: (AMonoid a, HasCallStack, Ord a, Show a) => a -> NonNegative a Source #

Throws an error when given a value < 0.

WARNING: Partial

Examples

Expand

>>> unsafeNonNegative 7
UnsafeNonNegative 7

Since: 0.1

(*!) :: (AMonoid a, HasCallStack, Ord a, Show a) => a -> NonNegative a infixl 7 Source #

Postfix operator for unsafeNonNegative.

WARNING: Partial

Examples

Expand

>>> (7 *!)
UnsafeNonNegative 7

Since: 0.1

reallyUnsafeNonNegative :: a -> NonNegative a Source #

This function is an alias for the unchecked constructor UnsafeNonNegative i.e. it allows us to construct a NonNegative without checking the invariant. This is intended only for when we absolutely know the invariant holds and a branch (i.e. unsafeNonNegative) is undesirable for performance reasons. Exercise extreme caution.

Since: 0.1

Elimination

unNonNegative :: NonNegative a -> a Source #

Since: 0.1

Optics

We provide a ReversedPrism' _MkNonNegative that allows for total elimination and partial construction, along with a LabelOptic Getter for #unNonNegative.

Examples

Expand

>>> :set -XOverloadedLabels
>>> import Optics.Core (view)
>>> let n = $$(mkNonNegativeTH 2)
>>> view #unNonNegative n
2

_MkNonNegative :: (AMonoid a, Ord a, Show a) => ReversedPrism' (NonNegative a) a Source #

ReversedPrism' that enables total elimination and partial construction.

Examples

Expand

>>> import Optics.Core (view)
>>> nn = $$(mkNonNegativeTH 2)
>>> view _MkNonNegative nn
2

>>> rmatching _MkNonNegative 3
Right (UnsafeNonNegative 3)

>>> rmatching _MkNonNegative (-2)
Left (-2)

Since: 0.1

rmatching :: (Is (ReversedOptic k) An_AffineTraversal, ReversibleOptic k) => Optic k NoIx b a t s -> s -> Either t a Source #

Reversed matching. Useful with smart-constructor optics.

Since: 0.1