Safe Haskell	Safe
Language	Haskell98

Algebra.Additive

Contents

Class
Complex functions
Instance definition helpers
Instances for atomic types

Synopsis

Class

class C a where Source #

Additive a encapsulates the notion of a commutative group, specified by the following laws:

          a + b === b + a
    (a + b) + c === a + (b + c)
       zero + a === a
   a + negate a === 0

Typical examples include integers, dollars, and vectors.

Minimal definition: +, zero, and (negate or '(-)')

Minimal complete definition

zero, (+), ((-) | negate)

Methods

zero :: a Source #

zero element of the vector space

(+), (-) :: a -> a -> a infixl 6 +, - Source #

add and subtract elements

negate :: a -> a Source #

inverse with respect to +

Instances

C Double Source #
Methods zero :: Double Source # (+) :: Double -> Double -> Double Source # (-) :: Double -> Double -> Double Source # negate :: Double -> Double Source #
C Float Source #
Methods zero :: Float Source # (+) :: Float -> Float -> Float Source # (-) :: Float -> Float -> Float Source # negate :: Float -> Float Source #
C Int Source #
Methods zero :: Int Source # (+) :: Int -> Int -> Int Source # (-) :: Int -> Int -> Int Source # negate :: Int -> Int Source #
C Int8 Source #
Methods zero :: Int8 Source # (+) :: Int8 -> Int8 -> Int8 Source # (-) :: Int8 -> Int8 -> Int8 Source # negate :: Int8 -> Int8 Source #
C Int16 Source #
Methods zero :: Int16 Source # (+) :: Int16 -> Int16 -> Int16 Source # (-) :: Int16 -> Int16 -> Int16 Source # negate :: Int16 -> Int16 Source #
C Int32 Source #
Methods zero :: Int32 Source # (+) :: Int32 -> Int32 -> Int32 Source # (-) :: Int32 -> Int32 -> Int32 Source # negate :: Int32 -> Int32 Source #
C Int64 Source #
Methods zero :: Int64 Source # (+) :: Int64 -> Int64 -> Int64 Source # (-) :: Int64 -> Int64 -> Int64 Source # negate :: Int64 -> Int64 Source #
C Integer Source #
Methods zero :: Integer Source # (+) :: Integer -> Integer -> Integer Source # (-) :: Integer -> Integer -> Integer Source # negate :: Integer -> Integer Source #
C Word Source #
Methods zero :: Word Source # (+) :: Word -> Word -> Word Source # (-) :: Word -> Word -> Word Source # negate :: Word -> Word Source #
C Word8 Source #
Methods zero :: Word8 Source # (+) :: Word8 -> Word8 -> Word8 Source # (-) :: Word8 -> Word8 -> Word8 Source # negate :: Word8 -> Word8 Source #
C Word16 Source #
Methods zero :: Word16 Source # (+) :: Word16 -> Word16 -> Word16 Source # (-) :: Word16 -> Word16 -> Word16 Source # negate :: Word16 -> Word16 Source #
C Word32 Source #
Methods zero :: Word32 Source # (+) :: Word32 -> Word32 -> Word32 Source # (-) :: Word32 -> Word32 -> Word32 Source # negate :: Word32 -> Word32 Source #
C Word64 Source #
Methods zero :: Word64 Source # (+) :: Word64 -> Word64 -> Word64 Source # (-) :: Word64 -> Word64 -> Word64 Source # negate :: Word64 -> Word64 Source #
C T Source #
Methods zero :: T Source # (+) :: T -> T -> T Source # (-) :: T -> T -> T Source # negate :: T -> T Source #
C T Source #
Methods zero :: T Source # (+) :: T -> T -> T Source # (-) :: T -> T -> T Source # negate :: T -> T Source #
C T Source #
Methods zero :: T Source # (+) :: T -> T -> T Source # (-) :: T -> T -> T Source # negate :: T -> T Source #
C T Source #
Methods zero :: T Source # (+) :: T -> T -> T Source # (-) :: T -> T -> T Source # negate :: T -> T Source #
C v => C [v] Source #	The `Additive` instantiations treat lists as prefixes of infinite lists with zero filled tail. This interpretation is not always appropriate. The end of a list may just mean: End of available data. In this case the shortening `zip` semantics would be more appropriate.
Methods zero :: [v] Source # (+) :: [v] -> [v] -> [v] Source # (-) :: [v] -> [v] -> [v] Source # negate :: [v] -> [v] Source #
Integral a => C (Ratio a) Source #
Methods zero :: Ratio a Source # (+) :: Ratio a -> Ratio a -> Ratio a Source # (-) :: Ratio a -> Ratio a -> Ratio a Source # negate :: Ratio a -> Ratio a Source #
RealFloat a => C (Complex a) Source #
Methods zero :: Complex a Source # (+) :: Complex a -> Complex a -> Complex a Source # (-) :: Complex a -> Complex a -> Complex a Source # negate :: Complex a -> Complex a Source #
C a => C (T a) Source #
Methods zero :: T a Source # (+) :: T a -> T a -> T a Source # (-) :: T a -> T a -> T a Source # negate :: T a -> T a Source #
Num a => C (T a) Source #
Methods zero :: T a Source # (+) :: T a -> T a -> T a Source # (-) :: T a -> T a -> T a Source # negate :: T a -> T a Source #
(Eq a, C a) => C (T a) Source #
Methods zero :: T a Source # (+) :: T a -> T a -> T a Source # (-) :: T a -> T a -> T a Source # negate :: T a -> T a Source #
C a => C (T a) Source #
Methods zero :: T a Source # (+) :: T a -> T a -> T a Source # (-) :: T a -> T a -> T a Source # negate :: T a -> T a Source #
(Eq a, C a) => C (T a) Source #
Methods zero :: T a Source # (+) :: T a -> T a -> T a Source # (-) :: T a -> T a -> T a Source # negate :: T a -> T a Source #
C a => C (T a) Source #
Methods zero :: T a Source # (+) :: T a -> T a -> T a Source # (-) :: T a -> T a -> T a Source # negate :: T a -> T a Source #
C a => C (T a) Source #
Methods zero :: T a Source # (+) :: T a -> T a -> T a Source # (-) :: T a -> T a -> T a Source # negate :: T a -> T a Source #
C a => C (T a) Source #
Methods zero :: T a Source # (+) :: T a -> T a -> T a Source # (-) :: T a -> T a -> T a Source # negate :: T a -> T a Source #
C a => C (T a) Source #
Methods zero :: T a Source # (+) :: T a -> T a -> T a Source # (-) :: T a -> T a -> T a Source # negate :: T a -> T a Source #
C a => C (T a) Source #
Methods zero :: T a Source # (+) :: T a -> T a -> T a Source # (-) :: T a -> T a -> T a Source # negate :: T a -> T a Source #
C a => C (T a) Source #
Methods zero :: T a Source # (+) :: T a -> T a -> T a Source # (-) :: T a -> T a -> T a Source # negate :: T a -> T a Source #
(C a, C a) => C (T a) Source #
Methods zero :: T a Source # (+) :: T a -> T a -> T a Source # (-) :: T a -> T a -> T a Source # negate :: T a -> T a Source #
(C a, C a, C a) => C (T a) Source #
Methods zero :: T a Source # (+) :: T a -> T a -> T a Source # (-) :: T a -> T a -> T a Source # negate :: T a -> T a Source #
C a => C (T a) Source #
Methods zero :: T a Source # (+) :: T a -> T a -> T a Source # (-) :: T a -> T a -> T a Source # negate :: T a -> T a Source #
C a => C (T a) Source #
Methods zero :: T a Source # (+) :: T a -> T a -> T a Source # (-) :: T a -> T a -> T a Source # negate :: T a -> T a Source #
C a => C (T a) Source #
Methods zero :: T a Source # (+) :: T a -> T a -> T a Source # (-) :: T a -> T a -> T a Source # negate :: T a -> T a Source #
C a => C (T a) Source #
Methods zero :: T a Source # (+) :: T a -> T a -> T a Source # (-) :: T a -> T a -> T a Source # negate :: T a -> T a Source #
C a => C (T a) Source #
Methods zero :: T a Source # (+) :: T a -> T a -> T a Source # (-) :: T a -> T a -> T a Source # negate :: T a -> T a Source #
C v => C (b -> v) Source #
Methods zero :: b -> v Source # (+) :: (b -> v) -> (b -> v) -> b -> v Source # (-) :: (b -> v) -> (b -> v) -> b -> v Source # negate :: (b -> v) -> b -> v Source #
(C v0, C v1) => C (v0, v1) Source #
Methods zero :: (v0, v1) Source # (+) :: (v0, v1) -> (v0, v1) -> (v0, v1) Source # (-) :: (v0, v1) -> (v0, v1) -> (v0, v1) Source # negate :: (v0, v1) -> (v0, v1) Source #
(Ord a, C b) => C (T a b) Source #
Methods zero :: T a b Source # (+) :: T a b -> T a b -> T a b Source # (-) :: T a b -> T a b -> T a b Source # negate :: T a b -> T a b Source #
C v => C (T a v) Source #
Methods zero :: T a v Source # (+) :: T a v -> T a v -> T a v Source # (-) :: T a v -> T a v -> T a v Source # negate :: T a v -> T a v Source #
(C u, C a) => C (T u a) Source #
Methods zero :: T u a Source # (+) :: T u a -> T u a -> T u a Source # (-) :: T u a -> T u a -> T u a Source # negate :: T u a -> T u a Source #
(Ord i, C a) => C (T i a) Source #
Methods zero :: T i a Source # (+) :: T i a -> T i a -> T i a Source # (-) :: T i a -> T i a -> T i a Source # negate :: T i a -> T i a Source #
C v => C (T a v) Source #
Methods zero :: T a v Source # (+) :: T a v -> T a v -> T a v Source # (-) :: T a v -> T a v -> T a v Source # negate :: T a v -> T a v Source #
(C v0, C v1, C v2) => C (v0, v1, v2) Source #
Methods zero :: (v0, v1, v2) Source # (+) :: (v0, v1, v2) -> (v0, v1, v2) -> (v0, v1, v2) Source # (-) :: (v0, v1, v2) -> (v0, v1, v2) -> (v0, v1, v2) Source # negate :: (v0, v1, v2) -> (v0, v1, v2) Source #

