Numeric.Distance

This module exports the types and functions needed to handle distances between two domain values and to determine if two domain values are adjacent.

Documentation

class Ord a => Dist a where

The class of domain value types for which a distance can be determined.

Methods

distance :: a -> a -> Distance

Calculates the distance between two values.

shift :: Int -> a -> Maybe a

Determines a new value by trying to move a finite distance from a given value.

Returns Nothing if the distance to the new value is infinite.

Instances

Dist Double

Defined in Numeric.Distance

Methods

distance :: Double -> Double -> Distance

shift :: Int -> Double -> Maybe Double

Dist Float

Defined in Numeric.Distance

Methods

distance :: Float -> Float -> Distance

shift :: Int -> Float -> Maybe Float

Dist Int

Defined in Numeric.Distance

Methods

distance :: Int -> Int -> Distance

shift :: Int -> Int -> Maybe Int

Dist Int8

Defined in Numeric.Distance

Methods

distance :: Int8 -> Int8 -> Distance

shift :: Int -> Int8 -> Maybe Int8

Dist Int16

Defined in Numeric.Distance

Methods

distance :: Int16 -> Int16 -> Distance

shift :: Int -> Int16 -> Maybe Int16

Dist Int32

Defined in Numeric.Distance

Methods

distance :: Int32 -> Int32 -> Distance

shift :: Int -> Int32 -> Maybe Int32

Dist Int64

Defined in Numeric.Distance

Methods

distance :: Int64 -> Int64 -> Distance

shift :: Int -> Int64 -> Maybe Int64

Dist Integer

Defined in Numeric.Distance

Methods

distance :: Integer -> Integer -> Distance

shift :: Int -> Integer -> Maybe Integer

data Distance

The distance between two elements of a domain is either finite (e.g., the distance between the integers 3 and 5 is 2), negative infinite (e.g., the distance between the double values 3.0 and 1.0) or positive infinite (e.g., the distance between the double values 1.0 and 3.0).

The distance is used to determine if two interval bounds are adjacent, which further allows to merge intervals and convert open to closed intervals based on the used domain value type.

Constructors

NegativeInfinite

Finite Int

PositiveInfinite

Instances

Eq Distance

Defined in Numeric.Distance

Methods

(==) :: Distance -> Distance -> Bool

(/=) :: Distance -> Distance -> Bool

Ord Distance

Defined in Numeric.Distance

Methods

compare :: Distance -> Distance -> Ordering

(<) :: Distance -> Distance -> Bool

(<=) :: Distance -> Distance -> Bool

(>) :: Distance -> Distance -> Bool

(>=) :: Distance -> Distance -> Bool

max :: Distance -> Distance -> Distance

min :: Distance -> Distance -> Distance

adjacent :: Dist a => a -> a -> Bool

Checks if two domain values are adjacent, i.e. their distance is finite 1.