SDP.Indexed

SDP.Indexed provides Indexed and Freeze classes.

Exports

module SDP.Linear

module SDP.Map

Indexed

class (Linear v e, Bordered v i, Map v i e) => Indexed v i e | v -> i, v -> e where

Indexed is class of ordered associative arrays with static bounds.

Minimal complete definition

fromIndexed

Methods

assoc :: (i, i) -> [(i, e)] -> v

assoc bnds ascs create new structure from list of associations, without default element. Note that bnds is ascs bounds and may not match with the result bounds (not always possible).

assoc' :: (i, i) -> e -> [(i, e)] -> v

assoc' bnds def ascs creates new structure from list of associations with default element. Note that bnds is ascs bounds and may not match with the result bounds (not always possible).

fromIndexed :: Indexed m j e => m -> v

fromIndexed converts this indexed structure to another one.

write' :: v -> i -> e -> v

Warning: will be moved to SDP.Map.Map class in sdp-0.3

Safe index-based immutable writer.

update' :: v -> (e -> e) -> i -> v

Warning: will be moved to SDP.Map.Map class in sdp-0.3

Update element by given function.

updates' :: v -> (i -> e -> e) -> v

Warning: deprecated in favor of update, will be removed in sdp-0.3

Create new structure from old by mapping with index.

accum :: (e -> e' -> e) -> v -> [(i, e')] -> v

accum f es ies create a new structure from es elements selectively updated by function f and ies associations list.

imap :: Map m j e => (i, i) -> m -> (i -> j) -> v

imap creates new indexed structure from old with reshaping.

Instances

Indexed [e] Int e

Defined in SDP.Indexed

Methods

assoc :: (Int, Int) -> [(Int, e)] -> [e]

assoc' :: (Int, Int) -> e -> [(Int, e)] -> [e]

fromIndexed :: Indexed m j e => m -> [e]

write' :: [e] -> Int -> e -> [e]

update' :: [e] -> (e -> e) -> Int -> [e]

updates' :: [e] -> (Int -> e -> e) -> [e]

accum :: (e -> e' -> e) -> [e] -> [(Int, e')] -> [e]

imap :: Map m j e => (Int, Int) -> m -> (Int -> j) -> [e]

Unboxed e => Indexed (SBytes# e) Int e

Defined in SDP.Prim.SBytes

Methods

assoc :: (Int, Int) -> [(Int, e)] -> SBytes# e

assoc' :: (Int, Int) -> e -> [(Int, e)] -> SBytes# e

fromIndexed :: Indexed m j e => m -> SBytes# e

write' :: SBytes# e -> Int -> e -> SBytes# e

update' :: SBytes# e -> (e -> e) -> Int -> SBytes# e

updates' :: SBytes# e -> (Int -> e -> e) -> SBytes# e

accum :: (e -> e' -> e) -> SBytes# e -> [(Int, e')] -> SBytes# e

imap :: Map m j e => (Int, Int) -> m -> (Int -> j) -> SBytes# e

Indexed (SArray# e) Int e

Defined in SDP.Prim.SArray

Methods

assoc :: (Int, Int) -> [(Int, e)] -> SArray# e

assoc' :: (Int, Int) -> e -> [(Int, e)] -> SArray# e

fromIndexed :: Indexed m j e => m -> SArray# e

write' :: SArray# e -> Int -> e -> SArray# e

update' :: SArray# e -> (e -> e) -> Int -> SArray# e

updates' :: SArray# e -> (Int -> e -> e) -> SArray# e

accum :: (e -> e' -> e) -> SArray# e -> [(Int, e')] -> SArray# e

imap :: Map m j e => (Int, Int) -> m -> (Int -> j) -> SArray# e

Indexed1 rep Int e => Indexed (AnyChunks rep e) Int e

Defined in SDP.Templates.AnyChunks

Methods

assoc :: (Int, Int) -> [(Int, e)] -> AnyChunks rep e

assoc' :: (Int, Int) -> e -> [(Int, e)] -> AnyChunks rep e

fromIndexed :: Indexed m j e => m -> AnyChunks rep e

write' :: AnyChunks rep e -> Int -> e -> AnyChunks rep e

update' :: AnyChunks rep e -> (e -> e) -> Int -> AnyChunks rep e

updates' :: AnyChunks rep e -> (Int -> e -> e) -> AnyChunks rep e

accum :: (e -> e' -> e) -> AnyChunks rep e -> [(Int, e')] -> AnyChunks rep e

imap :: Map m j e => (Int, Int) -> m -> (Int -> j) -> AnyChunks rep e

(Index i, Indexed1 rep Int e) => Indexed (AnyBorder rep i e) i e

Defined in SDP.Templates.AnyBorder

Methods

assoc :: (i, i) -> [(i, e)] -> AnyBorder rep i e

assoc' :: (i, i) -> e -> [(i, e)] -> AnyBorder rep i e

fromIndexed :: Indexed m j e => m -> AnyBorder rep i e

write' :: AnyBorder rep i e -> i -> e -> AnyBorder rep i e

update' :: AnyBorder rep i e -> (e -> e) -> i -> AnyBorder rep i e

updates' :: AnyBorder rep i e -> (i -> e -> e) -> AnyBorder rep i e

accum :: (e -> e' -> e) -> AnyBorder rep i e -> [(i, e')] -> AnyBorder rep i e

imap :: Map m j e => (i, i) -> m -> (i -> j) -> AnyBorder rep i e

type Indexed1 v i e = Indexed (v e) i e

