TrigonometryValueOperators

interface TrigonometryValueOperators : ValueOperators

Operators to perform trigonometric and geometric operators.

To learn more about aggregation operators, see AggregationOperators.

Inheritors

• AggregationOperators

Properties

context

@LowLevelApi
abstract override val context: BsonContext

The strategy used when converting from KProperty1 to Field.

field

open val <Root, Type> KProperty1<Root, Type>.field: Field<Root, Type>

Converts a Kotlin property into a Field.

Functions

acos

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

@JvmName(name = "acosByField")
open fun <Context : Any> acos(value: Field<Context, Double?>): Value<Context, Double?>

@JvmName(name = "acosByProperty")
open fun <Context : Any> acos(value: KProperty1<Context, Double?>): Value<Context, Double?>

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

@JvmName(name = "acosNonNull")
fun <Context : Any> acos(value: Value<Context, Double>): Value<Context, Double>

@JvmName(name = "acosNonNullByField")
fun <Context : Any> acos(value: Field<Context, Double>): Value<Context, Double>

@JvmName(name = "acosNonNullByProperty")
fun <Context : Any> acos(value: KProperty1<Context, Double>): Value<Context, Double>

@JvmName(name = "acosNonNull")
inline fun acos(value: Double): Value<Any, Double>

The inverse cosine (arc cosine) 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 Triangle(
    val name: String,
    val sideA: Double,
    val sideB: Double,
    val hypotenuse: Double,
    val angleA: Double,
)

collection.aggregate()
    .set {
        Triangle::angleA set acos(of(Triangle::sideB) / of(Triangle::hypotenuse))
    }

External resources

• Official documentation

acosh

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

@JvmName(name = "acoshByField")
open fun <Context : Any> acosh(value: Field<Context, Double?>): Value<Context, Double?>

@JvmName(name = "acoshByProperty")
open fun <Context : Any> acosh(value: KProperty1<Context, Double?>): Value<Context, Double?>

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

@JvmName(name = "acoshNonNull")
fun <Context : Any> acosh(value: Value<Context, Double>): Value<Context, Double>

@JvmName(name = "acoshNonNullByField")
fun <Context : Any> acosh(value: Field<Context, Double>): Value<Context, Double>

@JvmName(name = "acoshNonNullByProperty")
fun <Context : Any> acosh(value: KProperty1<Context, Double>): Value<Context, Double>

@JvmName(name = "acoshNonNull")
inline fun acosh(value: Double): Value<Any, Double>

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

The value must be in the range 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 acosh(of(Trigonometry::x))
    }

External resources

• Official documentation

asin

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

@JvmName(name = "asinByField")
open fun <Context : Any> asin(value: Field<Context, Double?>): Value<Context, Double?>

@JvmName(name = "asinByProperty")
open fun <Context : Any> asin(value: KProperty1<Context, Double?>): Value<Context, Double?>

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

@JvmName(name = "asinNonNull")
fun <Context : Any> asin(value: Value<Context, Double>): Value<Context, Double>

@JvmName(name = "asinNonNullByField")
fun <Context : Any> asin(value: Field<Context, Double>): Value<Context, Double>

@JvmName(name = "asinNonNullByProperty")
fun <Context : Any> asin(value: KProperty1<Context, Double>): Value<Context, Double>

@JvmName(name = "asinNonNull")
inline fun asin(value: Double): Value<Any, Double>

The inverse sine (arc sine) 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 Triangle(
    val name: String,
    val sideA: Double,
    val sideB: Double,
    val hypotenuse: Double,
    val angleA: Double,
)

collection.aggregate()
    .set {
        Triangle::angleA set asin(of(Triangle::sideA) / of(Triangle::hypotenuse))
    }

External resources

• Official documentation

asinh

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

@JvmName(name = "asinhByField")
open fun <Context : Any> asinh(value: Field<Context, Double?>): Value<Context, Double?>

