Skip to content

Commit

Permalink
Update AUTHORS.md, CHANGES.md, and README.md for 0.10.1.
Browse files Browse the repository at this point in the history
This commit bumps the version in the README. It also adds change log entries
for 0.10.1 (the new release), as well as for 0.9.1. (the previous release)
which were absent.

Also adds six new contributors to AUTHORS.md.
  • Loading branch information
non committed May 16, 2015
1 parent a927a5b commit 833a8f8
Show file tree
Hide file tree
Showing 3 changed files with 56 additions and 11 deletions.
6 changes: 6 additions & 0 deletions AUTHORS.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ possible.
* Jean-Remi Desjardins: documentation fixes
* Suminda Dharmasena: feature requests and bug reports
* Rob Emanuele: cfor macro bug reports and fixes, benchmarking
* Siddhartha Gadgil: bug fixes
* Christopher Hodapp: documentation fixes
* Lars Hupel: core maintainer, law-checking, release support
* Ben Hutchison: bug reports and design suggestions
Expand All @@ -33,11 +34,15 @@ possible.
* Dušan Kysel: author of Ziggurat, MersenneTwister and WELL PRNGs
* Josh Marcus: bug reports and benchmarking
* Brian McKenna: documentation fixes
* Kevin Meredith: bug fixes, bug reports, and documentation
* Simon Ochsenreither: bug reports and build contributions
* Erik Osheim: core maintainer
* Adam Pingel: bug fixes
* Pablo Pita: documentation
* Alexey Romanov: add PCG random number generator
* Denis Rosset: work on Number, PartialOrder, Interval, and more
* Lukas Rytz: bug fixes
* Kazuhiro Sera: build updates and support
* Tom Switzer: core maintainer
* Flaviu Tamas: byte-manipulation and bounds-checking macros
* James Thompson: author of spire.math.Polynomial
Expand All @@ -47,6 +52,7 @@ possible.
* William Waites: bug fixes
* Kenji Yoshida: bug fixes
* Benito van der Zander: many bug reports, and much good testing
* Alec Zorab: clean up and tests

We've tried to include everyone, but if you've made a contribution to
Spire and are not listed, please feel free to open an issue or pull
Expand Down
41 changes: 41 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,44 @@
## Version 0.10.1

(Version 0.10.0 was aborted due to errors during the release.)

Fixes:

* Major refactor/improvements to Algebraic (Tom Switzer)
* Remove unneeded imports (Kenji Yoshida)
* Fix SBT build (Kenji Yoshida)
* Update README to display correct mailing list (Pablo Pita)
* Remove superfluous Interval#min param (Siddhartha Gadgil)
* Fix code examples in README (Kevin Meredith)
* Add support for pattern matching SafeLong (Kevin Meredith)
* Improve Opt and add tests (Alec Zorab)
* Fix tail recursion with Opt (Kenji Yoshida)
* Remove ApproximationContext entirely (Erik Osheim)
* Update sbt, scala and library versions (Kazuhiro Sera)
* Fix hashCode/equals for polynomials (Erik Osheim)
* Add pretty stringifcation to polynomials (Rüdiger Klaehn)
* Many new polynomial tests (Rüdiger Klaehn)
* Fix cooperative equality on Rational (Erik Osheim)
* Create DESIGN.md for implementation docs (Rüdiger Klaehn)
* Improve Interval tests, fix bugs (Denis Rosset)
* Add PCG-based Generator (Alexey Romanov)
* Fix Float/Double GCD bugs (Tom Switzer)
* Improve SafeLong test coverage (Erik Osheim)
* Improve Rational test coverage, fix bugs (Rüdiger Klaehn)
* Many Rational efficiency improvements (Rüdiger Klaehn)
* Add scoverage support (Rüdiger Klaehn)
* Fix ULong bugs (Erik Osheim)

## Version 0.9.1

* Interval bug fixes (Denis Rosset)
* Efficiency improvements for Rational (Rüdiger Klaehn)
* Improve and document NumberTag (Tom Switzer)
* Add support and tests for partial actions (Denis Rosset)
* Add Opt[_] type for unboxed optional values (Denis Rosset)
* Add Gitter chat room to README (Erik Osheim)
* Fix bug with root-finding for Long values (Erik Osheim)

## Version 0.9.0

The project now builds with Scala 2.11.4 by default.
Expand Down
20 changes: 9 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ Spire is provided to you as free software under the
[MIT license](COPYING).

The [Spire mailing list](http://groups.google.com/group/typelevel/)
is shared with other [Typelevel projects](http://typelevel.org).
It is the place to go for announcements and discussions around Spire.
is shared with other [Typelevel projects](http://typelevel.org).
It is the place to go for announcements and discussions around Spire.
When posting, place the word [spire] at the begining of your subject.
We also have a guide on [contributing to Spire](CONTRIBUTING.md) as well
as a guide that provides information on [Spire's design](GUIDE.md).
Expand All @@ -42,13 +42,11 @@ To get started with SBT, simply add the following to your `build.sbt` file:
scalaVersion := "2.11.4"
// or scalaVersion := "2.10.4"
libraryDependencies += "org.spire-math" %% "spire" % "0.9.1"
libraryDependencies += "org.spire-math" %% "spire" % "0.10.1"
```

(If you must use Spire with 2.9.x, there is an older 0.3.0 release available.)

For Maven instructions, and to download the jars directly, visit the
[Central Maven repository](http://search.maven.org/#artifactdetails%7Corg.spire-math%7Cspire_2.11%7C0.9.1%7Cjar).
[Central Maven repository](http://search.maven.org/#artifactdetails%7Corg.spire-math%7Cspire_2.11%7C0.10.1%7Cjar).

### Playing Around

Expand Down Expand Up @@ -190,7 +188,7 @@ can be total (`Order`) or partial (`PartialOrder`); although undefined elements
+ pmin: find the least value if the elements are comparable; returns an `Option`
+ pmax: find the greated value if the elements are comparable; returns an `Option`
+ gt (`>`), gteqv (`>=`), lt (`<`) and lteqv (`<=`) return false if the elements are incomparable, or the result of their comparison

[1] For floating-point numbers, alternate implementations that take `NaN` into
account can be imported from `spire.optional.totalfloat._`.

Expand Down Expand Up @@ -257,7 +255,7 @@ are parameterized on 2 types: the vector type and the scalar type.
+ timesl (`*:`): scalar multiplication
* *VectorSpace*
+ divr (`:/`): scalar division
* *NormedVectorSpace*
* *NormedVectorSpace*
+ norm: vector norm
+ normalize: normalizes vector (so norm is 1)
* *InnerProductSpace*
Expand Down Expand Up @@ -412,15 +410,15 @@ There are two methods defined:
* `quickSelect` usually faster, not stable, potentially bad worst-case
* `linearSelect` usually slower, but with guaranteed linear complexity
* `select` alias for `quickSelect`

Searching methods are located in the `spire.math.Searching`
object. Given a sorted array (or indexed sequence), these methods
will locate the index of the desired element (or return -1 if it is
not found).

* `search(array, item)` finds the index of `item` in `array`
* `search(array, item, lower, upper)` only searches between `lower` and `upper`.

Searching also supports a more esoteric method:
`minimalElements`. This method returns the minimal elements of a
partially-ordered set.
Expand Down

0 comments on commit 833a8f8

Please sign in to comment.