Packages

sealed trait ComplexFunction extends AnyRef

This represents a function of complex variables. It can be evaluated using a map of the variables and their values. The function will then be evaluated, substituting in each variable's respective value, returning a complex number as its output.

Source
ComplexFunction.scala
See also

Complex

Linear Supertypes
AnyRef, Any
Known Subclasses
Abs, Acos, Acosh, Add, Arg, Asin, Asinh, Atan, Atanh, Conj, Constant, Cos, Cosh, Divide, Im, Log, Multiply, Power, Re, Sin, Sinh, Sqrt, Subtract, Tan, Tanh, UnaryMinus, Variable
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ComplexFunction
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def apply(in: Map[String, Complex] = Map()): Complex

    Evaluates the complex function, substituting in the values for each variable as given in the map.

    Evaluates the complex function, substituting in the values for each variable as given in the map.

    If the function contains a variable whose value is not given by the variable map, it will throw a VariableException.

    If no map is provided, it will be empty by default. Thus, if the function contains a variable, it will throw a VariableException.

    in

    The variable map, empty by default

    returns

    The evaluated function

    Exceptions thrown

    net.totietje.complex.VariableException If the function contains an undefined variable

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def *(that: ComplexFunction): Multiply

    Multiplies this function by another one.

    Multiplies this function by another one.

    This creates a compound function which, when evaluated, returns the result of evaluating this function multiplied by the result of evaluating the other.

    that

    The function to be multiplied by this one

    returns

    Multiply(this, that)

    See also

    Multiply

  4. def +(that: ComplexFunction): Add

    Adds this function to another one.

    Adds this function to another one.

    This creates a compound function which, when evaluated, returns the result of evaluating this function added to the result of evaluating the other.

    that

    The function to be added to this one

    returns

    Add(this, that)

    See also

    Add

  5. def -(that: ComplexFunction): Subtract

    Subtracts another function from this one.

    Subtracts another function from this one.

    This creates a compound function which, when evaluated, returns the result of evaluating this function minus the result of evaluating the other.

    that

    The function to be subtracted from this one

    returns

    Subtract(this, that)

    See also

    Subtract

  6. def /(that: ComplexFunction): Divide

    Divides this function by another one.

    Divides this function by another one.

    This creates a compound function which, when evaluated, returns the result of evaluating this function divided by the result of evaluating the other.

    that

    The function to divide this one by

    returns

    Divide(this, that)

    See also

    Divide

  7. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  12. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  19. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  20. def toString(): String

    Returns a string representation of this function.

    Returns a string representation of this function.

    returns

    A string representation of this function

    Definition Classes
    ComplexFunction → AnyRef → Any
  21. def unary_-: ComplexFunction

    Negates this function.

    Negates this function.

    This creates a function which, when evaluated, returns the negative of the result of evaluating this function.

    returns

    UnaryMinus(this)

  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( ... )
  25. def ~^(that: ComplexFunction): Power

    Raises this function to the power of another one

    Raises this function to the power of another one

    This creates a compound function which, when evaluated, returns the result of evaluating this function to the power of the result of evaluating the other.

    that

    The exponent

    returns

    Power(this, that)

    See also

    Power

Inherited from AnyRef

Inherited from Any

Ungrouped