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

TrigonometryValueOperators

interface TrigonometryValueOperators : ValueOperators(source)

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

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

@JvmName(name = "acosByProperty")

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

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?>

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

acosh

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

@JvmName(name = "acoshByProperty")

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

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?>

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

asin

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

@JvmName(name = "asinByProperty")

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

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?>

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

asinh

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

@JvmName(name = "asinhByProperty")

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

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?>

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

atan

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

@JvmName(name = "atanByProperty")

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

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?>

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

atanh

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

@JvmName(name = "atanhByProperty")

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

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?>

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

cos

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

@JvmName(name = "cosByProperty")

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

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?>

The cosine of a value that is measured in radians.

cosh

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

@JvmName(name = "coshByProperty")

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

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?>

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

div

@JvmName(name = "divResultReceiver")

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

@JvmName(name = "divResultReceiver")

inline operator fun <Context : Any, Root, Child> 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>

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

@JvmName(name = "divFieldReceiver")

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

@JvmName(name = "divFieldReceiver")

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

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

open operator fun <Root, Parent, Child> KProperty1<Root, Parent>.div(child: KProperty1<Parent & Any, Child>): Field<Root, Child>

open operator fun <Root, Type, Child> Field<Root, Type>.div(child: KProperty1<in Type & Any, Child>): Field<Root, Child>

open operator fun <Root, Type, Child> Field<Root, Type>.div(child: Field<Type, Child>): Field<Root, Child>

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

get

open operator fun <Root, Type> KProperty1<Root, Collection<Type>>.get(index: Int): Field<Root, Type>

open operator fun <Root, Type> Field<Root, Collection<Type>>.get(index: Int): Field<Root, Type>

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

open operator fun <Root, Type> KProperty1<Root, Map<String, Type>>.get(index: String): Field<Root, Type>

open operator fun <Root, Type> Field<Root, Map<String, Type>>.get(key: String): Field<Root, Type>

Refers to a specific item in a map, by its name.

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

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

Refers to a Kotlin value within an aggregation value.

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

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

Refers to a field within an aggregation value.

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

Refers to a BsonType within an aggregation value.

sin

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

@JvmName(name = "sinByProperty")

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

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?>

The sine of a value that is measured in radians.

sinh

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

@JvmName(name = "sinhByProperty")

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

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?>

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

tan

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

@JvmName(name = "tanByProperty")

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

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?>

The tangent of a value that is measured in radians.

tanh

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

@JvmName(name = "tanhByProperty")

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

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?>

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

toDegrees

@JvmName(name = "toDegreesResultReceiver")

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

@JvmName(name = "toDegreesPropertyReceiver")

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

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>

Converts an angle in radians to an angle in degrees.

toRadians

@JvmName(name = "toRadiansResultReceiver")

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

@JvmName(name = "toRadiansPropertyReceiver")

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

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>

Converts an angle in degrees to an angle in radians.

unsafe

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

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.

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

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

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

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.