case class Asinh(argument: ComplexFunction) extends UnaryFunction with Product with Serializable
A function which is the inverse hyperbolic sine of another.
When evaluated, the result will be the inverse hyperbolic sine of the result of evaluating the other function.
- argument
The function of which this is the inverse hyperbolic sine
- Source
- ComplexFunction.scala
- Alphabetic
- By Inheritance
- Asinh
- Serializable
- Serializable
- Product
- Equals
- UnaryFunction
- ComplexFunction
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
Asinh(argument: ComplexFunction)
- argument
The function of which this is the inverse hyperbolic sine
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
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)
- Definition Classes
- ComplexFunction
- See also
-
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)
- Definition Classes
- ComplexFunction
- See also
-
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)
- Definition Classes
- ComplexFunction
- See also
-
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)
- Definition Classes
- ComplexFunction
- See also
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
apply(in: Map[String, Complex]): 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
- returns
The evaluated function
- Definition Classes
- UnaryFunction → ComplexFunction
- Exceptions thrown
net.totietje.complex.VariableExceptionIf the function contains a variable undefined by the map
-
def
apply(value: Complex)(implicit variable: String): Complex
Evaluates this complex function, substituting the value for the given variable with the given value.
Evaluates this complex function, substituting the value for the given variable with the given value.
If the function contains a variable other than the one given, it will throw a VariableException.
- value
The value to substitute in for the variable
- variable
The variable whose value is to be substituted in
- returns
The evaluated function
- Definition Classes
- ComplexFunction
- Exceptions thrown
net.totietje.complex.VariableExceptionIf the function contains a variable other than the one given
-
def
apply(in: (String, Complex)*)(implicit default: Map[String, Complex] = Map()): Complex
Evaluates the complex function, substituting in the values for each variable as given in the input map in the form of tuple key-value pairs.
Evaluates the complex function, substituting in the values for each variable as given in the input map in the form of tuple key-value pairs.
If the function contains a variable whose value is not given by input variables, it will throw a VariableException.
If nothing is provided, it will be empty by default. Thus, if the function contains a variable, it will throw a VariableException.
- in
The variables to substitute in
- default
The default variable map, empty by default. If a variable is defined both by
inand bydefaults, the value given inintakes priority.- returns
The evaluated function
- Definition Classes
- ComplexFunction
- Exceptions thrown
net.totietje.complex.VariableExceptionIf the function contains a variable whose value is not given
-
val
argument: ComplexFunction
- Definition Classes
- Asinh → UnaryFunction
-
def
arguments: Seq[ComplexFunction]
The input arguments of this
ComplexFunction.The input arguments of this
ComplexFunction.- returns
The arguments
- Definition Classes
- UnaryFunction → ComplexFunction
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
derivative(implicit respect: String): ComplexFunction
Differentiates this function.
Differentiates this function.
If this function is not differentiable, then it should contain NaN, such that hasNaN returns true.
- respect
The variable to differentiate with respect to.
- Definition Classes
- Asinh → ComplexFunction
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
evaluable(implicit by: Set[String]): Boolean
Determines whether this function contains only the provided variables, and not any other.
Determines whether this function contains only the provided variables, and not any other.
For this to return true, it does not need to contain all the provided variables, but it must not contain any variables other than those provided.
If this method returns true, it means that the evaluating the function will not result in a VariableException being thrown if those variables are provided with values in the input map.
- by
The allowed variables. The implicit conversion
toSetallows the user to pass in only oneString, which will be converted to aSet[String].- returns
trueif the function does not contain any variables other than those provided
- Definition Classes
- ComplexFunction
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
hasNaN: Boolean
Whether this function contains the constant NaN.
Whether this function contains the constant NaN.
- returns
Whether this function contains the constant NaN.
- Definition Classes
- ComplexFunction
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
def
simplify: ComplexFunction
Simplifies this function.
Simplifies this function.
The returned function should be equivalent to the old function for all inputs. Simplified functions are likely to be faster, as they remove redundant calculations.
- returns
This function simplified
- Definition Classes
- Asinh → ComplexFunction
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
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
- Asinh → ComplexFunction → AnyRef → Any
-
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)
- Definition Classes
- ComplexFunction
-
def
variables: Set[String]
Returns all the variables which this function contains.
Returns all the variables which this function contains.
All of these variables must be provided in order to evaluate this function.
- returns
All the variables this function contains.
- Definition Classes
- ComplexFunction
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
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)
- Definition Classes
- ComplexFunction
- See also
This is the documentation for the Evaluator project (see GitHub).
The main package net.totietje.evaluator. The net.totietje.complex package contains an example usage of this package, which may also be useful.