Packages

o

net.totietje.complex

ComplexEvaluator

object ComplexEvaluator extends AbstractEvaluator[ComplexFunction]

An Evaluator which parses an expression as a ComplexFunction.

This allows the basic operators +, -, *, / and ^ and the use of brackets.

The following strings are treated as constants:

  • i
  • pi or π
  • tau or τ
  • e

Furthermore, the following functions are recognised:

  • im
  • re
  • arg
  • abs
  • conj
  • sqrt or √
  • log or ln
  • sin
  • asin
  • cos
  • acos
  • tan
  • atan
  • sinh
  • asinh
  • cosh
  • acosh
  • tanh
  • atanh

There is currently no support for implicit multiplication without the * symbol, such as 2i.

A string can be parsed like this:

val complexFunction = ComplexEvaluator.evaluate("2 + i * sin(x)")

That returned ComplexFunction can then be evaluated for a given input for x with:

val complexNumber = complexFunction(Map("x" -> xValue))

For example, replacing xValue with Complex.Pi would produce a complex number roughly equal to 2. It is recommended to then round the result by calling .round to round the number to an appropriate degree of accuracy.

Source
ComplexEvaluator.scala
Linear Supertypes
AbstractEvaluator[ComplexFunction], Evaluator[ComplexFunction], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ComplexEvaluator
  2. AbstractEvaluator
  3. Evaluator
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. final def evaluate(expression: String): ComplexFunction

    Parses a string.

    Parses a string.

    First of all, this tokenizes the string using the abstract tokenizer method, which must be overridden by the user. This returns a Tokenizer which breaks the string down into a Seq of Tokens, representing the principle parts of the string.

    Then, this evaluates the provided array of tokens as the user defines, producing a result of type R. For more information on how this happens, see Token.

    expression

    The input string to parse

    returns

    The result of parsing the input

    Definition Classes
    AbstractEvaluator → Evaluator
    Exceptions thrown

    net.totietje.evaluator.EvaluationException If there is a syntax error in the expression

  9. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  16. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. def tokenizer: Tokenizer[ComplexFunction]
    Attributes
    protected
    Definition Classes
    ComplexEvaluator → AbstractEvaluator
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AbstractEvaluator[ComplexFunction]

Inherited from Evaluator[ComplexFunction]

Inherited from AnyRef

Inherited from Any

Ungrouped