@JvmName(name = "asinhByProperty")
open fun <Context : Any> asinh(value: KProperty1<Context, Double?>): Value<Context, Double?>

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

@JvmName(name = "asinhNonNull")
fun <Context : Any> asinh(value: Value<Context, Double>): Value<Context, Double>

@JvmName(name = "asinhNonNullByField")
fun <Context : Any> asinh(value: Field<Context, Double>): Value<Context, Double>

@JvmName(name = "asinhNonNullByProperty")
fun <Context : Any> asinh(value: KProperty1<Context, Double>): Value<Context, Double>

@JvmName(name = "asinhNonNull")
inline fun asinh(value: Double): Value<Any, Double>

The inverse hyperbolic sine (hyperbolic arc sine) of a value, 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 asinh(of(Trigonometry::x))
    }

External resources

• Official documentation

atan

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

@JvmName(name = "atanByField")
open fun <Context : Any> atan(value: Field<Context, Double?>): Value<Context, Double?>

@JvmName(name = "atanByProperty")
open fun <Context : Any> atan(value: KProperty1<Context, Double?>): Value<Context, Double?>

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

@JvmName(name = "atanNonNull")
fun <Context : Any> atan(value: Value<Context, Double>): Value<Context, Double>

@JvmName(name = "atanNonNullByField")
fun <Context : Any> atan(value: Field<Context, Double>): Value<Context, Double>

@JvmName(name = "atanNonNullByProperty")
fun <Context : Any> atan(value: KProperty1<Context, Double>): Value<Context, Double>

@JvmName(name = "atanNonNull")
inline fun atan(value: Double): Value<Any, Double>

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

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

Example

class Triangle(
    val name: String,
    val sideA: Double,
    val sideB: Double,
    val hypotenuse: Double,
    val angleA: Double,
)

collection.aggregate()
    .set {
        Triangle::angleA set atan(of(Triangle::sideB) / of(Triangle::sideA))
    }

External resources

• Official documentation

atanh

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

@JvmName(name = "atanhByField")
open fun <Context : Any> atanh(value: Field<Context, Double?>): Value<Context, Double?>

@JvmName(name = "atanhByProperty")
open fun <Context : Any> atanh(value: KProperty1<Context, Double?>): Value<Context, Double?>

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

@JvmName(name = "atanhNonNull")
fun <Context : Any> atanh(value: Value<Context, Double>): Value<Context, Double>

@JvmName(name = "atanhNonNullByField")
fun <Context : Any> atanh(value: Field<Context, Double>): Value<Context, Double>

@JvmName(name = "atanhNonNullByProperty")
fun <Context : Any> atanh(value: KProperty1<Context, Double>): Value<Context, Double>

@JvmName(name = "atanhNonNull")
inline fun atanh(value: Double): Value<Any, 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

• Official documentation

cos

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

@JvmName(name = "cosByField")
open fun <Context : Any> cos(value: Field<Context, Double?>): Value<Context, Double?>

@JvmName(name = "cosByProperty")
open fun <Context : Any> cos(value: KProperty1<Context, Double?>): Value<Context, Double?>

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

@JvmName(name = "cosNonNull")
fun <Context : Any> cos(value: Value<Context, Double>): Value<Context, Double>

@JvmName(name = "cosNonNullByField")
fun <Context : Any> cos(value: Field<Context, Double>): Value<Context, Double>

@JvmName(name = "cosNonNullByProperty")
fun <Context : Any> cos(value: KProperty1<Context, Double>): Value<Context, Double>

@JvmName(name = "cosNonNull")
inline fun cos(value: Double): Value<Any, Double>

The cosine of a value that is measured in radians.

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

Example

class Triangle(
    val name: String,
    val sideA: Double,
    val sideB: Double,
    val hypotenuse: Double,
    val angleA: Double,
)

collection.aggregate()
    .set {
        Triangle::sideB set (of(cos(Triangle::angleA) * of(Triangle::hypotenuse)))
    }

