Number - Scala Mathematical Library
1.10.6
API
Generated with
Number - Scala Mathematical Library/com.phasmidsoftware.number/com.phasmidsoftware.number.core/com.phasmidsoftware.number.core.inner/Logarithmic

Logarithmic

com.phasmidsoftware.number.core.inner.Logarithmic
See theLogarithmic companion object
sealed trait Logarithmic extends Factor

Trait to define a Factor which indicates that the true value of a Number with this Factor is the base raised to the power of the (nominal) Value.

Attributes

Companion
object
Graph
Supertypes
trait Factor
class Object
trait Matchable
class Any
Known subtypes
object Euler
object Log10
object Log2
object NatLog

Members list

Value members

Concrete methods

def add(x: Value, y: Value, f: Factor, negative: Boolean): Option[ProtoNumber]

Adds two values together and computes an appropriate factor for the result.

Adds two values together and computes an appropriate factor for the result.

Value parameters

f

the factor associated with y

negative

NOTE ignored.

x

the first value

y

the addend

Attributes

Returns

an optional tuple containing the resultant value and its factor

def asPower(v: Value): Option[String]

Converts a given value into a string representation of its corresponding power notation or root notation based on specific conditions.

Converts a given value into a string representation of its corresponding power notation or root notation based on specific conditions.

Value parameters

v

the value to be converted, which can represent an integer power or a rational root.

Attributes

Returns

a string representing the value in power notation, root notation, or a generic exponential format.

def canMultiply(f: Factor): Boolean

Determines whether the current factor can be multiplied by the given factor.

Determines whether the current factor can be multiplied by the given factor.

TODO implement me properly

Value parameters

f

the factor to be checked for compatibility with multiplication.

Attributes

Returns

true if the factors can be multiplied; false otherwise.

def canShow(value: Value): Boolean

Determines whether given value with this Factor can be rendered exactly.

Determines whether given value with this Factor can be rendered exactly.

Attributes

Returns

true if this Factor can be rendered exactly; false otherwise.

def convert(v: Value, f: Factor): Option[Value]

Convert a value x from this factor to f if possible, using simple scaling. Result is defined only if f is Logarithmic.

Convert a value x from this factor to f if possible, using simple scaling. Result is defined only if f is Logarithmic.

Value parameters

f

the factor of the result.

v

the value to be converted.

Attributes

Returns

a Try of Value which, given factor f, represents the same quantity as x given this.

def doRaiseByPureNumber(x: Value, y: Value): Option[ProtoNumber]

Raises the value x to the power of the value y.

Raises the value x to the power of the value y.

Value parameters

x

the base value to be raised

y

the exponent value (from a PureNumber)

Attributes

Returns

an optional result of type ProtoNumber, representing the computed value if the operation is valid, or None otherwise

def invert(x: Value): Option[ProtoNumber]

Inverts the given value by raising it to the power of -1, using a pure number factor.

Inverts the given value by raising it to the power of -1, using a pure number factor.

Value parameters

x

the value to be inverted

Attributes

Returns

an optional result of type ProtoNumber, representing the inverted value if the operation is valid, or None otherwise

def isA(context: CoreContext): Boolean

Determines if the current factor satisfies certain conditions within the given context.

Determines if the current factor satisfies certain conditions within the given context.

Value parameters

context

the context in which the factor is evaluated.

Attributes

Returns

a Boolean indicating whether the factor satisfies the specified conditions in the given context.

def modulate(v: Value): Value

Modulates a given value and returns the result.

Modulates a given value and returns the result.

Value parameters

v

the value to be modulated

Attributes

Returns

the original value

def multiply(x: Value, y: Value, f: Factor): Option[ProtoNumber]

Multiplies two values together and computes an appropriate factor for the result. TODO implement for Log10

Multiplies two values together and computes an appropriate factor for the result. TODO implement for Log10

Value parameters

f

the factor associated with y

x

the first value

y

the multiplicand

Attributes

Returns

an optional tuple containing the resultant value and its factor

def negate(x: Value): Option[ProtoNumber]

Negates the given value and returns the result as an optional ProtoNumber.

Negates the given value and returns the result as an optional ProtoNumber.

Value parameters

x

the value to be negated

Attributes

Returns

an optional ProtoNumber representing the negated value, or None if the operation is invalid

override def render(x: Value): String

Renders a string representation of the given value based on specific conditions. If the value can be represented in power or root notation, it uses that representation; otherwise, it falls back to the string representation of the value.

Renders a string representation of the given value based on specific conditions. If the value can be represented in power or root notation, it uses that representation; otherwise, it falls back to the string representation of the value.

Value parameters

x

the value to be rendered into a string representation.

Attributes

Returns

a string representation of the value, using power or root notation when applicable.

Definition Classes
def render(v: String): String

Renders a string representation of the value based on the current base and the given input value. CONSIDER why do we have a second signature for render?

Renders a string representation of the value based on the current base and the given input value. CONSIDER why do we have a second signature for render?

Value parameters

v

the input value to be rendered, represented as a string

Attributes

Returns

a string combining the base and the input value in a specific exponential format

Inherited methods

def canAdd(f: Factor): Boolean

Determines whether the current factor can be augmented by the given factor. CONSIDER do we need this method now that we have add(x, y, this)?

Determines whether the current factor can be augmented by the given factor. CONSIDER do we need this method now that we have add(x, y, this)?

Value parameters

f

the factor to be checked for compatibility with addition.

Attributes

Returns

true if the factors can be added; false otherwise.

Inherited from:
Factor
def canRaise(f: Factor, exponent: Field): Boolean

Determines whether this factor can be raised by the given factor f. CONSIDER do we need this method now that we have raise(x, y, this)?

Determines whether this factor can be raised by the given factor f. CONSIDER do we need this method now that we have raise(x, y, this)?

Value parameters

f

the factor to be checked for compatibility with raising to a power.

Attributes

Returns

true if the factors can be powered; false otherwise.

Inherited from:
Factor
def clean(po: Option[ProtoNumber]): Option[ProtoNumber]

Cleans a given optional ProtoNumber by potentially simplifying its root quantities based on specific conditions and returning the modified result.

Cleans a given optional ProtoNumber by potentially simplifying its root quantities based on specific conditions and returning the modified result.

Value parameters

po

an optional ProtoNumber that may be simplified

Attributes

Returns

an optional ProtoNumber, simplified if applicable, or None if input is None

Inherited from:
Factor
def raise(x: Value, y: Value, f: Factor): Option[ProtoNumber]

Raises x to the power of y and compute an appropriate factor for the result. NOTE: for now, we only allow raising to a power of a PureNumber. TODO: enable powers of Radian factor.

Raises x to the power of y and compute an appropriate factor for the result. NOTE: for now, we only allow raising to a power of a PureNumber. TODO: enable powers of Radian factor.

Value parameters

f

the factor associated with y

x

the first value

y

the power

Attributes

Returns

an optional tuple containing the resultant value and its factor

Inherited from:
Factor

Inherited and Abstract methods

def isExact: Boolean

Determines whether the current scalar can be exactly converted to a PureNumber.

Determines whether the current scalar can be exactly converted to a PureNumber.

Attributes

Returns

true if the scalar represents an exact value; false otherwise.

Inherited from:
Factor

Abstract fields

val base: String

This is a String representation of the base of the logarithm used for this Factor.

This is a String representation of the base of the logarithm used for this Factor.

Attributes

Concrete fields

lazy val isAdditive: Boolean

Determines if the current factor operates additively.

Determines if the current factor operates additively.

Attributes

Returns

false.

Inherited and Abstract fields

val value: Double

A value which can be used to convert a value associated with this Factor to a different Factor. CONSIDER redefining this as a Number (which could be exact or fuzzy).

A value which can be used to convert a value associated with this Factor to a different Factor. CONSIDER redefining this as a Number (which could be exact or fuzzy).

Attributes

Inherited from:
Factor
Generated with