vec: Vec: length-indexed (sized) list

[ bsd3, data, dependent-types, library ] [ Propose Tags ]

This package provides length-indexed (sized) lists, also known as vectors.

data Vec n a where
    VNil  :: Vec 'Nat.Z a
    (:::) :: a -> Vec n a -> Vec ('Nat.S n) a

The functions are implemented in four flavours:

  • naive: with explicit recursion. It's simple, constraint-less, yet slow.

  • pull: using Fin n -> a representation, which fuses well, but makes some programs hard to write. And

  • data-family: which allows lazy pattern matching

  • inline: which exploits how GHC dictionary inlining works, unrolling recursion if the size of Vec is known statically.

As best approach depends on the application, vec doesn't do any magic transformation. Benchmark your code.

This package uses fin, i.e. not GHC.TypeLits, for indexes.

For lens or optics support see vec-lens and vec-optics packages respectively.

See Hasochism: the pleasure and pain of dependently typed haskell programming by Sam Lindley and Conor McBride for answers to how and why. Read APLicative Programming with Naperian Functors by Jeremy Gibbons for (not so) different ones.

Similar packages

  • linear has V type, which uses Vector from vector package as backing store. Vec is a real GADT, but tries to provide as many useful instances (upto lens).

  • vector-sized Great package using GHC.TypeLits. Current version (0.6.1.0) uses finite-typelits and Int indexes.

  • sized-vector depends on singletons package. vec isn't light on dependencies either, but try to provide wide GHC support.

  • fixed-vector

  • sized also depends on a singletons package. The Sized f n a type is generalisation of linear's V for any ListLike.

  • clash-prelude is a kitchen sink package, which has CLaSH.Sized.Vector module. Also depends on singletons.

Flags

Manual Flags

NameDescriptionDefault
adjunctions

Depend on adjunctions to provide its instances

Enabled
distributive

Depend on distributive to provide its instances. Turning on, disables adjunctions too.

Enabled
semigroupoids

Depend on semigroupoids to provide its instances, and traverse1.

Enabled

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Note: This package has metadata revisions in the cabal description newer than included in the tarball. To unpack the package including the revisions, use 'cabal get'.

Maintainer's Corner

For package maintainers and hackage trustees

Candidates

Versions [RSS] 0, 0.1, 0.1.1, 0.1.1.1, 0.2, 0.3, 0.4, 0.4.1
Change log ChangeLog.md
Dependencies adjunctions (>=4.4 && <4.5), base (>=4.7 && <4.18), boring (>=0.2 && <0.3), deepseq (>=1.3.0.1 && <1.5), distributive (>=0.5.3 && <0.7), fin (>=0.2.1 && <0.3), hashable (>=1.2.7.0 && <1.5), indexed-traversable (>=0.1.1 && <0.2), QuickCheck (>=2.14.2 && <2.15), semigroupoids (>=5.3.5 && <5.4), semigroups (>=0.18.4 && <0.21), transformers (>=0.3.0.0 && <0.7), transformers-compat (>=0.6.5 && <0.7 || >=0.7.1 && <0.8) [details]
License BSD-3-Clause
Copyright (c) 2017-2021 Oleg Grenrus
Author Oleg Grenrus <oleg.grenrus@iki.fi>
Maintainer Oleg.Grenrus <oleg.grenrus@iki.fi>
Revised Revision 1 made by phadej at 2022-08-22T15:04:46Z
Category Data, Dependent Types
Home page https://github.com/phadej/vec
Bug tracker https://github.com/phadej/vec/issues
Source repo head: git clone https://github.com/phadej/vec.git(vec)
Uploaded by phadej at 2022-01-03T12:41:34Z
Distributions Arch:0.4.1, LTSHaskell:0.4.1, NixOS:0.4.1, Stackage:0.4.1
Downloads 4982 total (41 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2022-01-03 [all 1 reports]