zero :: C a => a Source #

zero element of the vector space

(+), (-) :: C a => a -> a -> a infixl 6 +, - Source #

add and subtract elements

(+), (-) :: C a => a -> a -> a infixl 6 -, + Source #

add and subtract elements

negate :: C a => a -> a Source #

inverse with respect to +

subtract :: C a => a -> a -> a Source #

subtract is (-) with swapped operand order. This is the operand order which will be needed in most cases of partial application.

Complex functions

sum :: C a => [a] -> a Source #

Sum up all elements of a list. An empty list yields zero.

This function is inappropriate for number types like Peano. Maybe we should make sum a method of Additive. This would also make lengthLeft and lengthRight superfluous.

sum1 :: C a => [a] -> a Source #

Sum up all elements of a non-empty list. This avoids including a zero which is useful for types where no universal zero is available. ToDo: Should have NonEmpty type.

sumNestedAssociative :: C a => [a] -> a Source #

Sum the operands in an order, such that the dependencies are minimized. Does this have a measurably effect on speed?

Requires associativity.

sumNestedCommutative :: C a => [a] -> a Source #

Instance definition helpers

elementAdd :: C x => (v -> x) -> T (v, v) x Source #

Instead of baking the add operation into the element function, we could use higher rank types and pass a generic uncurry (+) to the run function. We do not do so in order to stay Haskell 98 at least for parts of NumericPrelude.

elementSub :: C x => (v -> x) -> T (v, v) x Source #

elementNeg :: C x => (v -> x) -> T v x Source #

(<*>.+) :: C x => T (v, v) (x -> a) -> (v -> x) -> T (v, v) a infixl 4 Source #

addPair :: (Additive.C a, Additive.C b) => (a,b) -> (a,b) -> (a,b)
addPair = Elem.run2 $ Elem.with (,) <*>.+  fst <*>.+  snd

(<*>.-) :: C x => T (v, v) (x -> a) -> (v -> x) -> T (v, v) a infixl 4 Source #

(<*>.-$) :: C x => T v (x -> a) -> (v -> x) -> T v a infixl 4 Source #

Instances for atomic types

propAssociative :: (Eq a, C a) => a -> a -> a -> Bool Source #

propCommutative :: (Eq a, C a) => a -> a -> Bool Source #

propIdentity :: (Eq a, C a) => a -> Bool Source #

propInverse :: (Eq a, C a) => a -> Bool Source #