changelog.yaml

# template
# - version: 1.0
#   # important (tl; dr)
#   dependencies: # [{!package: String, ~since: String, ~upto: String}]
#   crutches:     # [String]
#   fixes:        # [String]
#   deprecations: # [String]
#   improvements: # [String: String]
#
#   # news (non-breaking changes)
#   modules:         # [{String: String}]
#   definitions:     # [{String: [String]}]
#   classes:         # [{String: String}]
#   class-functions: # [{String: [String]}]
#   types:           # [{String: String}]
#   type-families:   # [{String: [String]}]
#   exceptions:      # [{String: [String]}]
#   syntax:          # [String]
#   tests:           # [String: String; ~Suite]
#   benchmarks:      # [{String: String}]
#
#   # changes (breaking changes)
#   moved:        # [{String: String}]
#   changes:      # [{String: String}]
#   superclasses: # [{String: [String]}]
#   removed:      # [{String: [String]}]

---

- version: 0.2.1.1
  # important
  dependencies:
    - package: ghc-prim
      since: 0.5.3
      upto: 0.9

  fixes:
    - macOS build issue (by flurie)

- version: 0.2.1
  # important
  dependencies:
    - package: ghc-prim
      since: 0.5.3
      upto: 0.7

    - package: data-default-class
      since: 0.1
      upto: 0.2

    - package: base
      since: 4.8
      upto: 5

    - package: fmr
      since: 0.2
      upto: 1

  fixes:
    - isPrefixOf and isSuffixOf definitions
    - typo in the word 'Concurrent' in Control.Concurrent.SDP.* module names

  deprecations:
    - SDP.Indexed.Indexed.updates' in favour 'update', will be removed in sdp-0.3
    - SDP.Indexed.Indexed.update' will be moved to SDP.Map.Map class in sdp-0.3
    - SDP.Indexed.Indexed.write' will be moved to SDP.Map.Map class in sdp-0.3

    - SDP.IndexedM.IndexedM.updateM' will be moved to SDP.MapM.MapM class in sdp-0.3
    - SDP.IndexedM.IndexedM.writeM' will be moved to SDP.MapM.MapM class in sdp-0.3

  improvements:
    - added 'Nullable' instances for pointers and default definition for 'lzero'

  # news
  modules:
    - Control.Concurrent.SDP.TArray: same as Control.Concurrent.SDP.TArray
    - Control.Concurrent.SDP.TUnlist: same as Control.Concurrent.SDP.TUnlist
    - Control.Concurrent.SDP.TUnrolled: same as Control.Concurrent.SDP.TUnrolled

    - SDP.ZipM: monadic version of SDP.Zip

  definitions:
    - SDP.LinearM:
        - "(:+=)"
        - "(:=+)"
        - "(:~=)"
    - SDP.Unboxed:
        - lzero#
        - single#
        - concat#
        - pconcat
        - psizeof#
        - fromList#
        - fromListN#
        - newLinear#
        - newLinearN#
        - thawUnboxed#
        - fromFoldable#
        - fromFoldableM#
        - freezeUnboxed#
        - cloneUnboxedM#

        - fromProxy
        - fromProxy1
        - pnewUnboxed'
        - pnewUnboxed1'
        - pthawUnboxed
        - pcloneUnboxed
        - pcloneUnboxed1
        - pfreezeUnboxed
        - pcopyUnboxedM1
        - pcloneUnboxedM
        - pcloneUnboxedM1
  classes:
    - ZipM: monadic version of SDP.Zip.Zip

  class-functions:
    - Linear:
        - after
        - before
        - remove
        - o_foldr1
        - o_foldl1
        - o_foldr1'
        - o_foldl1'
    - LinearM:
        - lshiftM
        - foldrM1
        - foldlM1

    - ZipM:
        - zipM
        - zipM3
        - zipM4
        - zipM5
        - zipM6

        - mzipWith
        - mzipWith3
        - mzipWith4
        - mzipWith5
        - mzipWith6

        - zipWithM
        - zipWithM3
        - zipWithM4
        - zipWithM5
        - zipWithM6
  types:
    - Wrap: service wrapper type for some fo SDP.Unboxed definitions

# ---------------------------------------------------------------------------- #
# ############################################################################ #
# ---------------------------------------------------------------------------- #