External resources

• Official documentation

cosh

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

@JvmName(name = "coshByField")
open fun <Context : Any> cosh(value: Field<Context, Double?>): Value<Context, Double?>

@JvmName(name = "coshByProperty")
open fun <Context : Any> cosh(value: KProperty1<Context, Double?>): Value<Context, Double?>

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

@JvmName(name = "coshNonNull")
fun <Context : Any> cosh(value: Value<Context, Double>): Value<Context, Double>

@JvmName(name = "coshNonNullByField")
fun <Context : Any> cosh(value: Field<Context, Double>): Value<Context, Double>

@JvmName(name = "coshNonNullByProperty")
fun <Context : Any> cosh(value: KProperty1<Context, Double>): Value<Context, Double>

@JvmName(name = "coshNonNull")
inline fun cosh(value: Double): Value<Any, Double>

The hyperbolic cosine 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 angle: Double,
    val cosh: Double,
)

collection.aggregate()
    .set {
        Trigonometry::cosh set cosh(of(Trigonometry::angle))
    }

External resources

• Official documentation

div

open operator fun <Context : Any, Root, Child> Value<Context, Root>.div(field: Field<Root, Child>): Value<Context, Child>

open operator fun <Context : Any, Root, Child> Value<Context, Root>.div(field: KProperty1<Root, Child>): Value<Context, Child>

Refers to field as a nested field of the current value.

Examples

class User(
    val name: String,
)

class Data(
    val users: List<User>,
    val userNames: List<Int>,
)

data.aggregate()
    .set {
        Data::userNames set Data::users.map { it / User::name }
    }

External resources

• Official documentation

get

@JvmName(name = "bsonField")
operator fun <Context : Any, Child> Value<Context, BsonDocument>.get(field: String): Value<Context, Child>

@JvmName(name = "bsonItem")
operator fun <Context : Any, Child> Value<Context, BsonArray>.get(index: Int): Value<Context, Child>

Refers to a child field of a field of type BsonDocument.

Example

class User(
    val _id: ObjectId,
    val name: String,
    val externalData: BsonDocument,
)

users.find {
    User::externalData.get<Profile?>("profile") ne null
}

open operator fun <Context : Any, Result> Value<Context, Collection<Result>>.get(index: Value<Context, Int>): Value<Context, Result>

open operator fun <Context : Any, Result> Value<Context, Collection<Result>>.get(index: Field<Context, Int>): Value<Context, Result>

open operator fun <Context : Any, Result> Value<Context, Collection<Result>>.get(index: KProperty1<Context, Int>): Value<Context, Result>

open operator fun <Context : Any, Result> Value<Context, Collection<Result>>.get(index: Int): Value<Context, Result>

Refers to a specific item in an array, by its index.

Examples

class Pet(
    val name: String,
    val age: Int,
)

class User(
    val pets: List<Pet>,
    val favorite: Pet,
)

users.aggregate()
    .set {
        User::favorite set User::pets[0] / Pet::name
    }

External resources

• Official documentation

of

open fun <Context : Any, Result> of(field: Field<Context, Result>): Value<Context, Result>

open fun <Context : Any, Result> of(field: KProperty1<Context, Result>): Value<Context, Result>

Refers to a field within an aggregation value.

Example

class Product(
    val acceptanceDate: Instant,
    val publishingDate: Instant,
)

val publishedBeforeAcceptance = products.find {
    expr {
        of(Product::publishingDate) lt of(Product::acceptanceDate)
    }
}

open fun <Result> of(value: Result, type: KType): Value<Any, Result>

inline fun <Result> of(value: Result): Value<Any, Result>

Refers to a Kotlin value within an aggregation value.

Example

class Product(
    val age: Int,
)

val publishedBeforeAcceptance = products.find {
    expr {
        of(Product::age) lt of(15)
    }
}

open fun of(value: BsonType): Value<Any, BsonType>