Indexed contraint for (Type -> Type)-kind types.

type Indexed2 v i e = Indexed (v i e) i e

Indexed contraint for (Type -> Type -> Type)-kind types.

binaryContain :: (Linear v e, Bordered v i) => Compare e -> e -> v -> Bool

binaryContain checks that sorted structure has equal element.

Freeze

class Monad m => Freeze m v' v | v' -> m where

Service class of mutable to immutable conversions.

Minimal complete definition

freeze

Methods

freeze :: v' -> m v

freeze is a safe way to convert a mutable structure to a immutable. freeze should copy the old structure or ensure that it will not be used after calling the procedure.

unsafeFreeze :: v' -> m v

unsafeFreeze is unsafe version of freeze. unsafeFreeze doesn't guarantee that the structure will be copied or locked. It only guarantees that if the old structure isn't used, no error will occur.

Instances

(Index i, Freeze m mut (rep e), Bordered1 rep Int e) => Freeze m mut (AnyBorder rep i e)

Defined in SDP.Templates.AnyBorder

Methods

freeze :: mut -> m (AnyBorder rep i e)

unsafeFreeze :: mut -> m (AnyBorder rep i e)

Freeze STM (TArray# e) (SArray# e)

Defined in SDP.Prim.TArray

Methods

freeze :: TArray# e -> STM (SArray# e)

unsafeFreeze :: TArray# e -> STM (SArray# e)

Freeze1 m mut imm e => Freeze m (mut e) (AnyChunks imm e)

Creates one-chunk immutable stream, may be memory inefficient.

Defined in SDP.Templates.AnyChunks

Methods

freeze :: mut e -> m (AnyChunks imm e)

unsafeFreeze :: mut e -> m (AnyChunks imm e)

(Storable e, Unboxed e) => Freeze IO (Int, Ptr e) (SBytes# e)

Defined in SDP.Prim.SBytes

Methods

freeze :: (Int, Ptr e) -> IO (SBytes# e)

unsafeFreeze :: (Int, Ptr e) -> IO (SBytes# e)

Storable e => Freeze IO (Int, Ptr e) (SArray# e)

Defined in SDP.Prim.SArray

Methods

freeze :: (Int, Ptr e) -> IO (SArray# e)

unsafeFreeze :: (Int, Ptr e) -> IO (SArray# e)

(MonadIO io, Unboxed e) => Freeze io (MIOBytes# io e) (SBytes# e)

Defined in SDP.Prim.SBytes

Methods

freeze :: MIOBytes# io e -> io (SBytes# e)

unsafeFreeze :: MIOBytes# io e -> io (SBytes# e)

MonadIO io => Freeze io (MIOArray# io e) (SArray# e)

Defined in SDP.Prim.SArray

Methods

freeze :: MIOArray# io e -> io (SArray# e)

unsafeFreeze :: MIOArray# io e -> io (SArray# e)

(LinearM1 m mut e, Freeze1 m mut imm e) => Freeze m (AnyChunks mut e) (imm e)

Creates new immutable structure using merged.

Defined in SDP.Templates.AnyChunks

Methods

freeze :: AnyChunks mut e -> m (imm e)

unsafeFreeze :: AnyChunks mut e -> m (imm e)

Freeze1 m mut imm e => Freeze m (AnyChunks mut e) (AnyChunks imm e)

Defined in SDP.Templates.AnyChunks

Methods

freeze :: AnyChunks mut e -> m (AnyChunks imm e)

unsafeFreeze :: AnyChunks mut e -> m (AnyChunks imm e)

(Index i, Freeze m (rep e) imm) => Freeze m (AnyBorder rep i e) imm

Defined in SDP.Templates.AnyBorder

Methods

freeze :: AnyBorder rep i e -> m imm

unsafeFreeze :: AnyBorder rep i e -> m imm

(Index i, Freeze1 m mut imm e) => Freeze m (AnyBorder mut i e) (AnyBorder imm i e)

Defined in SDP.Templates.AnyBorder

Methods

freeze :: AnyBorder mut i e -> m (AnyBorder imm i e)

unsafeFreeze :: AnyBorder mut i e -> m (AnyBorder imm i e)

Unboxed e => Freeze (ST s) (STBytes# s e) (SBytes# e)

Defined in SDP.Prim.SBytes

Methods

freeze :: STBytes# s e -> ST s (SBytes# e)

unsafeFreeze :: STBytes# s e -> ST s (SBytes# e)

Freeze (ST s) (STArray# s e) (SArray# e)

Defined in SDP.Prim.SArray

Methods

freeze :: STArray# s e -> ST s (SArray# e)

unsafeFreeze :: STArray# s e -> ST s (SArray# e)

type Freeze1 m v' v e = Freeze m (v' e) (v e)

Freeze contraint for (Type -> Type)-kind types.

type Freeze2 m v' v i e = Freeze m (v' i e) (v i e)

Freeze contraint for (Type -> Type -> Type)-kind types.

Rank 2 quantified constraints

GHC 8.6.1+ only

type Indexed' v i = forall e. Indexed (v e) i e

Indexed contraint for (Type -> Type)-kind types.

type Indexed'' v = forall i e. Indexed (v i e) i e

Indexed contraint for (Type -> Type -> Type)-kind types.

type Freeze' m v' v = forall e. Freeze m (v' e) (v e)

Freeze contraint for (Type -> Type)-kind types.

type Freeze'' m v' v = forall i e. Freeze m (v' i e) (v i e)

Freeze contraint for (Type -> Type -> Type)-kind types.