Module

Data.Ring

#Ring

class (Semiring a) <= Ring a  where

The Ring class is for types that support addition, multiplication, and subtraction operations.

Instances must satisfy the following law in addition to the Semiring laws:

  • Additive inverse: a - a = (zero - a) + a = zero

Members

  • sub :: a -> a -> a

Instances

#negate

negate :: forall a. Ring a => a -> a

negate x can be used as a shorthand for zero - x.

#(-)

Operator alias for Data.Ring.sub (left-associative / precedence 6)

#RingRecord

class (SemiringRecord rowlist row subrow) <= RingRecord rowlist row subrow | rowlist -> subrow where

A class for records where all fields have Ring instances, used to implement the Ring instance for records.

Members

Instances

Re-exports from Data.Semiring

#Semiring

class Semiring a  where

The Semiring class is for types that support an addition and multiplication operation.

Instances must satisfy the following laws:

  • Commutative monoid under addition:
    • Associativity: (a + b) + c = a + (b + c)
    • Identity: zero + a = a + zero = a
    • Commutative: a + b = b + a
  • Monoid under multiplication:
    • Associativity: (a * b) * c = a * (b * c)
    • Identity: one * a = a * one = a
  • Multiplication distributes over addition:
    • Left distributivity: a * (b + c) = (a * b) + (a * c)
    • Right distributivity: (a + b) * c = (a * c) + (b * c)
  • Annihilation: zero * a = a * zero = zero

Note: The Number and Int types are not fully law abiding members of this class hierarchy due to the potential for arithmetic overflows, and in the case of Number, the presence of NaN and Infinity values. The behaviour is unspecified in these cases.

Members

Instances

#SemiringRecord

class SemiringRecord rowlist row subrow | rowlist -> subrow

A class for records where all fields have Semiring instances, used to implement the Semiring instance for records.

Instances

#(+)

Operator alias for Data.Semiring.add (left-associative / precedence 6)

#(*)

Operator alias for Data.Semiring.mul (left-associative / precedence 7)

Modules