KtMongo: MongoDB request DSL/opensavvy.ktmongo.dsl.aggregation.operators/TrigonometryValueOperators/tanh

tanh

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

@JvmName(name = "tanhByField")

open fun <Context : Any> tanh(value: Field<Context, Double?>): Value<Context, Double?>(source)

@JvmName(name = "tanhByProperty")

open fun <Context : Any> tanh(value: KProperty1<Context, Double?>): Value<Context, Double?>(source)

inline fun tanh(value: Double?): Value<Any, Double?>(source)

The hyperbolic tangent of a value that is measured in radians.

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 tanh(of(Trigonometry::x))
    }

External resources

Official documentation