Refers to a BsonType within an aggregation value.

Example

class Product(
    val age: Int,
)

val publishedBeforeAcceptance = products.find {
    expr {
        of(Product::age).type eq of(BsonType.Int32)
    }
}

sin

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

@JvmName(name = "sinByField")
open fun <Context : Any> sin(value: Field<Context, Double?>): Value<Context, Double?>

@JvmName(name = "sinByProperty")
open fun <Context : Any> sin(value: KProperty1<Context, Double?>): Value<Context, Double?>

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

@JvmName(name = "sinNonNull")
fun <Context : Any> sin(value: Value<Context, Double>): Value<Context, Double>

@JvmName(name = "sinNonNullByField")
fun <Context : Any> sin(value: Field<Context, Double>): Value<Context, Double>

@JvmName(name = "sinNonNullByProperty")
fun <Context : Any> sin(value: KProperty1<Context, Double>): Value<Context, Double>

@JvmName(name = "sinNonNull")
inline fun sin(value: Double): Value<Any, Double>

The sine of a value that is measured in radians.

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

Example

class Triangle(
    val name: String,
    val sideA: Double,
    val sideB: Double,
    val hypotenuse: Double,
    val angleA: Double,
)

collection.aggregate()
    .set {
        Triangle::sideB set (sin(of(Trigonometry::angleA)) * of(Trigonometry::hypotenuse))
    }

External resources

• Official documentation

sinh

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

@JvmName(name = "sinhByField")
open fun <Context : Any> sinh(value: Field<Context, Double?>): Value<Context, Double?>

@JvmName(name = "sinhByProperty")
open fun <Context : Any> sinh(value: KProperty1<Context, Double?>): Value<Context, Double?>

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

@JvmName(name = "sinhNonNull")
fun <Context : Any> sinh(value: Value<Context, Double>): Value<Context, Double>

@JvmName(name = "sinhNonNullByField")
fun <Context : Any> sinh(value: Field<Context, Double>): Value<Context, Double>

@JvmName(name = "sinhNonNullByProperty")
fun <Context : Any> sinh(value: KProperty1<Context, Double>): Value<Context, Double>

@JvmName(name = "sinhNonNull")
inline fun sinh(value: Double): Value<Any, Double>

The hyperbolic sine 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 sinh(of(Trigonometry::x))
    }

External resources

• Official documentation

tan

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

@JvmName(name = "tanByField")
open fun <Context : Any> tan(value: Field<Context, Double?>): Value<Context, Double?>

@JvmName(name = "tanByProperty")
open fun <Context : Any> tan(value: KProperty1<Context, Double?>): Value<Context, Double?>

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

@JvmName(name = "tanNonNull")
fun <Context : Any> tan(value: Value<Context, Double>): Value<Context, Double>

@JvmName(name = "tanNonNullByField")
fun <Context : Any> tan(value: Field<Context, Double>): Value<Context, Double>

@JvmName(name = "tanNonNullByProperty")
fun <Context : Any> tan(value: KProperty1<Context, Double>): Value<Context, Double>

@JvmName(name = "tanNonNull")
inline fun tan(value: Double): Value<Any, Double>

The tangent of a value that is measured in radians.

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

Example

class Triangle(
    val name: String,
    val sideA: Double,
    val sideB: Double,
    val hypotenuse: Double,
    val angleA: Double,
)

collection.aggregate()
    .set {
        Triangle::sideB set (tan(of(Trigonometry::angleA) * of(Trigonometry::sideA)))
    }

External resources

• Official documentation

tanh

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

@JvmName(name = "tanhByField")
open fun <Context : Any> tanh(value: Field<Context, Double?>): Value<Context, Double?>

@JvmName(name = "tanhByProperty")
open fun <Context : Any> tanh(value: KProperty1<Context, Double?>): Value<Context, Double?>

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

@JvmName(name = "tanhNonNull")
fun <Context : Any> tanh(value: Value<Context, Double>): Value<Context, Double>

