Skip to content
Experimental project to lay out basic algebra type classes
Scala Shell
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
benchmark
core/src
docs/src/main Post-2.10 cleanup (#229) May 20, 2019
laws
project
scripts sbt 1.1.1 (#212) Feb 26, 2018
.gitignore
.jvmopts Add sbt launcher script with .jvmoptions file. Aug 2, 2015
.travis.yml
CHANGELOG.md Create an Algebra microsite (#193) Dec 10, 2016
CODE_OF_CONDUCT.md
CONTRIBUTING.md
COPYING
README.md
build.sbt
sbt sbt 1.1.1 (#212) Feb 26, 2018
travis-deploy-key.enc
version.sbt

README.md

Build Status Coverage status Gitter Maven Central

algebra

the vision

This repo represents an attempt to unify the basic algebraic type classes from Spire and Algebird. By targeting just these type classes, we will distribute an algebra package with no dependencies (except for cats-kernel) that works with Scala 2.11 and 2.12, which can be shared by all Scala libraries interested in abstract algebra.

Since the creation of Algebra, we have also decided to interoperate with the Cats project. Algebra and Cats interoperate using the cats-kernel module.

See the Algebra website for more information. The latest API docs are hosted at Algebra's ScalaDoc index.

getting algebra

Algebra supports Scala 2.11 and 2.12 and is available from Sonatype (and Maven Central). In addition to the JVM, Algebra also supports Scala.js.

To use algebra in your own projects, include this snippet in your build.sbt file:

libraryDependencies += "org.typelevel" %% "algebra" % "1.0.1"

If you want to use Algebra's laws, you can include those as well with this snippet:

libraryDependencies += "org.typelevel" %% "algebra-laws" % "1.0.1"

what we have so far

This repo has been seeded with most of the contents of spire.algebra, and has been modified to fit an initially-conservative and shared vision for algebraic type classes. Discussions over removals and additions should take place on the issue tracker or on relevant pull requests.

Projects using Algebra

participants

Anyone who wants to participate should feel free to open issues or send pull requests to this repo.

The following people are Algebra maintainers (i.e. have push access):

development process

Please make a pull request against the master branch. For those who can merge pull requests, we follow these rules:

  1. Do not merge your own PR unless N people have signed-off on the PR (e.g. given a thumbs-up, +1, shipit, etc) and Travis is green.

  2. If you are not the author, and you see (N - 1) sign-offs and Travis is green, just click merge and delete the branch.

  3. Currently, N = 2.

algebra overview

Algebra uses type classes to represent algebraic structures. You can use these type classes to represent the abstract capabilities (and requirements) you want generic parameters to possess.

For a tour of the Algebraic structures that algebra offers, see the extensive overview on the Algebra website.

Code of Conduct

See the Code of Conduct

Copyright and License

All code is available to you under the MIT license, available at http://opensource.org/licenses/mit-license.php and also in the COPYING file.

Copyright the maintainers, 2015-2016.

You can’t perform that action at this time.