Skip to content

Commit

Permalink
Merge branch 'master' of github.com:saschatimme/FixedPolynomials.jl
Browse files Browse the repository at this point in the history
  • Loading branch information
saschatimme committed Sep 19, 2017
2 parents 70a17ea + 143dca0 commit 718fb76
Showing 1 changed file with 20 additions and 5 deletions.
25 changes: 20 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# FixedPolynomials
[![Build Status](https://travis-ci.org/saschatimme/FixedPolynomials.jl.svg?branch=master)](https://travis-ci.org/saschatimme/FixedPolynomials.jl)
[![codecov](https://codecov.io/gh/saschatimme/FixedPolynomials.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/saschatimme/FixedPolynomials.jl)

| **Documentation** | **Build Status** |
|:-----------------:|:----------------:|
| [![][docs-stable-img]][docs-stable-url] | [![Build Status][build-img]][build-url] [![Build Status][winbuild-img]][winbuild-url] |
| [![][docs-latest-img]][docs-latest-url] | [![Codecov branch][codecov-img]][codecov-url] |

[FixedPolynomials.jl](https://github.com/saschatimme/FixedPolynomials.jl) is a library for
*really fast* evaluation of multivariate polynomials.
Expand All @@ -16,12 +19,12 @@ convert it then into a `FixedPolynomials.Polynomial` for further computations.
## Getting started

Install the this package via
```
```julia
Pkg.add("FixedPolynomials")
```

Here is an example on how to create a `Polynomial` with `Float64` coefficients:
```
```julia
using FixedPolynomials
import DynamicPolynomials: @polyvar

Expand All @@ -30,7 +33,19 @@ import DynamicPolynomials: @polyvar
f = Polynomial{Float64}(x^2+y^3*z-2x*y)
```
To evaluate `f` you simply have to pass in a `Vector{Float64}`
```
```julia
x = rand(3)
f(x) # alternatively evaluate(f, x)
```

[docs-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg
[docs-latest-img]: https://img.shields.io/badge/docs-latest-blue.svg
[docs-stable-url]: https://saschatimme.github.io/FixedPolynomials.jl/stable
[docs-latest-url]: https://saschatimme.github.io/FixedPolynomials.jl/latest

[build-img]: https://travis-ci.org/saschatimme/FixedPolynomials.jl.svg?branch=master
[build-url]: https://travis-ci.org/saschatimme/FixedPolynomials.jl
[winbuild-img]: https://ci.appveyor.com/api/projects/status/h2yw6aoq480e1etd/branch/master?svg=true
[winbuild-url]: https://ci.appveyor.com/project/saschatimme/fixedpolynomials-jl/branch/master
[codecov-img]: https://codecov.io/gh/saschatimme/FixedPolynomials.jl/branch/master/graph/badge.svg
[codecov-url]: https://codecov.io/gh/saschatimme/FixedPolynomials.jl

0 comments on commit 718fb76

Please sign in to comment.