2019-05-05 02:33:41 +00:00
# Apatite
2019-05-05 01:34:31 +00:00
2019-09-11 02:15:45 +00:00
[<img src="https://github.com/watzon/apatite/workflows/Crystal CI/badge.svg"> ](https://github.com/watzon/apatite/actions )
2019-09-11 02:12:04 +00:00
2019-08-23 20:45:07 +00:00
Apatite is a collection of mathematical and scientific algorithms. Currently it implements the API from Ruby's `Matrix` class for both `Matrix` and `Vector` . This API will be added to as needs arise. The goal is for this project to eventually contain everything you could get from SciPy, but in pure Crystal.
2019-05-05 01:34:31 +00:00
## Installation
1. Add the dependency to your `shard.yml` :
```yaml
dependencies:
apatite:
2019-05-05 02:33:41 +00:00
github: watzon/apatite
2019-05-05 01:34:31 +00:00
```
2. Run `shards install`
## Usage
```crystal
require "apatite"
```
2019-06-13 06:22:34 +00:00
Check out the [documentation ](https://watzon.github.io/apatite/ ) for usage examples.
2019-05-05 02:33:41 +00:00
## Roadmap
2019-06-13 06:22:34 +00:00
- [ ] Linear Algebra
- [x] Vector
2019-07-10 02:22:15 +00:00
- [x] Matrix
2019-06-13 06:22:34 +00:00
- [ ] NDArray
- [ ] Line
- [ ] Plane
- [ ] Polygon
- [ ] LinkedList
2019-06-11 23:13:05 +00:00
2019-05-05 01:34:31 +00:00
## Contributing
2019-05-05 02:33:41 +00:00
1. Fork it (< https: // github . com / watzon / apatite / fork > )
2019-05-05 01:34:31 +00:00
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
## Contributors
2019-09-11 02:12:04 +00:00
- [Chris Watson ](https://github.com/watzon ) - creator and maintainer