- version: 0.2
  # important
  dependencies:
    - package: ghc-prim
      since: 0.5.3
      upto: 0.7

    - package: data-default-class
      since: 0.1
      upto: 0.2

    - package: base
      since: 4.8
      upto: 5

  fixes:
    - prevTest and nextTest memory leak
    - some Ord instances, now lexicographical
    - assoc and assoc' for non-standard ranges
    - Freeze instances for Array, Ublist and ByteList
    - unsafeIndex definition for unsigned numeric types
    - test suite for Sort, new generate Medium structures
    - tails and inits, now returns [Z] if structure is empty
    - copied' for Array/Bytes and related segfault in timSort

  improvements:
    - structures: size and offset encapsulation by pseudo-primive types
    - templates: bordered and chunk structures generalized by templates
    - tests: moved to sdp-quickcheck package

  # news
  modules:
    - SDP.Templates.AnyBorder: arbitrary-bordered structure template
    - SDP.Templates.AnyChunks: chunk stream template

    - SDP.Unrolled.IOUnlist: see IOUnlist
    - SDP.ByteList.IOUblist: see IOUblist

    - SDP.Unrolled.IO: see IOUnrolled
    - SDP.ByteList.IO: see IOByteList

    - SDP.Array.IO: see IOArray
    - SDP.Bytes.IO: see IOBytes

    - SDP.Prim.SArray: boxed pseudo-primitives SArray#, STArray# and MIOArray#
    - SDP.Prim.SBytes: unboxed pseudo-primitives SBytes#, STBytes# and MIOBytes#

    - SDP.SortM.Insertion: InsertionSort for mutable structures
    - SDP.SortM.Tim: TimSort for mutable structures

    - SDP.Comparing: common comparators, exported by SDP.SafePrelude
    - SDP.Finite: common n-dimensional index, exported by SDP.Index
    - SDP.Shape: new Index superclass for rank operations.
    - SDP.Tuple: tiple synonyms, exported by SDP.Index
    - SDP.Map: dictionaries

    - SDP.Shaped: see Shaped class

    - Text.Show.SDP: Show commons
    - Text.Read.SDP: Read commons

  definitions:
    - SDP.SafePrelude:
        - "(?+)"
        - "(?-)"
        - "(?^)"
        - "(...)"
        - "(<=<<)"
        - "(>>=>)"
        - "(>>=<<)"
        - stToMIO
    - SDP.Estimate:
        - "(<=.>)"
        - "(<=.)"
        - "(>=.)"
        - "(==.)"
        - "(/=.)"
        - "(<.)"
        - "(>.)"
    - SDP.Unboxed:
        - sizeof#
        - psizeof
        - cloneUnboxed#
    - SDP.Index:
        - takeDim
        - dropDim
        - splitDim
        - offsetIntegral
        - defaultBoundsUnsign
    - SDP.Linear:
        - sorted
        - ascending
        - stripPrefix'
        - stripSuffix'
    - SDP.LinearM:
        - SplitM
        - sortedM
        - swapM
    - SDP.Indexed:
        - binaryContain

  classes:
    - SubIndex: constraint synonym for internal class
    - Shaped: additional functions for indexed structures
    - SplitM: mutable version of Split
    - Shape: new Index superclass
    - Map: class of dictionaries

  class-functions:
    - BorderedM:
        - nowIndexIn
        - offsetOf
        - indexOf
    - Unboxed:
        - sizeof
        - copyUnboxed#
        - copyUnboxedM#
    - IFoldM:
        - ofoldrM
        - ofoldlM
    - Freeze:
        - unsafeFreeze
        - defLimit
        - defaultBounds
    - IFold:
        - ofoldr
        - ofoldl
    - Index:
        - shape
        - slice
    - Thaw:
        - unsafeThaw
    - Set:
        - groupSetWith
    - Bordered:
        - offsetOf
        - indexIn
    - Indexed:
        - update
    - LinearM:
        - nowNull
        - newSingle
        - getHead
        - getLast
        - prepend
        - append
        - writeM
        - copyTo
        - (!#>)
    - Linear:
        - selects'
        - extract'
        - selects
        - extract
        - select'
        - uncons'
        - unsnoc'
        - select
        - except
        - write
        - (!^)
    - Shaped:
        - slicesOf
        - rebound
        - (!!)

    - Split:
        - keep
        - sans
        - save
        - skip
        - each
        - each'
        - combo
        - chunks
        - divide
        - divides
        - infixes
        - splitBy
        - divideBy
        - splitsBy
        - splitsOn
        - removeAll
        - replaceBy
        - selectEnd
        - extractEnd
        - complement
        - selectEnd'
        - extractEnd'
        - selectWhile
        - selectWhile'
        - extractWhile
        - extractWhile'

  types:
    - IOByteList: mutable unboxed unrolled linked list in monad IO with bounds
    - IOUnrolled: mutable boxed unrolled linked list in monad IO with bounds
    - IOUblist: mutable unboxed unrolled linked list in monad IO
    - IOUnlist: mutable boxed unrolled linked list in monad IO
    - IOBytes: mutable unboxed array in monad IO
    - IOArray: mutable boxed array in monad IO

  type-families:
    - Shape:
        - GIndex
        - DimLast
        - DimInit
    - Index:
        - (:|:)

  exceptions:
    - IndexException:
        - UnexpectedRank

  syntax:
    - Overloaded indices

  benchmarks:
    - bench-sort: for immutable timSort

  # changes
  moved:
    - indexOf: indexIn
    - reshape: reshaped
    - Index.rank: Shape.rank
    - getIndexOf: nowIndexIn
    - Indexed.(!^): Linear.(!^)
    - Indexed.write: Linear.write
    - Bordered.assocs: Indexed.assocs
    - Bordered.getAssocs: IndexedM.getAssocs
    - SDP.SortM.Stuff: SDP.SortM.Tim

  changes:
    - (/>): removed second argument, now updates all elements in structure
    - Bordered: removed 'e' parameter (Bordered b i e => Bordered b i)
    - BorderedM: removed 'e' parameter (BorderedM m b i e => BorderedM b i)
    - instances: Read and Show for (:&), now list-like and require IsList

  superclasses:
    - Scan:
        - (Linear s a)
    - Estimate:
        - ()

    - IFold:
        - (Index i)
    - IFold:
        - (Monad m, Index i)

    - Indexed:
        - (Linear v e, Bordered v i e)
    - IndexedM:
        - (LinearM m v e, BorderedM m v i e)
    - Bordered:
        - (Index i, Estimate b)

  removed:
    - SDP.Index:
        - IndexEQ
        - toBounds
        - unsafeBounds
    - SDP.Estimate:
        - EL
    - SDP.Tree.BinTree:
        - SDP.Tree.BinTree

# ---------------------------------------------------------------------------- #

- version: 0.1.1
  # news
  definitions:
    - SDP.IndexedM:
        - reshape
        - fromAccum
    - SDP.Indexed:
        - imap
        - accum

  classes:
    - IFold: folds with indices
    - IFoldM: mutable folds

# ---------------------------------------------------------------------------- #

- version: 0.1
  # important
  deprecations:
    - SDP.Tree.BinTree: too slow, inneificient and unuseful

  # news
  modules:
    - Test.SDP.Sort: very short test suite

  classes:
    - Freeze: freeze mutable structure (to immutable)
    - Thaw: thaw immutable structure (to mutable)

  class-functions:
    - IndexedM:
        - (!#>)
        - write_
        - fromIndexed'
        - fromIndexedM
    - Indexed:
        - (!^)
        - fromIndexed

  # changes
  moved:
    - arrcopy: SDP.SortM.Stuff.arrcopy (internal)
    - write: from SDP.Indexed module namespace to Indexed class
    - estimates: internal comparators to SDP.Estimate module

# ---------------------------------------------------------------------------- #

- version: 0.0.2
  # important
  fixes:
    - old bug in SDP.Index.inBounds ("wrong" Ord for default declaration)

  # news
  modules:
    - SDP.Array.ST: see STArray
    - SDP.Bytes.ST: see STBytes

    - SDP.Unrolled.ST: see STUnrolled
    - SDP.ByteList.ST: see STByteList

    - SDP.Unrolled.STUnlist: see STUnlist
    - SDP.ByteList.STUblist: see STUblist

  classes:
    - IndexEQ: service class, provisional

    - BorderedM: for bounds operations
    - IndexedM: common indexed operations on mutable structures
    - LinearM: common list-like operations on mutable structures
    - SortM: mutable version of Sort class

  types:
    - STArray: mutable boxed array in monad ST
    - STBytes: mutable unboxed array in monad ST
    - STUnlist: mutable boxed unrolled linked list in monad ST
    - STUblist: mutable unboxed unrolled linked list in monad ST
    - STUnrolled: mutable boxed unrolled linked list in monad ST with bounds
    - STByteList: mutable unboxed unrolled linked list in monad ST with bounds

# ---------------------------------------------------------------------------- #

- version: 0.0.1.2
  # important
  improvements:
    - IsString and IsList instances

# ---------------------------------------------------------------------------- #

- version: 0.0.1.1
  # important
  improvements:
    - Set instance for BinTree
    - Semigroup and Monoid instances

# ---------------------------------------------------------------------------- #

- version: 0.0.1.0
  # important
  fixes:
    - Some stupid bugs

  # news
  exceptions:
    - UnreachableException:
        - UnreachableException

# ---------------------------------------------------------------------------- #

- version: 0.0.0.11
  # news
  types:
    - BinTree: binary tree

# ---------------------------------------------------------------------------- #

- version: 0.0.0.10
  # news
  definitions:
    - SDP.Linear:
        - stripPrefix
        - stripSuffix

  class-functions:
    - Linear:
        - partitions
    - Split:
        - parts

  types:
    - ByteList: immutable unboxed unrolled linked list with bounds

# ---------------------------------------------------------------------------- #

- version: 0.0.0.9
  # important
  fixes:
    - implemented lost functions (prefix, suffix) for [a]

  improvements:
    - Test suite rewrited and documented

  # news
  types:
    - Bytes: immutable unboxed array with bounds

  removed:
    - SDP.Unboxed:
        - fillByteArray#

# ---------------------------------------------------------------------------- #

- version: 0.0.0.8
  # news
  classes:
    - Unboxed: for generalized ByteArray# and MutableByteArray# operations

# ---------------------------------------------------------------------------- #

- version: 0.0.0.7
  # important
  improvements:
    - Linear and LineS now completely (formally) independent of Foldable

  # news
  internal:
    - Added STUArray (rewrited Data.Array.Base type)

# ---------------------------------------------------------------------------- #

- version: 0.0.0.6
  # important
  dependencies:
    - package: ghc-prim
      min: 0.5.3
      max: 0.6

  # news
  classes:
    Sort: for immutable structures sorting

# ---------------------------------------------------------------------------- #

- version: 0.0.0.5
  # important
  crutches:
    - upto: 0.2
      reasons: laziness and apathy
      crutch: |
        unsafeIndex for unsigned types fail on (-1). Structures with unsigned
        indices now indexed from 1

  improvements:
    - Haddock markup

# ---------------------------------------------------------------------------- #

- version: 0.0.0.4
  # important
  improvements:
    # This should be written in 'classes', but I'm too lazy to look at the old
    # commits that are added there.
    - Linear class extended
    - Tuple instances for Index

  # news
  classes:
    - Split: Linear extension for split functions
    - LineS: ShowS generalization, provisional

  types:
    - Unrolled: immutable boxed unrolled linked list with bounds

# ---------------------------------------------------------------------------- #

- version: 0.0.0.3
  # important
  fixes:
    - Many stupid bugs

  # news
  tests:
    Suite: common tests for standard classes

# ---------------------------------------------------------------------------- #

- version: 0.0.0.2
  # news
  types:
    - Array: rewrited GHC.Arr

# ---------------------------------------------------------------------------- #

- version: 0.0.0.1
  # news
  classes:
    - Indexed: Common indexed operations on immutable structures
    - Linear: Common list-like operations on immutable structures
    - Set: Set class

    - Estimate: Lazy comparing by length
    - Index: Ix fork with pretty names and some Repa.Shape features
    - Scan: Generalization of scan* operations
    - Zip: Generalization of ZipWith, specific Applicative without pure

  exceptions:
    - IndexException:
        - EmptyRange
        - IndexOverflow
        - IndexUnderflow
        - UndefinedValue