src/Gargantext/Core/Methods/Similarities.hs

   1 {-|
   2 Module      : Gargantext.Graph.Similarities
   3 Description : Similarity management tools
   4 Copyright   : (c) CNRS, 2017-Present
   5 License     : AGPL + CECILL v3
   6 Maintainer  : team@gargantext.org
   7 Stability   : experimental
   8 Portability : POSIX
   9
  10 -}
  11
  12 {-# LANGUAGE Strict            #-}
  13
  14 module Gargantext.Core.Methods.Similarities
  15   where
  16
  17 import Data.Aeson
  18 import Data.Array.Accelerate (Matrix)
  19 import Data.Swagger
  20 import GHC.Generics (Generic)
  21 import Gargantext.Core.Methods.Similarities.Accelerate.Conditional (measureConditional)
  22 import Gargantext.Core.Methods.Similarities.Accelerate.Distributional (logDistributional)
  23 import Gargantext.Prelude (Ord, Eq, Int, Double, Show)
  24 import Prelude (Enum, Bounded, minBound, maxBound)
  25 import Test.QuickCheck (elements)
  26 import Test.QuickCheck.Arbitrary
  27
  28 ------------------------------------------------------------------------
  29 data Similarity = Conditional | Distributional
  30   deriving (Show, Eq)
  31
  32 measure :: Similarity -> Matrix Int -> Matrix Double
  33 measure Conditional    x = measureConditional x
  34 measure Distributional x = y
  35   where
  36     y = logDistributional x
  37
  38 ------------------------------------------------------------------------
  39 withMetric :: GraphMetric -> Similarity
  40 withMetric Order1 = Conditional
  41 withMetric Order2 = Distributional
  42
  43 ------------------------------------------------------------------------
  44 data GraphMetric = Order1 | Order2
  45     deriving (Generic, Eq, Ord, Enum, Bounded, Show)
  46
  47 instance FromJSON  GraphMetric
  48 instance ToJSON    GraphMetric
  49 instance ToSchema  GraphMetric
  50 instance Arbitrary GraphMetric where
  51   arbitrary = elements [ minBound .. maxBound ]
  52
  53 ------------------------------------------------------------------------
  54