Skip to content

Latest commit

 

History

History
110 lines (78 loc) · 3.17 KB

README.md

File metadata and controls

110 lines (78 loc) · 3.17 KB
Raw

GitHub Workflow Status Release

math-parser

Introduction and Motivation

math-parser is a small Library created for a single purpose: It parses strings into abstract syntax trees (AST) of math-like languages. The AST can be used to easily reason over it, modify it, optimize it or derive it.

There are some predefined example languages, but the library is intended to be extended by your language to suite your needs.

Quick Overview

// your input, any string represesenting a function:
val string = "2*x*x + 1"

import mathParser.number.DoubleLanguage.given

// define your language:
object X
val language = mathParser.BuildIn.doubleLanguage.addVariable("x", X)

// parsing: string => Option[AST]
// Option.get only to demonstrate.
val parsed = language.parse(string).get

// evaluating:
parsed.evaluate {
  case X => 5 // assign values to your variables
} // == 2*5*5 + 1 == 51

// deriving:
val derived = parsed.derive(X) // d/dx (2*x*x + 1) == 4*x
derived.evaluate {
  case X => 5
} // == 4*5 == 20

Features

  • Modularity: The library is design to let you design your language as you like. Using a bunch of traits and the famous cake pattern, it is possible to define a language for exactly your use case.

  • Analytic Function Derivative: For the predefined languages it is possible to calculate analytical derivatives for arbitrary functions.

Setup

To use the library extend your sbt build with:

resolvers += "jitpack" at "https://jitpack.io"
libraryDependencies += "com.github.gregor-i.math-parser" %% "math-parser" % {current-version}

There is a subproject to work with spire.

libraryDependencies += "com.github.gregor-i.math-parser" %% "math-parser-spire" % {current-version}

Examples and Usage

To get started take a look into the examples folder.

Changelog

1.7:

  • removed second type parameter for operators. the operators are now distinguished with the marker traits UnitaryOperator and BinaryOperator.

1.6.2:

  • Deploy artifacts to jitpack as bintray dropped it's free service

1.6.1:

  • fixed issue with power of zero

1.6:

  • updated scalajs to 1.1.
  • spire was extracted into its own submodule. This will not be build for scalajs, as spire is not compatible with scalajs 1.1.
  • Core now contains an implementation for complex numbers. Some imports have to be changed.
  • Dropped support for scala 2.12.

1.5.3:

  • performance optimization
  • enrichments for Node

1.5.2:

  • dependency updates
  • jar size reduced

1.5.1:

  • performance optimization

1.5:

  • upgrade to scala 2.13
  • replaced Symbols with String

1.4:

  • reworked the whole library. It no longer uses the cake pattern, but instead uses typeclasses.
  • It now easier to construct a language and to work with it. No more path dependant typing.

1.3:

  • Cross compilation for scala-js
  • runtime compilation has been extracted from math-parser and moved into its own module math-parser-compile-jvm.

1.2:

  • Fixed missing constant i for ComplexLanguage