Copyright	(c) Matt Hunzinger 2025
License	BSD-style (see the LICENSE file in the distribution)
Maintainer	matt@hunzinger.me
Stability	provisional
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Data.SparseVector

Contents

Sparse vectors
Construction

Description

Synopsis

newtype SparseVector a = SparseVector {
- unSparseVector :: Vector (Maybe a)
}
empty :: SparseVector a
insert :: Int -> a -> SparseVector a -> SparseVector a
lookup :: Int -> SparseVector a -> Maybe a
delete :: Int -> SparseVector a -> SparseVector a
mapWithKey :: (Int -> a -> b) -> SparseVector a -> SparseVector b
mapAccum :: (a -> b -> (a, c)) -> a -> SparseVector b -> (a, SparseVector c)
intersection :: SparseVector a -> SparseVector b -> SparseVector a
intersectionWith :: (a -> b -> c) -> SparseVector a -> SparseVector b -> SparseVector c
intersectionWithKey :: (Int -> a -> b -> c) -> SparseVector a -> SparseVector b -> SparseVector c
intersectionVec :: SparseVector a -> SparseVector b -> Vector a
intersectionVecWith :: (a -> b -> c) -> SparseVector a -> SparseVector b -> Vector c
intersectionVecWithKey :: (Int -> a -> b -> c) -> SparseVector a -> SparseVector b -> Vector c
fromList :: [(Int, a)] -> SparseVector a
toList :: SparseVector a -> [Maybe a]
fromVector :: Vector a -> SparseVector a
toVector :: SparseVector a -> Vector a
freeze :: PrimMonad m => MSparseVector (PrimState m) a -> m (SparseVector a)
thaw :: PrimMonad m => SparseVector a -> m (MSparseVector (PrimState m) a)

Sparse vectors

newtype SparseVector a Source #

Sparse n-dimensional vector.

A sparse vector is defined as a Vector (Maybe a), where Maybe a is a cell for an element in the sparse vector.

Inserting elements at some dimension n will grow the vector up to n, using Nothing to create empty cells.

Constructors

SparseVector
Fields unSparseVector :: Vector (Maybe a)

Instances

Instances details

Foldable SparseVector Source #
Instance details Defined in Data.SparseVector Methods fold :: Monoid m => SparseVector m -> m # foldMap :: Monoid m => (a -> m) -> SparseVector a -> m # foldMap' :: Monoid m => (a -> m) -> SparseVector a -> m # foldr :: (a -> b -> b) -> b -> SparseVector a -> b # foldr' :: (a -> b -> b) -> b -> SparseVector a -> b # foldl :: (b -> a -> b) -> b -> SparseVector a -> b # foldl' :: (b -> a -> b) -> b -> SparseVector a -> b # foldr1 :: (a -> a -> a) -> SparseVector a -> a # foldl1 :: (a -> a -> a) -> SparseVector a -> a # toList :: SparseVector a -> [a] # null :: SparseVector a -> Bool # length :: SparseVector a -> Int # elem :: Eq a => a -> SparseVector a -> Bool # maximum :: Ord a => SparseVector a -> a # minimum :: Ord a => SparseVector a -> a # sum :: Num a => SparseVector a -> a # product :: Num a => SparseVector a -> a #
Traversable SparseVector Source #
Instance details Defined in Data.SparseVector Methods traverse :: Applicative f => (a -> f b) -> SparseVector a -> f (SparseVector b) # sequenceA :: Applicative f => SparseVector (f a) -> f (SparseVector a) # mapM :: Monad m => (a -> m b) -> SparseVector a -> m (SparseVector b) # sequence :: Monad m => SparseVector (m a) -> m (SparseVector a) #
Functor SparseVector Source #
Instance details Defined in Data.SparseVector Methods fmap :: (a -> b) -> SparseVector a -> SparseVector b # (<$) :: a -> SparseVector b -> SparseVector a #
Monoid (SparseVector a) Source #
Instance details Defined in Data.SparseVector Methods mempty :: SparseVector a # mappend :: SparseVector a -> SparseVector a -> SparseVector a # mconcat :: [SparseVector a] -> SparseVector a #
Semigroup (SparseVector a) Source #
Instance details Defined in Data.SparseVector Methods (<>) :: SparseVector a -> SparseVector a -> SparseVector a # sconcat :: NonEmpty (SparseVector a) -> SparseVector a # stimes :: Integral b => b -> SparseVector a -> SparseVector a #
Show a => Show (SparseVector a) Source #
Instance details Defined in Data.SparseVector Methods showsPrec :: Int -> SparseVector a -> ShowS # show :: SparseVector a -> String # showList :: [SparseVector a] -> ShowS #
NFData a => NFData (SparseVector a) Source #
Instance details Defined in Data.SparseVector Methods rnf :: SparseVector a -> () #
Eq a => Eq (SparseVector a) Source #
Instance details Defined in Data.SparseVector Methods (==) :: SparseVector a -> SparseVector a -> Bool # (/=) :: SparseVector a -> SparseVector a -> Bool #

Construction

empty :: SparseVector a Source #

Empty sparse vector.

Operations

insert :: Int -> a -> SparseVector a -> SparseVector a Source #

Insert an element at a given index into a SparseVector.

Inserting elements at some dimension n will grow the vector up to n, using Nothing to create empty cells.

>>> insert 0 'a' empty
SparseVector {unSparseVector = [Just 'a']}

>>> insert 2 'b' empty
SparseVector {unSparseVector = [Nothing,Nothing,Just 'b']}

lookup :: Int -> SparseVector a -> Maybe a Source #

Lookup an element at a given index in a SparseVector.

delete :: Int -> SparseVector a -> SparseVector a Source #

Delete an index from a SparseVector, replacing its cell with Nothing.

mapWithKey :: (Int -> a -> b) -> SparseVector a -> SparseVector b Source #

mapAccum :: (a -> b -> (a, c)) -> a -> SparseVector b -> (a, SparseVector c) Source #

Intersection

intersection :: SparseVector a -> SparseVector b -> SparseVector a Source #

intersectionWith :: (a -> b -> c) -> SparseVector a -> SparseVector b -> SparseVector c Source #

intersectionWithKey :: (Int -> a -> b -> c) -> SparseVector a -> SparseVector b -> SparseVector c Source #

intersectionVec :: SparseVector a -> SparseVector b -> Vector a Source #

intersectionVecWith :: (a -> b -> c) -> SparseVector a -> SparseVector b -> Vector c Source #

intersectionVecWithKey :: (Int -> a -> b -> c) -> SparseVector a -> SparseVector b -> Vector c Source #

Conversion

fromList :: [(Int, a)] -> SparseVector a Source #

toList :: SparseVector a -> [Maybe a] Source #

fromVector :: Vector a -> SparseVector a Source #

toVector :: SparseVector a -> Vector a Source #

Mutations

freeze :: PrimMonad m => MSparseVector (PrimState m) a -> m (SparseVector a) Source #

Freeze a MSparseVector into a SparseVector.

thaw :: PrimMonad m => SparseVector a -> m (MSparseVector (PrimState m) a) Source #

Unfreeze a SparseVector into a MSparseVector.