wumpus-core-0.41.0: src/Wumpus/Core/Geometry.hs
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE GeneralizedNewtypeDeriving #-}
{-# LANGUAGE UndecidableInstances #-}
{-# LANGUAGE FlexibleContexts #-}
{-# OPTIONS -Wall #-}
--------------------------------------------------------------------------------
-- |
-- Module : Wumpus.Core.Geometry
-- Copyright : (c) Stephen Tetley 2009-2010
-- License : BSD3
--
-- Maintainer : Stephen Tetley <stephen.tetley@gmail.com>
-- Stability : highly unstable
-- Portability : GHC
--
-- Objects and operations for 2D geometry.
--
-- Vector, point, 3x3 matrix, and radian representations,
-- plus a type family @DUnit@ for parameterizing type classes
-- with some /dimension/.
--
--------------------------------------------------------------------------------
module Wumpus.Core.Geometry
(
-- * Type family
DUnit
, GuardEq
-- * Data types
, UNil
, Vec2(..)
, DVec2
, Point2(..)
, DPoint2
, Matrix3'3(..)
, DMatrix3'3
, Radian
, MatrixMult(..)
-- * UNil operations
, uNil
-- * Vector operations
, vec
, hvec
, vvec
, avec
, pvec
, vreverse
, direction
, vlength
, vangle
-- * Point operations
, zeroPt
, maxPt
, minPt
, lineDirection
-- * Matrix contruction
, identityMatrix
, scalingMatrix
, translationMatrix
, rotationMatrix
, originatedRotationMatrix
-- * matrix operations
, invert
, determinant
, transpose
-- * Radian operations
, toRadian
, fromRadian
, d2r
, r2d
, circularModulo
-- * Bezier curves
, bezierArc
, bezierCircle
) where
import Wumpus.Core.Utils.Common
import Wumpus.Core.Utils.FormatCombinators
import Data.AffineSpace -- package: vector-space
import Data.VectorSpace
import Data.Monoid
--------------------------------------------------------------------------------
-- | Some unit of dimension usually double.
--
-- This very useful for reducing the kind of type classes to *.
--
-- Doing this then allows constraints on the Unit type on the
-- instances rather than in the class declaration.
--
type family DUnit a :: *
-- Not exported - thanks to Max Bollingbroke.
--
type family GuardEq a b :: *
type instance GuardEq a a = a
--------------------------------------------------------------------------------
-- Datatypes
-- | Phantom @()@.
--
-- This newtype is Haskell\'s @()@ with unit of dimension @u@ as
-- a phantom type.
--
-- This has no use in @wumpus-core@, but it has affine instances
-- which cannot be written for @()@. By supporting affine
-- instances it becomes useful to higher-level software
-- (@wumpus-basic@ employs it for the @Graphic@ type.)
--
newtype UNil u = UNil ()
deriving (Bounded,Enum,Eq,Ord)
-- | 2D Vector - both components are strict.
--
data Vec2 u = V2
{ vector_x :: !u
, vector_y :: !u
}
deriving (Eq,Show)
type DVec2 = Vec2 Double
-- | 2D Point - both components are strict.
--
-- Note - Point2 derives Ord so it can be used as a key in
-- Data.Map etc.
--
data Point2 u = P2
{ point_x :: !u
, point_y :: !u
}
deriving (Eq,Ord,Show)
type DPoint2 = Point2 Double
-- | 3x3 matrix, considered to be in row-major form.
--
-- > (M3'3 a b c
-- > d e f
-- > g h i)
--
-- For instance the rotation matrix is represented as
--
-- > ( cos(a) -sin(a) 0
-- > sin(a) cos(a) 0
-- > 0 0 1 )
--
-- This seems commplace in geometry texts, but PostScript
-- represents the @current-transformation-matrix@ in
-- column-major form.
--
-- The right-most column is considered to represent a
-- coordinate:
--
-- > ( 1 0 x
-- > 0 1 y
-- > 0 0 1 )
-- >
--
-- So a translation matrix representing the displacement in x
-- of 40 and in y of 10 would be:
--
-- > ( 1 0 40
-- > 0 1 10
-- > 0 0 1 )
-- >
--
data Matrix3'3 u = M3'3 !u !u !u !u !u !u !u !u !u
deriving (Eq)
type DMatrix3'3 = Matrix3'3 Double
-- | Radian is represented with a distinct type.
-- Equality and ordering are approximate where the epsilon
-- is 0.0001.
newtype Radian = Radian { getRadian :: Double }
deriving (Num,Real,Fractional,Floating,RealFrac,RealFloat)
--------------------------------------------------------------------------------
-- Family instances
type instance DUnit (UNil u) = u
type instance DUnit (Point2 u) = u
type instance DUnit (Vec2 u) = u
type instance DUnit (Matrix3'3 u) = u
type instance DUnit (Maybe a) = DUnit a
type instance DUnit (a,b) = GuardEq (DUnit a) (DUnit b)
--------------------------------------------------------------------------------
-- lifters / convertors
lift2Vec2 :: (u -> u -> u) -> Vec2 u -> Vec2 u -> Vec2 u
lift2Vec2 op (V2 x y) (V2 x' y') = V2 (x `op` x') (y `op` y')
lift2Matrix3'3 :: (u -> u -> u) -> Matrix3'3 u -> Matrix3'3 u -> Matrix3'3 u
lift2Matrix3'3 op (M3'3 a b c d e f g h i) (M3'3 m n o p q r s t u) =
M3'3 (a `op` m) (b `op` n) (c `op` o)
(d `op` p) (e `op` q) (f `op` r)
(g `op` s) (h `op` t) (i `op` u)
--------------------------------------------------------------------------------
-- instances
instance Monoid (UNil u) where
mempty = UNil ()
_ `mappend` _ = UNil ()
-- Functor
instance Functor Vec2 where
fmap f (V2 a b) = V2 (f a) (f b)
instance Functor Point2 where
fmap f (P2 a b) = P2 (f a) (f b)
instance Functor Matrix3'3 where
fmap f (M3'3 m n o p q r s t u) =
M3'3 (f m) (f n) (f o) (f p) (f q) (f r) (f s) (f t) (f u)
-- Show
instance Show (UNil u) where
show _ = "UNil"
instance Show u => Show (Matrix3'3 u) where
show (M3'3 a b c d e f g h i) = "(M3'3 " ++ body ++ ")" where
body = show [[a,b,c],[d,e,f],[g,h,i]]
-- Num
instance Num u => Num (Matrix3'3 u) where
(+) = lift2Matrix3'3 (+)
(-) = lift2Matrix3'3 (-)
(*) (M3'3 a b c d e f g h i) (M3'3 m n o p q r s t u) =
M3'3 (a*m+b*p+c*s) (a*n+b*q+c*t) (a*o+b*r+c*u)
(d*m+e*p+f*s) (d*n+e*q+f*t) (d*o+e*r+f*u)
(g*m+h*p+i*s) (g*n+h*q+i*t) (g*o+h*r+i*u)
abs = fmap abs
negate = fmap negate
signum = fmap signum
fromInteger a = M3'3 a' a' a' a' a' a' a' a' a' where a' = fromInteger a
--------------------------------------------------------------------------------
-- Instances for Radian which are 'special'.
instance Show Radian where
showsPrec i (Radian a) = showsPrec i a
instance Eq Radian where (==) = req
instance Ord Radian where
compare a b | a `req` b = EQ
| otherwise = getRadian a `compare` getRadian b
--------------------------------------------------------------------------------
-- Pretty printing
instance PSUnit u => Format (Vec2 u) where
format (V2 a b) = parens (text "Vec" <+> dtruncFmt a <+> dtruncFmt b)
instance PSUnit u => Format (Point2 u) where
format (P2 a b) = parens (dtruncFmt a <> comma <+> dtruncFmt b)
instance PSUnit u => Format (Matrix3'3 u) where
format (M3'3 a b c d e f g h i) =
vcat [matline a b c, matline d e f, matline g h i]
where
matline x y z = char '|'
<+> (hcat $ map (fill 12 . dtruncFmt) [x,y,z])
<+> char '|'
instance Format Radian where
format (Radian d) = double d <> text ":rad"
--------------------------------------------------------------------------------
-- Vector space instances
instance Num u => AdditiveGroup (Vec2 u) where
zeroV = V2 0 0
(^+^) = lift2Vec2 (+)
negateV = fmap negate
instance Num u => VectorSpace (Vec2 u) where
type Scalar (Vec2 u) = u
s *^ v = fmap (s*) v
-- scalar (dot / inner) product via the class InnerSpace
--
-- This definition mandates UndecidableInstances, but this seems
-- in line with Data.VectorSpace...
--
instance (Num u, InnerSpace u, u ~ Scalar u)
=> InnerSpace (Vec2 u) where
(V2 a b) <.> (V2 a' b') = (a <.> a') ^+^ (b <.> b')
instance Num u => AffineSpace (Point2 u) where
type Diff (Point2 u) = Vec2 u
(P2 a b) .-. (P2 x y) = V2 (a-x) (b-y)
(P2 a b) .+^ (V2 vx vy) = P2 (a+vx) (b+vy)
instance Num u => AdditiveGroup (Matrix3'3 u) where
zeroV = fromInteger 0
(^+^) = (+)
negateV = negate
instance Num u => VectorSpace (Matrix3'3 u) where
type Scalar (Matrix3'3 u) = u
s *^ m = fmap (s*) m
--------------------------------------------------------------------------------
-- Matrix multiply
infixr 7 *#
-- | Matrix multiplication - typically of points and vectors
-- represented as homogeneous coordinates.
--
class MatrixMult t where
(*#) :: DUnit t ~ u => Matrix3'3 u -> t -> t
instance Num u => MatrixMult (Vec2 u) where
(M3'3 a b c d e f _ _ _) *# (V2 m n) = V2 (a*m+b*n+c*0) (d*m+e*n+f*0)
instance Num u => MatrixMult (Point2 u) where
(M3'3 a b c d e f _ _ _) *# (P2 m n) = P2 (a*m+b*n+c*1) (d*m+e*n+f*1)
--------------------------------------------------------------------------------
-- UNil
-- | Construct a UNil.
--
uNil :: UNil u
uNil = UNil ()
--------------------------------------------------------------------------------
-- Vectors
-- | 'vec' - a synonym for the constructor 'V2' with a Num
-- constraint on the arguments.
--
-- Essentially superfluous, but it can be slightly more
-- typographically pleasant when used in lists of vectors:
--
-- > [ vec 2 2, vvec 4, hvec 4, vec 2 2 ]
--
-- Versus:
--
-- > [ V2 2 2, vvec 4, hvec 4, V2 2 2 ]
--
vec :: Num u => u -> u -> Vec2 u
vec = V2
-- | Construct a vector with horizontal displacement.
--
hvec :: Num u => u -> Vec2 u
hvec d = V2 d 0
-- | Construct a vector with vertical displacement.
--
vvec :: Num u => u -> Vec2 u
vvec d = V2 0 d
-- | Construct a vector from an angle and magnitude.
--
avec :: Floating u => Radian -> u -> Vec2 u
avec theta d = V2 x y
where
ang = fromRadian theta
x = d * cos ang
y = d * sin ang
-- | The vector between two points
--
-- > pvec = flip (.-.)
--
pvec :: Num u => Point2 u -> Point2 u -> Vec2 u
pvec = flip (.-.)
-- | Reverse a vector.
--
vreverse :: Num u => Vec2 u -> Vec2 u
vreverse (V2 x y) = V2 (-x) (-y)
-- | Direction of a vector - i.e. the counter-clockwise angle
-- from the x-axis.
--
direction :: (Floating u, Real u) => Vec2 u -> Radian
direction (V2 x y) = lineDirection (P2 0 0) (P2 x y)
-- | Length of a vector.
--
vlength :: Floating u => Vec2 u -> u
vlength (V2 x y) = sqrt $ x*x + y*y
-- | Extract the angle between two vectors.
--
vangle :: (Floating u, Real u, InnerSpace (Vec2 u))
=> Vec2 u -> Vec2 u -> Radian
vangle u v = realToFrac $ acos $ (u <.> v) / (magnitude u * magnitude v)
--------------------------------------------------------------------------------
-- Points
-- | Construct a point at (0,0).
--
zeroPt :: Num u => Point2 u
zeroPt = P2 0 0
-- | /Component-wise/ min on points.
-- Standard 'min' and 'max' via Ord are defined lexographically
-- on pairs, e.g.:
--
-- > min (1,2) (2,1) = (1,2)
--
-- For Points we want the component-wise min and max, e.g:
--
-- > minPt (P2 1 2) (Pt 2 1) = Pt 1 1
-- > maxPt (P2 1 2) (Pt 2 1) = Pt 2 2
--
minPt :: Ord u => Point2 u -> Point2 u -> Point2 u
minPt (P2 x y) (P2 x' y') = P2 (min x x') (min y y')
-- | /Component-wise/ max on points.
--
-- > maxPt (P2 1 2) (Pt 2 1) = Pt 2 2
--
maxPt :: Ord u => Point2 u -> Point2 u -> Point2 u
maxPt (P2 x y) (P2 x' y') = P2 (max x x') (max y y')
-- | Calculate the counter-clockwise angle between two points
-- and the x-axis.
--
lineDirection :: (Floating u, Real u) => Point2 u -> Point2 u -> Radian
lineDirection (P2 x1 y1) (P2 x2 y2) = step (x2 - x1) (y2 - y1)
where
-- north-east quadrant
step x y | pve x && pve y = toRadian $ atan (y/x)
-- north-west quadrant
step x y | pve y = pi - (toRadian $ atan (y / abs x))
-- south-east quadrant
step x y | pve x = (2*pi) - (toRadian $ atan (abs y / x))
-- otherwise... south-west quadrant
step x y = pi + (toRadian $ atan (y/x))
pve a = signum a >= 0
--------------------------------------------------------------------------------
-- Matrix construction
-- | Construct the identity matrix:
--
-- > (M3'3 1 0 0
-- > 0 1 0
-- > 0 0 1 )
--
identityMatrix :: Num u => Matrix3'3 u
identityMatrix = M3'3 1 0 0
0 1 0
0 0 1
-- Common transformation matrices (for 2d homogeneous coordinates)
-- | Construct a scaling matrix:
--
-- > (M3'3 sx 0 0
-- > 0 sy 0
-- > 0 0 1 )
--
scalingMatrix :: Num u => u -> u -> Matrix3'3 u
scalingMatrix sx sy = M3'3 sx 0 0
0 sy 0
0 0 1
-- | Construct a translation matrix:
--
-- > (M3'3 1 0 x
-- > 0 1 y
-- > 0 0 1 )
--
translationMatrix :: Num u => u -> u -> Matrix3'3 u
translationMatrix x y = M3'3 1 0 x
0 1 y
0 0 1
-- | Construct a rotation matrix:
--
-- > (M3'3 cos(a) -sin(a) 0
-- > sin(a) cos(a) 0
-- > 0 0 1 )
--
rotationMatrix :: (Floating u, Real u) => Radian -> Matrix3'3 u
rotationMatrix a = M3'3 (cos ang) (negate $ sin ang) 0
(sin ang) (cos ang) 0
0 0 1
where ang = fromRadian a
-- No reflectionMatrix function
-- A reflection about the x-axis is a scale of 1 (-1)
-- A reflection about the y-axis is a scale of (-1) 1
-- | Construct a matrix for rotation about some /point/.
--
-- This is the product of three matrices: T R T^-1
--
-- (T being the translation matrix, R the rotation matrix and
-- T^-1 the inverse of the translation matrix).
--
originatedRotationMatrix :: (Floating u, Real u)
=> Radian -> (Point2 u) -> Matrix3'3 u
originatedRotationMatrix ang (P2 x y) = mT * (rotationMatrix ang) * mTinv
where
mT = M3'3 1 0 x
0 1 y
0 0 1
mTinv = M3'3 1 0 (-x)
0 1 (-y)
0 0 1
--------------------------------------------------------------------------------
-- Matrix ops
-- | Invert a matrix.
--
invert :: Fractional u => Matrix3'3 u -> Matrix3'3 u
invert m = (1 / determinant m) *^ adjoint m
-- | Determinant of a matrix.
--
determinant :: Num u => Matrix3'3 u -> u
determinant (M3'3 a b c d e f g h i) = a*e*i - a*f*h - b*d*i + b*f*g + c*d*h - c*e*g
-- | Transpose a matrix.
--
transpose :: Matrix3'3 u -> Matrix3'3 u
transpose (M3'3 a b c
d e f
g h i) = M3'3 a d g
b e h
c f i
-- Helpers
adjoint :: Num u => Matrix3'3 u -> Matrix3'3 u
adjoint = transpose . cofactor . mofm
cofactor :: Num u => Matrix3'3 u -> Matrix3'3 u
cofactor (M3'3 a b c
d e f
g h i) = M3'3 a (-b) c
(-d) e (-f)
g (-h) i
mofm :: Num u => Matrix3'3 u -> Matrix3'3 u
mofm (M3'3 a b c
d e f
g h i) = M3'3 m11 m12 m13
m21 m22 m23
m31 m32 m33
where
m11 = (e*i) - (f*h)
m12 = (d*i) - (f*g)
m13 = (d*h) - (e*g)
m21 = (b*i) - (c*h)
m22 = (a*i) - (c*g)
m23 = (a*h) - (b*g)
m31 = (b*f) - (c*e)
m32 = (a*f) - (c*d)
m33 = (a*e) - (b*d)
--------------------------------------------------------------------------------
-- Radians
-- | The epislion used for floating point equality on radians.
--
radian_epsilon :: Double
radian_epsilon = 0.0001
-- | Equality on radians, this is the operation used for (==) in
-- Radian\'s Eq instance.
--
req :: Radian -> Radian -> Bool
req a b = (fromRadian $ abs (a-b)) < radian_epsilon
-- | Convert to radians.
--
toRadian :: Real a => a -> Radian
toRadian = Radian . realToFrac
-- | Convert from radians.
--
fromRadian :: Fractional a => Radian -> a
fromRadian = realToFrac . getRadian
-- | Degrees to radians.
--
d2r :: (Floating a, Real a) => a -> Radian
d2r = Radian . realToFrac . (*) (pi/180)
-- | Radians to degrees.
--
r2d :: (Floating a, Real a) => Radian -> a
r2d = (*) (180/pi) . fromRadian
-- | Modulo a (positive) angle into the range @0..2*pi@.
--
circularModulo :: Radian -> Radian
circularModulo r = d2r $ dec + (fromIntegral $ i `mod` 360)
where
i :: Integer
dec :: Double
(i,dec) = properFraction $ r2d r
--------------------------------------------------------------------------------
-- Bezier curves
-- | 'bezierArc' : @ radius * ang1 * ang2 * center ->
-- (start_point, control_point1, control_point2, end_point) @
--
-- Create an arc - this construction is the analogue of
-- PostScript\'s @arc@ command, but the arc is created as a
-- Bezier curve so it should span less than 90deg.
--
-- CAVEAT - ang2 must be greater than ang1
--
bezierArc :: Floating u
=> u -> Radian -> Radian -> Point2 u
-> (Point2 u, Point2 u, Point2 u, Point2 u)
bezierArc r ang1 ang2 pt = (p0,p1,p2,p3)
where
theta = ang2 - ang1
e = r * fromRadian ((2 * sin (theta/2)) / (1+ 2* cos (theta/2)))
p0 = pt .+^ avec ang1 r
p1 = p0 .+^ avec (ang1 + pi/2) e
p2 = p3 .+^ avec (ang2 - pi/2) e
p3 = pt .+^ avec ang2 r
-- | 'bezierCircle' : @ n * radius * center -> [Point] @
--
-- Make a circle from Bezier curves - @n@ is the number of
-- subdivsions per quadrant.
--
bezierCircle :: (Fractional u, Floating u)
=> Int -> u -> Point2 u -> [Point2 u]
bezierCircle n radius pt = start $ subdivisions (n*4) (2*pi)
where
start (a:b:xs) = s : cp1 : cp2 : e : rest (b:xs)
where (s,cp1,cp2,e) = bezierArc radius a b pt
start _ = []
rest (a:b:xs) = cp1 : cp2 : e : rest (b:xs)
where (_,cp1,cp2,e) = bezierArc radius a b pt
rest _ = []
subdivisions i a = 0 : take i (iterate (+one) one)
where one = a / fromIntegral i