commonMain.io.realm.kotlin.ext.DoubleExt.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of library-base-jvm Show documentation

Library code for Realm Kotlin. This artifact is not supposed to be consumed directly, but through 'io.realm.kotlin:gradle-plugin:1.11.1' instead.

There is a newer version: 3.0.0

Show newest version

/*
 * Copyright 2023 Realm Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.realm.kotlin.ext

import io.realm.kotlin.annotations.ExperimentalGeoSpatialApi
import io.realm.kotlin.types.geo.Distance

/**
 * Create a [Distance] object from kilometers. (mention equatorial distance)
 */
@ExperimentalGeoSpatialApi
public inline val Double.km: Distance
    get() = Distance.fromKilometers(this)

/**
 * Create a [Distance] object from miles. (mention equatorial distance)
 */
@ExperimentalGeoSpatialApi
public inline val Double.miles: Distance
    get() = Distance.fromMiles(this)

/**
 * Create a [Distance] object from radians.
 */
@ExperimentalGeoSpatialApi
public inline val Double.radians: Distance
    get() = Distance.fromRadians(this)

/**
 * Create a [Distance] object from degrees.
 */
@ExperimentalGeoSpatialApi
public inline val Double.degrees: Distance
    get() = Distance.fromDegrees(this)