Copyright	(c) Michael Szvetits 2019
License	BSD3 (see the file LICENSE)
Maintainer	typedbyte@qualified.name
Stability	stable
Portability	portable
Safe Haskell	Safe
Language	Haskell2010

Numeric.Distance

Description

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

Synopsis

class Ord a => Dist a where
- distance :: a -> a -> Distance
- shift :: Int -> a -> Maybe a
data Distance
- = NegativeInfinite
- | Finite Int
- | PositiveInfinite
adjacent :: Dist a => a -> a -> Bool

Documentation

class Ord a => Dist a where Source #

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

Methods

distance :: a -> a -> Distance Source #

Calculates the distance between two values.

shift :: Int -> a -> Maybe a Source #

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 Source #
Instance details Defined in Numeric.Distance Methods distance :: Double -> Double -> Distance Source # shift :: Int -> Double -> Maybe Double Source #
Dist Float Source #
Instance details Defined in Numeric.Distance Methods distance :: Float -> Float -> Distance Source # shift :: Int -> Float -> Maybe Float Source #
Dist Int Source #
Instance details Defined in Numeric.Distance Methods distance :: Int -> Int -> Distance Source # shift :: Int -> Int -> Maybe Int Source #
Dist Int8 Source #
Instance details Defined in Numeric.Distance Methods distance :: Int8 -> Int8 -> Distance Source # shift :: Int -> Int8 -> Maybe Int8 Source #
Dist Int16 Source #
Instance details Defined in Numeric.Distance Methods distance :: Int16 -> Int16 -> Distance Source # shift :: Int -> Int16 -> Maybe Int16 Source #
Dist Int32 Source #
Instance details Defined in Numeric.Distance Methods distance :: Int32 -> Int32 -> Distance Source # shift :: Int -> Int32 -> Maybe Int32 Source #
Dist Int64 Source #
Instance details Defined in Numeric.Distance Methods distance :: Int64 -> Int64 -> Distance Source # shift :: Int -> Int64 -> Maybe Int64 Source #
Dist Integer Source #
Instance details Defined in Numeric.Distance Methods distance :: Integer -> Integer -> Distance Source # shift :: Int -> Integer -> Maybe Integer Source #

data Distance Source #

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 Source #
Instance details Defined in Numeric.Distance Methods (==) :: Distance -> Distance -> Bool # (/=) :: Distance -> Distance -> Bool #
Ord Distance Source #
Instance details 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 Source #

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