data-interval-1.3.1: Interval datatype, interval arithmetic and interval-based containers

Copyright(c) Masahiro Sakai 2011-2013
LicenseBSD-style
Maintainermasahiro.sakai@gmail.com
Stabilityprovisional
Portabilitynon-portable (CPP, ScopedTypeVariables, DeriveDataTypeable)
Safe HaskellSafe
LanguageHaskell2010

Data.Interval

Contents

Description

Interval datatype and interval arithmetic.

Unlike the intervals package (http://hackage.haskell.org/package/intervals), this module provides both open and closed intervals and is intended to be used with Rational.

For the purpose of abstract interpretation, it might be convenient to use Lattice instance. See also lattices package (http://hackage.haskell.org/package/lattices).

Synopsis

Interval type

data Interval r Source #

The intervals (i.e. connected and convex subsets) over real numbers R.

Instances
Eq r => Eq (Interval r) Source # 
Instance details

Defined in Data.Interval.Internal

Methods

(==) :: Interval r -> Interval r -> Bool #

(/=) :: Interval r -> Interval r -> Bool #

(Real r, Fractional r) => Fractional (Interval r) Source # 
Instance details

Defined in Data.Interval

(Ord r, Data r) => Data (Interval r) Source # 
Instance details

Defined in Data.Interval.Internal

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Interval r -> c (Interval r) #

gunfold :: (forall b r0. Data b => c (b -> r0) -> c r0) -> (forall r1. r1 -> c r1) -> Constr -> c (Interval r) #

toConstr :: Interval r -> Constr #

dataTypeOf :: Interval r -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (Interval r)) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (Interval r)) #

gmapT :: (forall b. Data b => b -> b) -> Interval r -> Interval r #

gmapQl :: (r0 -> r' -> r0) -> r0 -> (forall d. Data d => d -> r') -> Interval r -> r0 #

gmapQr :: (r' -> r0 -> r0) -> r0 -> (forall d. Data d => d -> r') -> Interval r -> r0 #

gmapQ :: (forall d. Data d => d -> u) -> Interval r -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Interval r -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Interval r -> m (Interval r) #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Interval r -> m (Interval r) #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Interval r -> m (Interval r) #

(Num r, Ord r) => Num (Interval r) Source # 
Instance details

Defined in Data.Interval

(Ord r, Read r) => Read (Interval r) Source # 
Instance details

Defined in Data.Interval

(Ord r, Show r) => Show (Interval r) Source # 
Instance details

Defined in Data.Interval

Methods

showsPrec :: Int -> Interval r -> ShowS #

show :: Interval r -> String #

showList :: [Interval r] -> ShowS #

NFData r => NFData (Interval r) Source # 
Instance details

Defined in Data.Interval.Internal

Methods

rnf :: Interval r -> () #

Hashable r => Hashable (Interval r) Source # 
Instance details

Defined in Data.Interval.Internal

Methods

hashWithSalt :: Int -> Interval r -> Int #

hash :: Interval r -> Int #

Ord r => Lattice (Interval r) Source # 
Instance details

Defined in Data.Interval

Methods

(\/) :: Interval r -> Interval r -> Interval r #

(/\) :: Interval r -> Interval r -> Interval r #

Ord r => BoundedJoinSemiLattice (Interval r) Source # 
Instance details

Defined in Data.Interval

Methods

bottom :: Interval r #

Ord r => BoundedMeetSemiLattice (Interval r) Source # 
Instance details

Defined in Data.Interval

Methods

top :: Interval r #

type EndPoint r = Extended r Source #

Deprecated: EndPoint is deprecated. Please use Extended instead.

Endpoints of intervals

Construction

interval Source #

Arguments

:: Ord r 
=> (Extended r, Bool)

lower bound and whether it is included

-> (Extended r, Bool)

upper bound and whether it is included

-> Interval r 

smart constructor for Interval

(<=..<=) infix 5 Source #

Arguments

:: Ord r 
=> Extended r

lower bound l

-> Extended r

upper bound u

-> Interval r 

closed interval [l,u]

(<..<=) infix 5 Source #

Arguments

:: Ord r 
=> Extended r

lower bound l

-> Extended r

upper bound u

-> Interval r 

left-open right-closed interval (l,u]

(<=..<) infix 5 Source #

Arguments

:: Ord r 
=> Extended r

lower bound l

-> Extended r

upper bound u

-> Interval r 

left-closed right-open interval [l, u)

(<..<) infix 5 Source #

Arguments

:: Ord r 
=> Extended r

lower bound l

-> Extended r

upper bound u

-> Interval r 

open interval (l, u)

whole :: Ord r => Interval r Source #

whole real number line (-∞, ∞)

empty :: Ord r => Interval r Source #

empty (contradicting) interval

singleton :: Ord r => r -> Interval r Source #

singleton set \[x,x\]

Query

null :: Ord r => Interval r -> Bool Source #

Is the interval empty?

member :: Ord r => r -> Interval r -> Bool Source #

Is the element in the interval?

notMember :: Ord r => r -> Interval r -> Bool Source #

Is the element not in the interval?

isSubsetOf :: Ord r => Interval r -> Interval r -> Bool Source #

Is this a subset? (i1 `isSubsetOf` i2) tells whether i1 is a subset of i2.

isProperSubsetOf :: Ord r => Interval r -> Interval r -> Bool Source #

Is this a proper subset? (i.e. a subset but not equal).

isConnected :: Ord r => Interval r -> Interval r -> Bool Source #

Does the union of two range form a connected set?

Since 1.3.0

