smart-math
Safe HaskellNone
LanguageHaskell2010

Numeric.Data.NonNegative.Internal

Description

Provides the NonNegative type for enforcing a nonnegative invariant.

Since: 0.1

Synopsis

Type

newtype NonNegative a 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

Constructors

UnsafeNonNegative a 

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

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

Misc

errMsg :: Show a => a -> String Source #

Since: 0.1