@JvmName(name = "tanhNonNullByField")
fun <Context : Any> tanh(value: Field<Context, Double>): Value<Context, Double>

@JvmName(name = "tanhNonNullByProperty")
fun <Context : Any> tanh(value: KProperty1<Context, Double>): Value<Context, Double>

@JvmName(name = "tanhNonNull")
inline fun tanh(value: Double): Value<Any, Double>

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

toDegrees

open fun <Context : Any> Value<Context, Double>.toDegrees(): Value<Context, Double>

@JvmName(name = "toDegreesFieldReceiver")
open fun <Context : Any> Field<Context, Double>.toDegrees(): Value<Context, Double>

@JvmName(name = "toDegreesPropertyReceiver")
open fun <Context : Any> KProperty1<Context, Double>.toDegrees(): Value<Context, Double>

@JvmName(name = "toDegreesResultReceiver")
inline fun Double.toDegrees(): Value<Any, Double>

Converts an angle in radians to an angle in degrees.

Example

class Trigonometry(
    val angleADeg: Double,
    val angleARad: Double,
)

collection.updateManyWithPipeline {
    set {
        Trigonometry::angleADeg set of(Trigonometry::angleARad).toDegrees()
    }
}

External resources

• Official documentation

See also

• toRadians: Opposite operation

toRadians

open fun <Context : Any> Value<Context, Double>.toRadians(): Value<Context, Double>

@JvmName(name = "toRadiansFieldReceiver")
open fun <Context : Any> Field<Context, Double>.toRadians(): Value<Context, Double>

@JvmName(name = "toRadiansPropertyReceiver")
open fun <Context : Any> KProperty1<Context, Double>.toRadians(): Value<Context, Double>

@JvmName(name = "toRadiansResultReceiver")
inline fun Double.toRadians(): Value<Any, Double>

Converts an angle in degrees to an angle in radians.

Example

class Trigonometry(
    val angleADeg: Double,
    val angleARad: Double,
)

collection.updateManyWithPipeline {
    set {
        Trigonometry::angleARad set of(Trigonometry::angleADeg).toRadians()
    }
}

External resources

• Official documentation

See also

• toDegrees: Opposite operation

unsafe

open infix fun <Root, Child> KProperty1<Root, *>.unsafe(child: String): Field<Root, Child>

Refers to a field child of the current field, with no compile-time safety.

open infix fun <Root, Child> KProperty1<Root, *>.unsafe(child: KProperty1<*, Child>): Field<Root, Child>

Refers to a field child of the current field, without checking that it is a field available on the current object.

open infix fun <Root, Child> KProperty1<Root, *>.unsafe(child: Field<*, Child>): Field<Root, Child>

Refers to a field child of the current field, without checking that it is a field available on the current object.

open infix fun <Root, Child> Field<Root, *>.unsafe(child: KProperty1<*, Child>): Field<Root, Child>

Refers to a field child of the current field, without checking that it is a field available on the current object.

open infix fun <Root, Child> Field<Root, *>.unsafe(child: Field<*, Child>): Field<Root, Child>

Refers to a field child of the current field, without checking that it is a field available on the current object.

open infix fun <Root, Type, Child> Field<Root, Type>.unsafe(child: String): Field<Root, Child>

Refers to a field child of the current field, with no compile-time safety.

unsafeCast

open fun <Context : Any, NewType> Any?.unsafeCast(): Value<Context, NewType>

Overwrites the represented type of this value.

This method can be useful to bypass type checks.

Example

If a field has changed type over time, the DTO will use the newer type. However, you may still want to write a query using the old type:

class User(
    val _id: ObjectId,
    val name: String,
    val age: Int,
)

users.filter { User::age hasType BsonType.Double }
    .updateManyWithPipeline {
        set {
            User::age set User::age.unsafeCast<Double>() // Reflect the old type
               .toInt() // Convert to the new type
        }
    }