lowerBound :: Interval r -> Extended r Source #

Lower endpoint (i.e. greatest lower bound) of the interval.

upperBound :: Interval r -> Extended r Source #

Upper endpoint (i.e. least upper bound) of the interval.

lowerBound' :: Interval r -> (Extended r, Bool) Source #

lowerBound of the interval and whether it is included in the interval. The result is convenient to use as an argument for interval.

upperBound' :: Interval r -> (Extended r, Bool) Source #

upperBound of the interval and whether it is included in the interval. The result is convenient to use as an argument for interval.

width :: (Num r, Ord r) => Interval r -> r Source #

Width of a interval. Width of an unbounded interval is undefined.

Universal comparison operators

(<!) :: Ord r => Interval r -> Interval r -> Bool infix 4 Source #

For all x in X, y in Y. x < y?

(<=!) :: Ord r => Interval r -> Interval r -> Bool infix 4 Source #

For all x in X, y in Y. x <= y?

(==!) :: Ord r => Interval r -> Interval r -> Bool infix 4 Source #

For all x in X, y in Y. x == y?

(>=!) :: Ord r => Interval r -> Interval r -> Bool infix 4 Source #

For all x in X, y in Y. x >= y?

(>!) :: Ord r => Interval r -> Interval r -> Bool infix 4 Source #

For all x in X, y in Y. x > y?

(/=!) :: Ord r => Interval r -> Interval r -> Bool infix 4 Source #

For all x in X, y in Y. x /= y?

Since 1.0.1

Existential comparison operators

(<?) :: Ord r => Interval r -> Interval r -> Bool infix 4 Source #

Does there exist an x in X, y in Y such that x < y?

(<=?) :: Ord r => Interval r -> Interval r -> Bool infix 4 Source #

Does there exist an x in X, y in Y such that x <= y?

(==?) :: Ord r => Interval r -> Interval r -> Bool infix 4 Source #

Does there exist an x in X, y in Y such that x == y?

Since 1.0.0

(>=?) :: Ord r => Interval r -> Interval r -> Bool infix 4 Source #

Does there exist an x in X, y in Y such that x >= y?

(>?) :: Ord r => Interval r -> Interval r -> Bool infix 4 Source #

Does there exist an x in X, y in Y such that x > y?

(/=?) :: Ord r => Interval r -> Interval r -> Bool infix 4 Source #

Does there exist an x in X, y in Y such that x /= y?

Since 1.0.1

Existential comparison operators that produce witnesses (experimental)

(<??) :: (Real r, Fractional r) => Interval r -> Interval r -> Maybe (r, r) infix 4 Source #

Does there exist an x in X, y in Y such that x < y?

Since 1.0.0

(<=??) :: (Real r, Fractional r) => Interval r -> Interval r -> Maybe (r, r) infix 4 Source #

Does there exist an x in X, y in Y such that x <= y?

Since 1.0.0

(==??) :: (Real r, Fractional r) => Interval r -> Interval r -> Maybe (r, r) infix 4 Source #

Does there exist an x in X, y in Y such that x == y?

Since 1.0.0

(>=??) :: (Real r, Fractional r) => Interval r -> Interval r -> Maybe (r, r) infix 4 Source #

Does there exist an x in X, y in Y such that x >= y?

Since 1.0.0

(>??) :: (Real r, Fractional r) => Interval r -> Interval r -> Maybe (r, r) infix 4 Source #

Does there exist an x in X, y in Y such that x > y?

Since 1.0.0

(/=??) :: (Real r, Fractional r) => Interval r -> Interval r -> Maybe (r, r) infix 4 Source #

Does there exist an x in X, y in Y such that x /= y?

Since 1.0.1

Combine

intersection :: forall r. Ord r => Interval r -> Interval r -> Interval r Source #

intersection of two intervals

intersections :: Ord r => [Interval r] -> Interval r Source #

intersection of a list of intervals.

Since 0.6.0

hull :: forall r. Ord r => Interval r -> Interval r -> Interval r Source #

convex hull of two intervals

hulls :: Ord r => [Interval r] -> Interval r Source #

convex hull of a list of intervals.

Since 0.6.0

Map

mapMonotonic :: (Ord a, Ord b) => (a -> b) -> Interval a -> Interval b Source #

mapMonotonic f i is the image of i under f, where f must be a strict monotone function.

Operations

pickup :: (Real r, Fractional r) => Interval r -> Maybe r Source #

pick up an element from the interval if the interval is not empty.

simplestRationalWithin :: RealFrac r => Interval r -> Maybe Rational Source #

simplestRationalWithin returns the simplest rational number within the interval.

A rational number y is said to be simpler than another y' if

(see also approxRational)

Since 0.4.0

Orphan instances

(Real r, Fractional r) => Fractional (Interval r) Source # 
Instance details

(Num r, Ord r) => Num (Interval r) Source # 
Instance details

(Ord r, Read r) => Read (Interval r) Source # 
Instance details

(Ord r, Show r) => Show (Interval r) Source # 
Instance details

Methods

showsPrec :: Int -> Interval r -> ShowS #

show :: Interval r -> String #

showList :: [Interval r] -> ShowS #

Ord r => Lattice (Interval r) Source # 
Instance details

Methods

(\/) :: Interval r -> Interval r -> Interval r #

(/\) :: Interval r -> Interval r -> Interval r #

Ord r => BoundedJoinSemiLattice (Interval r) Source # 
Instance details

Methods

bottom :: Interval r #

Ord r => BoundedMeetSemiLattice (Interval r) Source # 
Instance details

Methods

top :: Interval r #