Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
LaurentRDC committed Jan 27, 2025
1 parent b4ea203 commit f75896a
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 17 deletions.
20 changes: 5 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,24 @@
# Haskell implementation of labeled one-dimensional arrays
# Haskell implementation of data structures for data science

Packages in this repository implement series, or labeled one-dimensional arrays, and associated functions.

Like [`Data.Map.Strict`](https://hackage.haskell.org/package/containers/docs/Data-Map-Strict.html), series support efficient:

* random access by key ( $\mathcal{O}\left( \log n \right)$ ) ;
* slice by key ( $\mathcal{O}\left( \log n \right)$ ).

Like [`Data.Vector.Vector`](https://hackage.haskell.org/package/vector/docs/Data-Vector.html), series support efficient:

* random access by integer index ( $\mathcal{O}\left( 1 \right)$ );
* slice by integer index ( $\mathcal{O}\left( 1 \right)$ );
* numerical operations.
Packages in this repository implement series and dataframes, data structures which are ubiquitous in data science.

## Tutorial and documentation

A tutorial and interface documentation for the most recent published version are [available here](https://hackage.haskell.org/package/javelin).
A tutorial and interface documentation for the most recent published version are [available here for series](https://hackage.haskell.org/package/javelin). A tutorial and interface documentation for dataframes is coming.

Locally, you can generate documentation for all packages using `haddock` like so:

```bash
cabal haddock javelin
cabal haddock javelin-io
cabal haddock javelin-frames
```

## Get involved!

Do not hesitate to make feature requests or report bugs via the [issue tracker](https://github.com/LaurentRDC/javelin/issues).

## Preliminary benchmarks
## Preliminary benchmarks for series

Looking up random integers:

Expand Down
2 changes: 0 additions & 2 deletions javelin-frames/test/Test/Data/Frame.hs
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,6 @@ data User f
}
deriving (Generic)

f :: Frame User -> Int
f = Frame.foldlFrame (\acc (MkUser _ age) -> acc + age) 0

instance Frameable User
deriving instance Show (Row User)
Expand Down

0 comments on commit f75896a

Please sign in to comment.