vector-sized

Size tagged vectors

https://github.com/expipiplus1/vector-sized#readme

Version on this page:1.5.0@rev:2
LTS Haskell 23.19:1.6.1
Stackage Nightly 2025-04-30:1.6.1
Latest on Hackage:1.6.1

See all snapshots vector-sized appears in

BSD-3-Clause licensed by Joe Hermaszewski
Maintained by [email protected]
This version can be pinned in stack with:vector-sized-1.5.0@sha256:900bfb7b358b2f40ae817d2f04e320db800d255d179b2bd3e07b44d6343093f5,1835

Module documentation for 1.5.0

vector-sized Hackage

This package exports a newtype tagging the vectors from the vector package with a type-level natural representing their size. It also exports functions from vector whose size can be determined ahead of time, appropriately retyped.

Currently, we provide size-tagged versions of the following:

We also provide mutable versions of each of the above. Additionally, we include functions for converting to and from ‘unsized’ vectors and lists, using CPS-style existentials.

The code in this package is based on the initial work by Ben Gamari in a PR for vulkan.

How is this different to fixed-vector?

This package is fairly similar to fixed-vector, as both libraries are designed to provide vectors of statically known length. However, the implementations used are different, with different tradeoffs. vector-sized uses a newtype wrapper around vectors from vector, and is thus able to handle vectors of arbitrary length. However, this approach requires us to carry a runtime representation of length, which is a significant memory overhead for small vectors. fixed-vector instead defines all functions as manipulations of Church-encoded product types of the form ∀r. (a → a → r) → r (for 2D vectors), allowing it to work for both arbitrary product types (like data V2 a = V2 a a) and opaque length-parameterized vectors. However, as a consequence of this implementation choice, fixed-vector cannot handle vectors whose size exceeds tens of elements.

Changes

Change Log

WIP

[1.5.0] - 2021-08-25

  • Change indexes used by accum from Int to Finite.

[1.4.4] - 2021-06-26

  • Add ix'

[1.4.3.1] - 2020-12-13

  • Fix Bits instance, shiftl and shiftr were incorrect

[1.4.3] - 2020-12-08

  • Add Primitive flavour of sized vectors
  • Add instance Bits (v a) => Bits (Vector v n a)

Thanks to @Bodigrim and @mstksg

[1.4.2] - 2020-08-20

  • Add instance Unbox a, KnownNat n) => Unbox (Vector n a)
  • Add zipVectorsUnsafe

[1.4.1.0] - 2020-05-04

  • GHC 8.10 compatibility

[1.4.0.0] - 2019-09-12

[1.3.0.0] - 2019-05-28

  • Correct type of accumulating fold functions

[1.2.0.1] - 2019-05-22

  • Loosen upper bounds on dependencies

[1.2.0.0] - 2018-12-05

  • Add Hashable instances
  • Generalize concatMap
  • Various code and documentation cleanup
  • Add SomeSized pattern

[1.1.1.0] - 2018-11-13

  • Fix build and add CI for 8.6.2

[1.1.0.0] - 2018-11-08

  • Generalise Ix instance
  • Add Unboxed vectors
  • Fiddle extension guarding

Thanks everyone!

[1.0.5.0] - 2018-10-17

  • Add Ix instance
  • Add Comonad instance

Thanks mpilgrem and KingoftheHomeless

[1.0.4.1] - 2018-09-04

  • Fix compilation on ghc 8.6.

[1.0.4.0] - 2018-07-14

  • Add Monad instance for boxed vectors.

[1.0.3.1] - 2018-07-10

  • Loosen upper bound on distributive

[1.0.3.0] - 2018-06-24

  • Remove redundant KnownNat constraints

[1.0.2.0] - 2018-05-15

  • not-home haddock annotations for Internal modules, for more helpful linking
  • Fix build with indexed-list-literals-0.2.1.0

[1.0.1.0] - 2018-04-12

  • Add Representable and Distributive instances for sized boxed vectors
  • Use newer version of indexed-list-literals to allow a fully featured compile on ghc 8.4

[1.0.0.0] - 2018-03-20

  • More functions using Finite instead of Int
  • Add Read and Semigroup instances
  • Performance improvements for Applicative
  • Add a knownLength function
  • Add fromTuple (ghc < 8.3 for now)
  • Add sized variants of mutable vectors
  • Expose sized vector constructors from Internal modules

Huge thanks to all the contributors!

[0.6.1.0] - 2017-08-04

  • Add lenses ix, _head and _last

[0.6.0.0] - 2017-06-07

  • Make ordering of additions in types be more consistent
  • Make slice more general
  • Num, Fractional, and Floating instances for vectors

[0.5.1.0] - 2017-02-01

  • Loosen upper bound on vector

[0.5.0.0] - 2017-01-04

  • Use Finite from finite-typelits for indexing.

[0.4.1.0] - 2016-11-24

  • Add withSized and withSizedList

[0.4.0.1] - 2016-11-12

  • Raise lower bound on base to 4.9

[0.4.0.0] - 2016-11-01

  • Correct type signature on index'

[0.3.3.0] - 2016-08-10

  • Add instances for Data, Typeable and Generic

[0.3.2.0] - 2016-03-29

  • Add overlapping Monoid instance for zero length vectors

[0.3.1.0] - 2016-03-29

  • Add Monoid instance

[0.3.0.0] - 2016-03-22

  • Export all of the available functionality from Data.Vector.Generic.
  • Add Storable
  • Add Unboxed

[0.2.0.0] - 2016-02-29

  • Tighter bounds on base to avoid compiling with GHC < 7.10.

[0.1.0.0] - 2016-02-28

  • Initial release.