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
  • 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 tokenize method, which must be overridden by the user. This transforms the string into an array of Tokens which represent the string in terms of its parts.

    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
    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. def parseAfterValueChar(char: Char): Option[Token[ComplexFunction]]

    Determines if the character represents a token that comes after a value or close parenthesis.

    Determines if the character represents a token that comes after a value or close parenthesis.

    Operators belong here, as they come after values (for example, in 2 + 3 the + comes after the 2). Close parentheses also belong here, as do argument separators.

    In order to determine if a special character belongs here, ask yourself 'Would it make sense after a constant?'. If the answer is yes, it belongs here.

    char

    A character in the expression being parsed

    returns

    None if the input is not a special character, or the character does not belong after a value. Some(Token) otherwise, where the token represents the character's purpose.

    Attributes
    protected
    Definition Classes
    ComplexEvaluator → AbstractEvaluator
  17. def parseOtherChar(op: Char): Option[Token[ComplexFunction]]

    Determines if the character represents a token that 1) comes after an operator, 2) comes after a function, 3) follows an open parenthesis, or 4) is at the start of an expression.

    Determines if the character represents a token that 1) comes after an operator, 2) comes after a function, 3) follows an open parenthesis, or 4) is at the start of an expression. start of an expression.

    Unary operators must be defined here, as they come after operators. The unary operator token must be a Function token. A character can be both a binary operator (one that works on two operands) and a unary operator (one that works on one operand), however, they must have distinct tokens.

    Open parentheses also belong here, as they come after operators (for example, 2 * (3 + 4)) or functions (sin(2)). However, close parentheses do not, instead, they belong in the parseAfterValueChar method.

    In order to determine if a special character belongs here, ask yourself 'Would it make sense at the start of an expression?' If the answer is yes, it belongs here.

    returns

    None if the input is not a special character, or does not belong in the specified positions.

    Attributes
    protected
    Definition Classes
    ComplexEvaluator → AbstractEvaluator
  18. def parseWord(word: String): Token[ComplexFunction]

    Parses a possible word.

    Parses a possible word.

    word

    The word to parse

    returns

    The token representation of the word

    Attributes
    protected
    Definition Classes
    ComplexEvaluator → AbstractEvaluator
    Exceptions thrown

    net.totietje.evaluator.EvaluationException If the input string is not a valid word

  19. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  20. def toString(): String
    Definition Classes
    AnyRef → Any
  21. final def tokenize(expression: String): Array[Token[ComplexFunction]]

    Transforms an expression into a list of tokens.

    Transforms an expression into a list of tokens.

    expression

    The input string to parse

    returns

    An array of tokens containing the information needed to evaluate it

    Attributes
    protected
    Definition Classes
    AbstractEvaluator → Evaluator
    Exceptions thrown

    net.totietje.evaluator.EvaluationException If the input string contains an invalid token

  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. 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