short-vec-lens (empty) → 0.1.0.0
raw patch · 4 files changed
+482/−0 lines, 4 filesdep +basedep +fin-intdep +indexed-traversable
Dependencies added: base, fin-int, indexed-traversable, lens, short-vec, sint
Files
- CHANGELOG.md +3/−0
- LICENSE +202/−0
- short-vec-lens.cabal +46/−0
- src/Data/Vec/Short/Lens.hs +231/−0
+ CHANGELOG.md view
@@ -0,0 +1,3 @@+# 0.1.0.0++Initial version.
+ LICENSE view
@@ -0,0 +1,202 @@++ Apache License+ Version 2.0, January 2004+ http://www.apache.org/licenses/++ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION++ 1. Definitions.++ "License" shall mean the terms and conditions for use, reproduction,+ and distribution as defined by Sections 1 through 9 of this document.++ "Licensor" shall mean the copyright owner or entity authorized by+ the copyright owner that is granting the License.++ "Legal Entity" shall mean the union of the acting entity and all+ other entities that control, are controlled by, or are under common+ control with that entity. For the purposes of this definition,+ "control" means (i) the power, direct or indirect, to cause the+ direction or management of such entity, whether by contract or+ otherwise, or (ii) ownership of fifty percent (50%) or more of the+ outstanding shares, or (iii) beneficial ownership of such entity.++ "You" (or "Your") shall mean an individual or Legal Entity+ exercising permissions granted by this License.++ "Source" form shall mean the preferred form for making modifications,+ including but not limited to software source code, documentation+ source, and configuration files.++ "Object" form shall mean any form resulting from mechanical+ transformation or translation of a Source form, including but+ not limited to compiled object code, generated documentation,+ and conversions to other media types.++ "Work" shall mean the work of authorship, whether in Source or+ Object form, made available under the License, as indicated by a+ copyright notice that is included in or attached to the work+ (an example is provided in the Appendix below).++ "Derivative Works" shall mean any work, whether in Source or Object+ form, that is based on (or derived from) the Work and for which the+ editorial revisions, annotations, elaborations, or other modifications+ represent, as a whole, an original work of authorship. For the purposes+ of this License, Derivative Works shall not include works that remain+ separable from, or merely link (or bind by name) to the interfaces of,+ the Work and Derivative Works thereof.++ "Contribution" shall mean any work of authorship, including+ the original version of the Work and any modifications or additions+ to that Work or Derivative Works thereof, that is intentionally+ submitted to Licensor for inclusion in the Work by the copyright owner+ or by an individual or Legal Entity authorized to submit on behalf of+ the copyright owner. For the purposes of this definition, "submitted"+ means any form of electronic, verbal, or written communication sent+ to the Licensor or its representatives, including but not limited to+ communication on electronic mailing lists, source code control systems,+ and issue tracking systems that are managed by, or on behalf of, the+ Licensor for the purpose of discussing and improving the Work, but+ excluding communication that is conspicuously marked or otherwise+ designated in writing by the copyright owner as "Not a Contribution."++ "Contributor" shall mean Licensor and any individual or Legal Entity+ on behalf of whom a Contribution has been received by Licensor and+ subsequently incorporated within the Work.++ 2. Grant of Copyright License. Subject to the terms and conditions of+ this License, each Contributor hereby grants to You a perpetual,+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable+ copyright license to reproduce, prepare Derivative Works of,+ publicly display, publicly perform, sublicense, and distribute the+ Work and such Derivative Works in Source or Object form.++ 3. Grant of Patent License. Subject to the terms and conditions of+ this License, each Contributor hereby grants to You a perpetual,+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable+ (except as stated in this section) patent license to make, have made,+ use, offer to sell, sell, import, and otherwise transfer the Work,+ where such license applies only to those patent claims licensable+ by such Contributor that are necessarily infringed by their+ Contribution(s) alone or by combination of their Contribution(s)+ with the Work to which such Contribution(s) was submitted. If You+ institute patent litigation against any entity (including a+ cross-claim or counterclaim in a lawsuit) alleging that the Work+ or a Contribution incorporated within the Work constitutes direct+ or contributory patent infringement, then any patent licenses+ granted to You under this License for that Work shall terminate+ as of the date such litigation is filed.++ 4. Redistribution. You may reproduce and distribute copies of the+ Work or Derivative Works thereof in any medium, with or without+ modifications, and in Source or Object form, provided that You+ meet the following conditions:++ (a) You must give any other recipients of the Work or+ Derivative Works a copy of this License; and++ (b) You must cause any modified files to carry prominent notices+ stating that You changed the files; and++ (c) You must retain, in the Source form of any Derivative Works+ that You distribute, all copyright, patent, trademark, and+ attribution notices from the Source form of the Work,+ excluding those notices that do not pertain to any part of+ the Derivative Works; and++ (d) If the Work includes a "NOTICE" text file as part of its+ distribution, then any Derivative Works that You distribute must+ include a readable copy of the attribution notices contained+ within such NOTICE file, excluding those notices that do not+ pertain to any part of the Derivative Works, in at least one+ of the following places: within a NOTICE text file distributed+ as part of the Derivative Works; within the Source form or+ documentation, if provided along with the Derivative Works; or,+ within a display generated by the Derivative Works, if and+ wherever such third-party notices normally appear. The contents+ of the NOTICE file are for informational purposes only and+ do not modify the License. You may add Your own attribution+ notices within Derivative Works that You distribute, alongside+ or as an addendum to the NOTICE text from the Work, provided+ that such additional attribution notices cannot be construed+ as modifying the License.++ You may add Your own copyright statement to Your modifications and+ may provide additional or different license terms and conditions+ for use, reproduction, or distribution of Your modifications, or+ for any such Derivative Works as a whole, provided Your use,+ reproduction, and distribution of the Work otherwise complies with+ the conditions stated in this License.++ 5. Submission of Contributions. Unless You explicitly state otherwise,+ any Contribution intentionally submitted for inclusion in the Work+ by You to the Licensor shall be under the terms and conditions of+ this License, without any additional terms or conditions.+ Notwithstanding the above, nothing herein shall supersede or modify+ the terms of any separate license agreement you may have executed+ with Licensor regarding such Contributions.++ 6. Trademarks. This License does not grant permission to use the trade+ names, trademarks, service marks, or product names of the Licensor,+ except as required for reasonable and customary use in describing the+ origin of the Work and reproducing the content of the NOTICE file.++ 7. Disclaimer of Warranty. Unless required by applicable law or+ agreed to in writing, Licensor provides the Work (and each+ Contributor provides its Contributions) on an "AS IS" BASIS,+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or+ implied, including, without limitation, any warranties or conditions+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A+ PARTICULAR PURPOSE. You are solely responsible for determining the+ appropriateness of using or redistributing the Work and assume any+ risks associated with Your exercise of permissions under this License.++ 8. Limitation of Liability. In no event and under no legal theory,+ whether in tort (including negligence), contract, or otherwise,+ unless required by applicable law (such as deliberate and grossly+ negligent acts) or agreed to in writing, shall any Contributor be+ liable to You for damages, including any direct, indirect, special,+ incidental, or consequential damages of any character arising as a+ result of this License or out of the use or inability to use the+ Work (including but not limited to damages for loss of goodwill,+ work stoppage, computer failure or malfunction, or any and all+ other commercial damages or losses), even if such Contributor+ has been advised of the possibility of such damages.++ 9. Accepting Warranty or Additional Liability. While redistributing+ the Work or Derivative Works thereof, You may choose to offer,+ and charge a fee for, acceptance of support, warranty, indemnity,+ or other liability obligations and/or rights consistent with this+ License. However, in accepting such obligations, You may act only+ on Your own behalf and on Your sole responsibility, not on behalf+ of any other Contributor, and only if You agree to indemnify,+ defend, and hold each Contributor harmless for any liability+ incurred by, or claims asserted against, such Contributor by reason+ of your accepting any such warranty or additional liability.++ END OF TERMS AND CONDITIONS++ APPENDIX: How to apply the Apache License to your work.++ To apply the Apache License to your work, attach the following+ boilerplate notice, with the fields enclosed by brackets "[]"+ replaced with your own identifying information. (Don't include+ the brackets!) The text should be enclosed in the appropriate+ comment syntax for the file format. We also recommend that a+ file or class name and description of purpose be included on the+ same "printed page" as the copyright notice for easier+ identification within third-party archives.++ Copyright [yyyy] [name of copyright owner]++ Licensed under the Apache License, Version 2.0 (the "License");+ you may not use this file except in compliance with the License.+ You may obtain a copy of the License at++ http://www.apache.org/licenses/LICENSE-2.0++ Unless required by applicable law or agreed to in writing, software+ distributed under the License is distributed on an "AS IS" BASIS,+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.+ See the License for the specific language governing permissions and+ limitations under the License.
+ short-vec-lens.cabal view
@@ -0,0 +1,46 @@+cabal-version: 1.12++-- This file has been generated from package.yaml by hpack version 0.33.0.+--+-- see: https://github.com/sol/hpack+--+-- hash: a380c2552ac4d82ca6fcee0f4be9e2fd05dd6bf641c63e17fd4424af321992af++name: short-vec-lens+version: 0.1.0.0+synopsis: Lenses and related functionality for the `short-vec` package.+description: This provides various 'Lens'es, 'Iso's, etc. for 'Vec's, including slicing,+ reshaping, transposition, concatenation, and more.+category: Data+homepage: https://github.com/google/hs-fin-vec#readme+bug-reports: https://github.com/google/hs-fin-vec/issues+author: Lennart Augustsson <lennart@augustsson.net>, Wren Romano <wrengr@google.com>, Andrew Pritchard <awpr@google.com>++maintainer: Andrew Pritchard <awpr@google.com>+copyright: 2018-2021 Google LLC+license: Apache-2.0+license-file: LICENSE+build-type: Simple+extra-source-files:+ CHANGELOG.md++source-repository head+ type: git+ location: https://github.com/google/hs-fin-vec+ subdir: short-vec-lens++library+ exposed-modules:+ Data.Vec.Short.Lens+ other-modules:+ Paths_short_vec_lens+ hs-source-dirs:+ src+ build-depends:+ base >=4.12 && <4.16+ , fin-int >=0.1 && <0.2+ , indexed-traversable >=0.1 && <0.2+ , lens >=4.15 && <5.1+ , short-vec >=0.1 && <0.2+ , sint >=0.1 && <0.2+ default-language: Haskell2010
+ src/Data/Vec/Short/Lens.hs view
@@ -0,0 +1,231 @@+-- Copyright 2018-2021 Google LLC+--+-- Licensed under the Apache License, Version 2.0 (the "License");+-- you may not use this file except in compliance with the License.+-- You may obtain a copy of the License at+--+-- http://www.apache.org/licenses/LICENSE-2.0+--+-- Unless required by applicable law or agreed to in writing, software+-- distributed under the License is distributed on an "AS IS" BASIS,+-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.+-- See the License for the specific language governing permissions and+-- limitations under the License.++-- | Lenses and related optics for 'Vec's.++-- Work around <https://ghc.haskell.org/trac/ghc/ticket/14511>+{-# OPTIONS_GHC -fno-float-in #-}+{-# OPTIONS_GHC -Wno-orphans #-}++{-# LANGUAGE AllowAmbiguousTypes #-}+{-# LANGUAGE BangPatterns #-}+{-# LANGUAGE CPP #-}+{-# LANGUAGE DataKinds #-}+{-# LANGUAGE DeriveDataTypeable #-}+{-# LANGUAGE FlexibleContexts #-}+{-# LANGUAGE KindSignatures #-}+{-# LANGUAGE MagicHash #-}+{-# LANGUAGE MultiParamTypeClasses #-}+{-# LANGUAGE RankNTypes #-}+{-# LANGUAGE RoleAnnotations #-}+{-# LANGUAGE ScopedTypeVariables #-}+{-# LANGUAGE TypeApplications #-}+{-# LANGUAGE TypeFamilies #-}+{-# LANGUAGE TypeOperators #-}+{-# LANGUAGE UnboxedTuples #-}+{-# LANGUAGE ViewPatterns #-}+{-# LANGUAGE UndecidableInstances #-}++module Data.Vec.Short.Lens+ (+ -- ** List-based lenses+ list+ -- ** Arity-based lenses+ , paired++ -- * List-like operators+ -- ** Constructor views+ -- *** The cons view+ , consed+ -- *** The snoc view+ , snoced+ -- ** Operator views+ -- *** The append view+ , chopped+ -- *** The concat view+ , subVecs+ -- *** The reverse view+ , reversed+ -- *** The transposition view+ , vtransposed++ -- * Misc lenses+ , midElem, ixElem, ix+ , sliced+ , rotated+ , vdiagonal+ ) where++import Prelude hiding ((++), concat, concatMap, iterate)++import qualified Data.Foldable as F+import GHC.ST (runST)+import GHC.TypeLits (KnownNat, type (+), type (<=), type (-))+import qualified GHC.TypeLits++import Control.Lens (Iso, Lens', iso, lens, from, swapped)++import Data.Fin.Int.Explicit (Fin, complementFin, finToInt, unsafeFin)+import Data.SInt (sintVal, unSInt)+import Data.Vec.Short.Internal++#if !MIN_VERSION_lens(5,0,0)+import qualified Control.Lens as L+import Data.Foldable.WithIndex (FoldableWithIndex(..))+import Data.Traversable.WithIndex (TraversableWithIndex(..))+#endif++--------------------------------------------------------------------------------++-- | A list (of the right length) is isomorphic to a vector.+-- The list-to-vector direction is partial.+list :: (KnownNat n) => Iso (Vec n a) (Vec n b)+ [a] [b]+list = iso F.toList (fromList sintVal)++--------------------------------------------------------------------------------++-- | Lens on a single element.+ix :: Fin n -> Lens' (Vec n a) a+ix i = i `seq` lens (! i) (upd i)+{-# INLINE ix #-}++----------------++-- | An isomorphism with an element added at the beginning of a vector.+consed :: Iso (a, Vec n a) (b, Vec m b)+ (Vec (n + 1) a) (Vec (m + 1) b)+consed = from (unsafeIxElem (const 0))++-- | An isomorphism with an element added at the end of a vector.+snoced :: Iso (Vec n a, a) (Vec m b, b)+ (Vec (n + 1) a) (Vec (m + 1) b)+snoced = from (unsafeIxElem id . swapped)++-- | Isomorphism between a vector with and without its middle element.+midElem :: forall m n a b. Iso (Vec (n+1) a) (Vec (m+1) b)+ (a, Vec n a) (b, Vec m b)+midElem = unsafeIxElem (`quot` 2)++----------------++-- | An isomorphism with a 'split' vector.+chopped :: (KnownNat m) => Iso (Vec (m + n) a) (Vec (o + p) b)+ (Vec m a, Vec n a) (Vec o b, Vec p b)+chopped = iso (split sintVal) (uncurry (++))++-- | A vector can be split (isomorphically) into a vector of vectors.+subVecs :: (KnownNat m, (n GHC.TypeLits.* m) ~ nm, (p GHC.TypeLits.* o) ~ po)+ => Iso (Vec nm a) (Vec po b)+ (Vec n (Vec m a)) (Vec p (Vec o b))+subVecs = iso (reshape sintVal) concat++-- | A vector is isomorphic to its reversal.+reversed :: Iso (Vec n a) (Vec m b)+ (Vec n a) (Vec m b)+reversed = iso rev rev++--------------------------------+-- Other misc lenses++-- Unsafe version of ixElem, but with a function computing the+-- index from @valueOf @n@.+-- This allows unsafeIxElem to be used easily for midElem and snoced.+unsafeIxElem :: (Int -> Int) -> Iso (Vec (n+1) a) (Vec (m+1) b)+ (a, Vec n a) (b, Vec m b)+unsafeIxElem fi = iso getf setf+ where getf xs =+ let !i = fi (vSize xs - 1)+ in unsafeIndexK xs i $ \ xi ->+ let !xs' = unsafeRemove i xs+ in (xi, xs')+ setf (xi, xs) =+ let !i = fi (vSize xs)+ in unsafeInsert i xi xs+{-# INLINE unsafeIxElem #-}++-- | Isomorphism between a vector with and without a single element at+-- the given index.+ixElem :: forall n a b. Fin (n+1) -> Iso (Vec (n+1) a) (Vec (n+1) b)+ (a, Vec n a) (b, Vec n b)+ixElem i = unsafeIxElem (const (finToInt i))+++-- | A lens to a slice of the vector.+sliced+ :: forall m n a+ . (KnownNat m, KnownNat n, m <= n)+ => Fin (n - m + 1)+ -> Lens' (Vec n a) (Vec m a)+sliced (finToInt -> !start) = lens getf setf+ where+ !m = unSInt @m sintVal+ !n = unSInt @n sintVal+ !end = start + m+ !rest = n - end -- the length of the post-slice portion of the vector++ getf xs = sliceVec xs start sintVal+ setf xs ys =+ createVec sintVal $ \mv -> do+ unsafeCopyVec xs 0 mv 0 start+ unsafeCopyVec ys 0 mv start m+ unsafeCopyVec xs end mv end rest+++-- | A two-element vector is isomorphic to a pair.+paired :: Iso (Vec 2 a) (Vec 2 b) (a, a) (b, b)+paired = iso unvec2 (uncurry vec2)+ where+ unvec2 v =+ indexK v (unsafeFin @Int 0) $ \x ->+ indexK v (unsafeFin @Int 1) $ \y -> (x,y)++-- | Isomorphism between a vector and a vector rotated @i@ steps.+-- The element at index 0 in the first vector is at index @i@ in the second.+-- E.g., @view (rotated 1) (fromList "ABCD") == fromList "DABC"@+rotated :: forall n a b. Fin n -> Iso (Vec n a) (Vec n b) (Vec n a) (Vec n b)+rotated i = iso (rot i) (\v -> rot (complementFin (svSize v) i) v)+{-# INLINE rotated #-}++-- | Isomorphism of transposed vectors.+vtransposed :: (KnownNat m, KnownNat p)+ => Iso (Vec n (Vec m a)) (Vec p (Vec o b))+ (Vec m (Vec n a)) (Vec o (Vec p b))+vtransposed = iso (vtranspose sintVal) (vtranspose sintVal)++-- TODO: KnownNat not needed.+-- | Lens on the main diagonal.+vdiagonal :: forall n a. KnownNat n => Lens' (Vec n (Vec n a)) (Vec n a)+vdiagonal = lens getf setf+ where+ getf :: Vec n (Vec n a) -> Vec n a+ getf = imap (flip (!))++ setf :: Vec n (Vec n a) -> Vec n a -> Vec n (Vec n a)+ setf m d =+ mkVec sintVal $ \i ->+ indexK m i $ \mi ->+ indexK d i $ \di ->+ runST $ do+ mi' <- safeThawMV mi+ writeMV mi' i di+ unsafeFreezeMV mi'++#if !MIN_VERSION_lens(5,0,0)+instance L.FunctorWithIndex (Fin n) (Vec n) where imap = imap+instance KnownNat n => L.FoldableWithIndex (Fin n) (Vec n) where+ ifoldMap = ifoldMap+instance KnownNat n => L.TraversableWithIndex (Fin n) (Vec n) where+ itraverse = itraverse+#endif