msakai / data-interval / 80

Committed 30 Aug 2025 08:23PM UTC coverage: 86.789% (+0.09%) from 86.702%

Build # 80

Build Type

push

github

Committed by

Bodigrim

Commit Message

Fix warnings

Coverage Stats

1 of 4 new or added lines in 4 files covered. (25.0%)

87 existing lines in 4 files now uncovered.

992 of 1143 relevant lines covered (86.79%)

0.87 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

93.33

/src/Data/IntervalRelation.hs

{-# OPTIONS_GHC -Wall #-}
{-# LANGUAGE DeriveDataTypeable, DeriveGeneric #-}
{-# LANGUAGE Safe #-}
-----------------------------------------------------------------------------
-- |
-- Module      :  Data.IntervalRelation
-- Copyright   :  (c) Masahiro Sakai 2016
-- License     :  BSD-style
--
-- Maintainer  :  masahiro.sakai@gmail.com
-- Stability   :  provisional
--
-- Interval relations and their algebra.
--
-----------------------------------------------------------------------------
module Data.IntervalRelation
  ( Relation(..)
  , invert
  )
  where

import Data.Data (Data)
import GHC.Generics (Generic)

-- | Describes how two intervals @x@ and @y@ can be related.
-- See [Allen's interval algebra](https://en.wikipedia.org/wiki/Allen%27s_interval_algebra)
-- and [Intervals and their relations](http://marcosh.github.io/post/2020/05/04/intervals-and-their-relations.html).
data Relation
  = Before
  -- ^ Any element of @x@ is smaller than any element of @y@,
  -- and intervals are not connected. In other words, there exists an element
  -- that is bigger than any element of @x@ and smaller than any element of @y@.
  | JustBefore
  -- ^ Any element of @x@ is smaller than any element of @y@,
  -- but intervals are connected and non-empty. This implies that intersection
  -- of intervals is empty, and union is a single interval.
  | Overlaps
  -- ^ Intersection of @x@ and @y@ is non-empty,
  -- @x@ start and finishes earlier than @y@. This implies that union
  -- is a single interval, and @x@ finishes no earlier than @y@ starts.
  | Starts
  -- ^ @x@ is a proper subset of @y@,
  -- and they share lower bounds.
  | During
  -- ^ @x@ is a proper subset of @y@,
  -- but they share neither lower nor upper bounds.
  | Finishes
  -- ^ @x@ is a proper subset of @y@,
  -- and they share upper bounds.
  | Equal
  -- ^ Intervals are equal.
  | FinishedBy
  -- ^ Inverse of 'Finishes'.
  | Contains
  -- ^ Inverse of 'During'.
  | StartedBy
  -- ^ Inverse of 'Starts'.
  | OverlappedBy
  -- ^ Inverse of 'Overlaps'.
  | JustAfter
  -- ^ Inverse of 'JustBefore'.
  | After
  -- ^ Inverse of 'Before'.
  deriving (Eq, Ord, Enum, Bounded, Show, Read, Generic, Data)

-- | Inverts a relation, such that @'invert' ('Data.Interval.relate' x y) = 'Data.Interval.relate' y x@
invert :: Relation -> Relation
invert relation = case relation of
  Before       -> After
  JustBefore   -> JustAfter
  Overlaps     -> OverlappedBy
  Starts       -> StartedBy
  During       -> Contains
  Finishes     -> FinishedBy
  Equal        -> Equal
  FinishedBy   -> Finishes
  Contains     -> During
  StartedBy    -> Starts
  OverlappedBy -> Overlaps
  JustAfter    -> JustBefore
  After        -> Before

1	{-# OPTIONS_GHC -Wall #-}
2	{-# LANGUAGE DeriveDataTypeable, DeriveGeneric #-}
3	{-# LANGUAGE Safe #-}
4	-----------------------------------------------------------------------------
5	-- \|
6	-- Module : Data.IntervalRelation
7	-- Copyright : (c) Masahiro Sakai 2016
8	-- License : BSD-style
9	--
10	-- Maintainer : masahiro.sakai@gmail.com
11	-- Stability : provisional
12	--
13	-- Interval relations and their algebra.
14	--
15	-----------------------------------------------------------------------------
16	module Data.IntervalRelation
17	( Relation(..)
18	, invert
19	)
20	where
21
22	import Data.Data (Data)
23	import GHC.Generics (Generic)
24
25	-- \| Describes how two intervals @x@ and @y@ can be related.
26	-- See [Allen's interval algebra](https://en.wikipedia.org/wiki/Allen%27s_interval_algebra)
27	-- and [Intervals and their relations](http://marcosh.github.io/post/2020/05/04/intervals-and-their-relations.html).
28	data Relation
29	= Before
30	-- ^ Any element of @x@ is smaller than any element of @y@,
31	-- and intervals are not connected. In other words, there exists an element
32	-- that is bigger than any element of @x@ and smaller than any element of @y@.
33	\| JustBefore
34	-- ^ Any element of @x@ is smaller than any element of @y@,
35	-- but intervals are connected and non-empty. This implies that intersection
36	-- of intervals is empty, and union is a single interval.
37	\| Overlaps
38	-- ^ Intersection of @x@ and @y@ is non-empty,
39	-- @x@ start and finishes earlier than @y@. This implies that union
40	-- is a single interval, and @x@ finishes no earlier than @y@ starts.
41	\| Starts
42	-- ^ @x@ is a proper subset of @y@,
43	-- and they share lower bounds.
44	\| During
45	-- ^ @x@ is a proper subset of @y@,
46	-- but they share neither lower nor upper bounds.
47	\| Finishes
48	-- ^ @x@ is a proper subset of @y@,
49	-- and they share upper bounds.
50	\| Equal
51	-- ^ Intervals are equal.
52	\| FinishedBy
53	-- ^ Inverse of 'Finishes'.
54	\| Contains
55	-- ^ Inverse of 'During'.
56	\| StartedBy
57	-- ^ Inverse of 'Starts'.
58	\| OverlappedBy
59	-- ^ Inverse of 'Overlaps'.
60	\| JustAfter
61	-- ^ Inverse of 'JustBefore'.
62	\| After
63	-- ^ Inverse of 'Before'.
NEW 64	deriving (Eq, Ord, Enum, Bounded, Show, Read, Generic, Data)	×
65
66	-- \| Inverts a relation, such that @'invert' ('Data.Interval.relate' x y) = 'Data.Interval.relate' y x@
67	invert :: Relation -> Relation
68	invert relation = case relation of	1✔
69	Before -> After	1✔
70	JustBefore -> JustAfter	1✔
71	Overlaps -> OverlappedBy	1✔
72	Starts -> StartedBy	1✔
73	During -> Contains	1✔
74	Finishes -> FinishedBy	1✔
75	Equal -> Equal	1✔
76	FinishedBy -> Finishes	1✔
77	Contains -> During	1✔
78	StartedBy -> Starts	1✔
79	OverlappedBy -> Overlaps	1✔
80	JustAfter -> JustBefore	1✔
81	After -> Before	1✔

msakai / data-interval / 80

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous