Skip to content

MongoDB request DSL • opensavvy.ktmongo.dsl.aggregation.operators • TrigonometryValueOperators • atanh

atanh

open fun <Context : Any> atanh(value: Value<Context, Double?>): Value<Context, Double?>

The inverse hyperbolic tangent (hyperbolic arc tangent) of a value, in radians.

The value must be in the range -1..1.

If the value is null or NaN, it is returned unchanged.

Example

class Trigonometry(
    val name: String,
    val x: Double,
    val y: Double,
)

collection.aggregate()
    .set {
        Trigonometry::y set atanh(of(Trigonometry::x))
    }

External resources