diff --git a/ChangeLog.md b/ChangeLog.md new file mode 100644 --- /dev/null +++ b/ChangeLog.md @@ -0,0 +1,5 @@ +# Revision history for numbered-semigroups + +## 0.1.0.0 -- YYYY-mm-dd + +* First version. Released on an unsuspecting world. diff --git a/Data/Semigroup/Numbered.hs b/Data/Semigroup/Numbered.hs new file mode 100644 --- /dev/null +++ b/Data/Semigroup/Numbered.hs @@ -0,0 +1,168 @@ +-- | +-- Module : Data.Semigroup.Numbered +-- Copyright : (c) Justus Sagemüller 2017 +-- License : LGPL v3 +-- +-- Maintainer : (@) jsagemue $ uni-koeln.de +-- Stability : experimental +-- Portability : portable +-- + +{-# LANGUAGE DataKinds, KindSignatures #-} +{-# LANGUAGE MultiParamTypeClasses #-} +{-# LANGUAGE ConstraintKinds #-} +{-# LANGUAGE FlexibleContexts #-} +{-# LANGUAGE FlexibleInstances #-} + +module Data.Semigroup.Numbered ( SemigroupNo(..) + -- * The common directions + , SemigroupX, SemigroupY, SemigroupZ + -- * Infix ops (diagrams/hmatrix style) + , (|||), (===) + -- * Infix ops (ASCII-art style) + , (│), (──), (■), (┃), (━━), (██) + ) where + +import GHC.TypeLits +import qualified Data.List.NonEmpty as NE +import Data.Foldable + +import Data.Proxy +import Data.Void + +import Data.CallStack (HasCallStack) + +class SemigroupNo (n :: Nat) g where + sappendN :: proxy n -> g -> g -> g + sappendN p x y = sconcatN p $ x NE.:|[y] + + sconcatN :: proxy n -> NE.NonEmpty g -> g + sconcatN = foldr1 . sappendN + + stimesN :: (Integral b, HasCallStack) => proxy n -> b -> g -> g + -- Adapted from + -- http://hackage.haskell.org/package/base-4.10.0.0/docs/src/Data.Semigroup.html#Semigroup + stimesN p y₀ x₀ + | y₀ <= 0 = error "stimesN: positive multiplier expected" + | otherwise = f x₀ y₀ + where + f x y + | even y = f (x <> x) (y `quot` 2) + | y == 1 = x + | otherwise = g (x <> x) (pred y `quot` 2) x + g x y z + | even y = g (x <> x) (y `quot` 2) z + | y == 1 = x <> z + | otherwise = g (x <> x) (pred y `quot` 2) (x <> z) + (<>) = sappendN p + +instance (SemigroupNo n g) => SemigroupNo n (a -> g) where + sappendN p f g x = sappendN p (f x) (g x) + sconcatN p fs x = sconcatN p $ ($x)<$>fs + stimesN p n f = stimesN p n . f + +instance (SemigroupNo n g) => SemigroupNo n (Maybe g) where + sappendN _ Nothing b = b + sappendN _ a Nothing = a + sappendN p (Just a) (Just b) = Just $ sappendN p a b + stimesN _ _ Nothing = Nothing + stimesN p n (Just a) = Just $ stimesN p n a + +instance SemigroupNo n () where + sappendN _ () () = () + sconcatN _ _ = () + stimesN _ _ () = () + +instance SemigroupNo n (Proxy x) where + sappendN _ Proxy Proxy = Proxy + sconcatN _ _ = Proxy + stimesN _ _ Proxy = Proxy + +instance SemigroupNo n Void where + sappendN _ = absurd + stimesN _ _ = absurd + +instance SemigroupNo 0 [Void] where sappendN _ [] [] = [] +instance SemigroupNo 0 [()] where sappendN _ = (++) +instance SemigroupNo 0 [Char] where sappendN _ = (++) +instance SemigroupNo 0 [Int] where sappendN _ = (++) +instance SemigroupNo 0 [Integer] where sappendN _ = (++) +instance SemigroupNo 0 [Float] where sappendN _ = (++) +instance SemigroupNo 0 [Double] where sappendN _ = (++) +instance SemigroupNo 0 [Rational] where sappendN _ = (++) +instance SemigroupNo 0 [Maybe a] where sappendN _ = (++) +instance (SemigroupNo 0 [a]) => SemigroupNo 0 [[a]] where + sappendN _ [] ys = ys + sappendN _ xs [] = xs + sappendN p (x:xs) (y:ys) = sappendN p x y : sappendN p xs ys + +instance SemigroupNo 1 [[Void]] where sappendN _ = (++) +instance SemigroupNo 1 [[()]] where sconcatN _ = paddedLines () . concat +instance SemigroupNo 1 [[Char]] where sconcatN _ = paddedLines ' ' . concat +instance SemigroupNo 1 [[Int]] where sconcatN _ = paddedLines 0 . concat +instance SemigroupNo 1 [[Integer]] where sconcatN _ = paddedLines 0 . concat +instance SemigroupNo 1 [[Float]] where sconcatN _ = paddedLines 0 . concat +instance SemigroupNo 1 [[Double]] where sconcatN _ = paddedLines 0 . concat +instance SemigroupNo 1 [[Rational]] where sconcatN _ = paddedLines 0 . concat +instance SemigroupNo 1 [[Maybe a]] where sconcatN _ = paddedLines Nothing . concat +instance (SemigroupNo 1 [[a]]) => SemigroupNo 1 [[[a]]] where + sappendN _ [] ys = ys + sappendN _ xs [] = xs + sappendN p (x:xs) (y:ys) = sappendN p x y : sappendN p xs ys + +paddedLines :: a -> [[a]] -> [[a]] +paddedLines padr xs = mkPadded <$> xs + where mkPadded cs = cs ++ replicate (paddingLen - length cs) padr + paddingLen = maximum $ length <$> xs + +type SemigroupX = SemigroupNo 0 + +infixr 6 │ +-- | Horizontal concatenation. Fixity as of +-- . +-- +-- @U+2502@ / Vim digraph @vv@. +(│) :: SemigroupX g => g -> g -> g +(│) = sappendN (Proxy :: Proxy 0) + +infixr 3 ┃ +-- | Horizontal concatenation. @U+2503@ / Vim digraph @VV@. +(┃) :: SemigroupX g => g -> g -> g +(┃) = sappendN (Proxy :: Proxy 0) + +infixl 6 ||| +-- | Horizontal concatenation. Fixity as +-- . +(|||) :: SemigroupX g => g -> g -> g +(|||) = sappendN (Proxy :: Proxy 0) + +type SemigroupY = SemigroupNo 1 + +infixr 5 ── +-- | Vertical concatenation. @U+2500@ / Vim digraph @hh@. +(──) :: SemigroupY g => g -> g -> g +(──) = sappendN (Proxy :: Proxy 1) + +infixr 2 ━━ +-- | Vertical concatenation. @U+2501@ / Vim digraph @HH@. +(━━) :: SemigroupY g => g -> g -> g +(━━) = sappendN (Proxy :: Proxy 1) + +infixl 6 === +-- | Vertical concatenation. Fixity as +-- . +(===) :: SemigroupY g => g -> g -> g +(===) = sappendN (Proxy :: Proxy 1) + +type SemigroupZ = SemigroupNo 2 + +infixr 4 ■ +-- | z-concatenation. @U+25A0@ / Vim digraph @fS@. +(■) :: SemigroupZ g => g -> g -> g +(■) = sappendN (Proxy :: Proxy 2) + +infixr 1 ██ +-- | z-concatenation. @U+254B@ / Vim digraph @FB@. +(██) :: SemigroupZ g => g -> g -> g +(██) = sappendN (Proxy :: Proxy 2) + diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,165 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/numbered-semigroups.cabal b/numbered-semigroups.cabal new file mode 100644 --- /dev/null +++ b/numbered-semigroups.cabal @@ -0,0 +1,34 @@ +-- Initial numbered-semigroups.cabal generated by cabal init. For further +-- documentation, see http://haskell.org/cabal/users-guide/ + +name: numbered-semigroups +version: 0.1.0.0 +synopsis: A sequence of semigroups, for composing stuff in multiple spatial directions. +description: Some types are composable in multiple “directions”, either in + a literal sense ( + can be stacked vertically, as well as layed out side-by-side) + or in an abstraction (matrices etc.). This package offers a whole + sequence of semigroup-classes, numbered by type-literals, as + a unified interface for composition of such types. It also has + a bunch of standardised operators for writing out the compositions + in a snug way. +homepage: https://github.com/leftaroundabout/numbered-semigroups +license: LGPL-3 +license-file: LICENSE +author: Justus Sagemüller +maintainer: (@) jsagemue $ uni-koeln.de +-- copyright: +category: Data +build-type: Simple +extra-source-files: ChangeLog.md +cabal-version: >=1.10 + +library + exposed-modules: Data.Semigroup.Numbered + -- other-modules: + -- other-extensions: + build-depends: base >=4.8 && <4.11 + , semigroups + , call-stack + -- hs-source-dirs: + default-language: Haskell2010