diff --git a/CHANGELOG.md b/CHANGELOG.md --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -24,3 +24,7 @@ * Fifth version. Fixed issues with the unsafeSwapVecIWithMaxI. Changed the described semantics of the functions. Please, check the updated documentation. Added new variant of the function unsafeRearrangeIG. +## 0.6.0.0 -- 2023-01-31 + +* Sixth version. Switched to NoImplicitPrelude and Strict extensions. Some code improvements. Removed the deprecated duplicate function. Updated the dependencies boundaries. + diff --git a/LICENSE b/LICENSE --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -Copyright (c) 2020-2022 OleksandrZhabenko +Copyright (c) 2020-2023 Oleksandr Zhabenko Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the diff --git a/Phladiprelio/Filters.hs b/Phladiprelio/Filters.hs new file mode 100644 --- /dev/null +++ b/Phladiprelio/Filters.hs @@ -0,0 +1,102 @@ +-- | +-- Module : Phladiprelio.Filters +-- Copyright : (c) OleksandrZhabenko 2020-2023 +-- License : MIT +-- Stability : Experimental +-- Maintainer : oleksandr.zhabenko@yahoo.com +-- +-- A module allows to change the structure of the function output for the functions of +-- elements from 'RealFrac' class. At the moment only the equal intervals are supported. +-- Uses less dependencies than its former analogue package @uniqueness-periods-vector-filters@. +-- +{-# LANGUAGE NoImplicitPrelude #-} +{-# LANGUAGE Strict #-} +{-# OPTIONS_HADDOCK -show-extensions #-} + +module Phladiprelio.Filters ( + -- * One interval used + intervalNRealFrac + , unsafeTransfer1I5 + , transfer1IEq3 + -- * Several intervals + , unsafeRearrangeIG + , unsafeRearrangeIGArr + , unsafeRearrangeIGV + -- * Some basic usage examples + , unsafeSwapIWithMaxI +) where + +import GHC.Base +import GHC.Num ((+),(-),(*),abs) +import GHC.Real +import GHC.Int +import Data.Filters.Basic +import GHC.Arr +import CaseBi.Arr +import GHC.List +import Data.List (sort) + +-- | Makes a complex interval-based transformation moving the value from its own interval to the corresponding by the list of tuples second element of the +-- respective pair with the first element being the starting number of the interval (numeration of them begins at 1). +-- Usually, its first elements in the tuples are from the range @[1..n]@. Number of the intervals are given as +-- the third argument and for many cases should not be greater than 10. There do exist several semantical constraints for the possible accurate arguments, +-- but they are not checked. For example, the first argument must be less than the second one; the fifth argument must be located between the first two ones; +-- the third argument must be greater than zero. +unsafeRearrangeIG + :: (RealFrac b, Integral c) => b + -> b + -> c + -> [(c,c)] -- ^ Must be finite and expected to be not empty, elements must have all different by the first element tuples. + -> b + -> b +unsafeRearrangeIG minE maxE n xs x + | abs (minE - maxE) < 0.00000001 = x + | otherwise = x + fromIntegral (getBFstL' n0 xs n0 - n0) * (maxE - minE) / fromIntegral n + where n0 = intervalNRealFrac minE maxE n x + +-- | The more optimized variant of the 'unsafeRearrangeIG', but the 'Array' must be sorted +-- in the ascending order by the first element in the tuples. +unsafeRearrangeIGArr + :: (RealFrac b, Integral c) => b + -> b + -> c + -> Array Int (c,c) -- ^ Must be sorted in the ascending order by the first elements in the tuples and finite + -> b + -> b +unsafeRearrangeIGArr minE maxE n arr x + | abs (minE - maxE) < 0.00000001 = x + | otherwise = x + fromIntegral (getBFst' (n0, arr) n0 - n0) * (maxE - minE) / fromIntegral n + where n0 = intervalNRealFrac minE maxE n x + + +-- | An unzipped variant of the 'unsafeRearrangeIG' function where the list argument is internally 'zip'ped as the second argument with the @[1..n]@. +-- This allows to shorten the time of the arguments writing. +unsafeRearrangeIGV + :: (RealFrac b, Integral c, Ord c) => b + -> b + -> c + -> [c] -- ^ Must be not empty and finite, the elements here greater or equal than the third argument are neglected. + -> b + -> b +unsafeRearrangeIGV minE maxE n xs = unsafeRearrangeIGArr minE maxE n arr + where ts = f . sort . filter ( b + -> b + -> c -- ^ It is expected to be greater than 0, though this is not checked. + -> c -- ^ It is expected to be less than the previous argument, but greater than 0, though this is not checked. + -> b -- ^ It is expected to lie between the first two arguments, though this is not checked. + -> b +unsafeSwapIWithMaxI minE maxE n k = unsafeRearrangeIG minE maxE n [(k,n),(n,k)] +{-# INLINE unsafeSwapIWithMaxI #-} + diff --git a/Phonetic/Languages/Filters.hs b/Phonetic/Languages/Filters.hs deleted file mode 100644 --- a/Phonetic/Languages/Filters.hs +++ /dev/null @@ -1,110 +0,0 @@ --- | --- Module : Phonetic.Languages.Filters --- Copyright : (c) OleksandrZhabenko 2020-2022 --- License : MIT --- Stability : Experimental --- Maintainer : olexandr543@yahoo.com --- --- A module allows to change the structure of the function output for the functions of --- elements from 'RealFrac' class. At the moment only the equal intervals are supported. --- Uses less dependencies than its former analogue package @uniqueness-periods-vector-filters@. --- - -module Phonetic.Languages.Filters ( - -- * One interval used - intervalNRealFrac - , unsafeTransfer1I5 - , transfer1IEq3 - -- * Several intervals - , unsafeRearrangeIG - , unsafeRearrangeIGArr - , unsafeRearrangeIGV - -- * Some basic usage examples - , unsafeSwapIWithMaxI - , unsafeSwapVecIWithMaxI -) where - -import Data.Filters.Basic -import GHC.Arr -import CaseBi.Arr -import Data.Monoid (mappend) -import Data.List (sort) - --- | Makes a complex interval-based transformation moving the value from its own interval to the corresponding by the list of tuples second element of the --- respective pair with the first element being the starting number of the interval (numeration of them begins at 1). --- Usually, its first elements in the tuples are from the range @[1..n]@. Number of the intervals are given as --- the third argument and for many cases should not be greater than 10. There do exist several semantical constraints for the possible accurate arguments, --- but they are not checked. For example, the first argument must be less than the second one; the fifth argument must be located between the first two ones; --- the third argument must be greater than zero. -unsafeRearrangeIG - :: (RealFrac b, Integral c) => b - -> b - -> c - -> [(c,c)] -- ^ Must be finite and expected to be not empty, elements must have all different by the first element tuples. - -> b - -> b -unsafeRearrangeIG minE maxE n xs x - | minE == maxE = x - | otherwise = x + fromIntegral (getBFstL' n0 xs n0 - n0) * (maxE - minE) / fromIntegral n - where n0 = intervalNRealFrac minE maxE n x - --- | The more optimized variant of the 'unsafeRearrangeIG', but the 'Array' must be sorted --- in the ascending order by the first element in the tuples. -unsafeRearrangeIGArr - :: (RealFrac b, Integral c) => b - -> b - -> c - -> Array Int (c,c) -- ^ Must be sorted in the ascending order by the first elements in the tuples and finite - -> b - -> b -unsafeRearrangeIGArr minE maxE n arr x - | minE == maxE = x - | otherwise = x + fromIntegral (getBFst' (n0, arr) n0 - n0) * (maxE - minE) / fromIntegral n - where n0 = intervalNRealFrac minE maxE n x - - --- | An unzipped variant of the 'unsafeRearrangeIG' function where the list argument is internally 'zip'ped as the second argument with the @[1..n]@. --- This allows to shorten the time of the arguments writing. -unsafeRearrangeIGV - :: (RealFrac b, Integral c, Ord c) => b - -> b - -> c - -> [c] -- ^ Must be not empty and finite, the elements here greater or equal than the third argument are neglected. - -> b - -> b -unsafeRearrangeIGV minE maxE n xs = unsafeRearrangeIGArr minE maxE n arr - where ts = f . sort . filter ( b - -> b - -> c -- ^ It is expected to be greater than 0, though this is not checked. - -> c -- ^ It is expected to be less than the previous argument, but greater than 0, though this is not checked. - -> b -- ^ It is expected to lie between the first two arguments, though this is not checked. - -> b -unsafeSwapIWithMaxI minE maxE n k = unsafeRearrangeIG minE maxE n [(k,n),(n,k)] -{-# INLINE unsafeSwapIWithMaxI #-} - --- | Swaps the inner intervals values (given by the list of elements of the data type that has an instance of the --- 'Integral' class that represent numbers-indices starting from 1 to n) with the maximum one's --- (that is the n-th one) values. The list must be not empty and sorted in the ascending order, though it is not checked. Be aware that this can --- significantly change the density of the values and break some other properties for distributions. -unsafeSwapVecIWithMaxI - :: (RealFrac b, Integral c, Ord c) => b - -> b - -> c -- ^ It is expected to be greater than 0, though this is not checked. - -> [c] -- ^ It is expected the non-empty finite list (indices are counted in it starting with 1 opposed to the usual behaviour for lists) and numbers here should be the numbers of the intervals less than n. - -> b -- ^ It is expected to be less than the second argument (if it expected to be probably changed). - -> b -unsafeSwapVecIWithMaxI = unsafeRearrangeIGV -{-# INLINE unsafeSwapVecIWithMaxI #-} -{-# DEPRECATED unsafeSwapVecIWithMaxI "Is provided here for the compatibility with the previous ones versions. Please, use just 'unsafeRearrangeIGV' instead" #-} diff --git a/phonetic-languages-filters-array.cabal b/phonetic-languages-filters-array.cabal --- a/phonetic-languages-filters-array.cabal +++ b/phonetic-languages-filters-array.cabal @@ -2,14 +2,14 @@ -- For further documentation, see http://haskell.org/cabal/users-guide/ name: phonetic-languages-filters-array -version: 0.5.0.0 +version: 0.6.0.0 synopsis: Allows to change the structure of the function output. description: Allows to change the structure of the function output for the data types that have instances of the RealFrac class. Is rewritten from the predecessor uniqueness-periods-vector-filters package. homepage: https://hackage.haskell.org/package/phonetic-languages-filters-array license: MIT license-file: LICENSE author: OleksandrZhabenko -maintainer: olexandr543@yahoo.com +maintainer: oleksandr.zhabenko@yahoo.com copyright: Oleksandr Zhabenko category: Data build-type: Simple @@ -17,9 +17,9 @@ cabal-version: >=1.10 library - exposed-modules: Phonetic.Languages.Filters + exposed-modules: Phladiprelio.Filters -- other-modules: - -- other-extensions: - build-depends: base >=4.8 && <5, filters-basic ==0.1.1.0, mmsyn2-array == 0.3.0.0 + other-extensions: NoImplicitPrelude, Strict + build-depends: base >=4.13 && <5, filters-basic ==0.2.0.0, mmsyn2-array == 0.3.1.1 -- hs-source-dirs: default-language: Haskell2010