diff --git a/README.md b/README.md index 2a8c1247..02be84cb 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ Examples -
+
Code & Docs
diff --git a/generate/version.txt b/generate/version.txt index 8dbb0f26..a39c0b78 100644 --- a/generate/version.txt +++ b/generate/version.txt @@ -1 +1 @@ -2.1.10 +2.1.11 diff --git a/source/csharp/astronomy.csproj b/source/csharp/astronomy.csproj index 156f4f60..12576986 100644 --- a/source/csharp/astronomy.csproj +++ b/source/csharp/astronomy.csproj @@ -4,7 +4,7 @@ true true CosineKitty.AstronomyEngine - 2.1.10 + 2.1.11 https://github.com/cosinekitty/astronomy Don Cross Astronomy Engine diff --git a/source/js/package.json b/source/js/package.json index b70cb790..c926fee3 100644 --- a/source/js/package.json +++ b/source/js/package.json @@ -1,6 +1,6 @@ { "name": "astronomy-engine", - "version": "2.1.10", + "version": "2.1.11", "description": "Astronomy calculation for Sun, Moon, and planets.", "author": "Donald Cross", "license": "MIT", diff --git a/source/kotlin/README.md b/source/kotlin/README.md index 2451900d..42e931e2 100644 --- a/source/kotlin/README.md +++ b/source/kotlin/README.md @@ -25,7 +25,7 @@ allprojects { Now add the dependency: ```kotlin dependencies { - implementation("io.github.cosinekitty:astronomy:2.1.10") + implementation("io.github.cosinekitty:astronomy:2.1.11") } ``` @@ -74,60 +74,60 @@ movement through the Solar System. | Name | Summary | |---|---| -| [Aberration](doc/-aberration/index.md)
enum [Aberration](doc/-aberration/index.md) : Enum<[Aberration](doc/-aberration/index.md)>
Aberration calculation options. | -| [ApsisInfo](doc/-apsis-info/index.md)
class [ApsisInfo](doc/-apsis-info/index.md)(time: [Time](doc/-time/index.md), kind: [ApsisKind](doc/-apsis-kind/index.md), distanceAu: Double)
An apsis event: pericenter (closest approach) or apocenter (farthest distance). | -| [ApsisKind](doc/-apsis-kind/index.md)
enum [ApsisKind](doc/-apsis-kind/index.md) : Enum<[ApsisKind](doc/-apsis-kind/index.md)>
The type of apsis: pericenter (closest approach) or apocenter (farthest distance). | -| [AxisInfo](doc/-axis-info/index.md)
class [AxisInfo](doc/-axis-info/index.md)(ra: Double, dec: Double, spin: Double, north: [Vector](doc/-vector/index.md))
Information about a body's rotation axis at a given time. | -| [Body](doc/-body/index.md)
enum [Body](doc/-body/index.md) : Enum<[Body](doc/-body/index.md)>
The enumeration of celestial bodies supported by Astronomy Engine. | -| [ConstellationInfo](doc/-constellation-info/index.md)
class [ConstellationInfo](doc/-constellation-info/index.md)(symbol: String, name: String, ra1875: Double, dec1875: Double)
Reports the constellation that a given celestial point lies within. | -| [DateTime](doc/-date-time/index.md)
class [DateTime](doc/-date-time/index.md)(year: Int, month: Int, day: Int, hour: Int, minute: Int, second: Double)
A universal time resolved into UTC calendar date and time fields. | -| [Direction](doc/-direction/index.md)
enum [Direction](doc/-direction/index.md) : Enum<[Direction](doc/-direction/index.md)>
Selects whether to search for a rising event or a setting event for a celestial body. | -| [EarthNotAllowedException](doc/-earth-not-allowed-exception/index.md)
class [EarthNotAllowedException](doc/-earth-not-allowed-exception/index.md) : Exception
The Earth is not allowed as the body parameter. | -| [EclipseEvent](doc/-eclipse-event/index.md)
class [EclipseEvent](doc/-eclipse-event/index.md)(time: [Time](doc/-time/index.md), altitude: Double)
Holds a time and the observed altitude of the Sun at that time. | -| [EclipseKind](doc/-eclipse-kind/index.md)
enum [EclipseKind](doc/-eclipse-kind/index.md) : Enum<[EclipseKind](doc/-eclipse-kind/index.md)>
The different kinds of lunar/solar eclipses. | -| [Ecliptic](doc/-ecliptic/index.md)
data class [Ecliptic](doc/-ecliptic/index.md)(vec: [Vector](doc/-vector/index.md), elat: Double, elon: Double)
Ecliptic angular and Cartesian coordinates. | -| [ElongationInfo](doc/-elongation-info/index.md)
class [ElongationInfo](doc/-elongation-info/index.md)(time: [Time](doc/-time/index.md), visibility: [Visibility](doc/-visibility/index.md), elongation: Double, eclipticSeparation: Double)
Contains information about the visibility of a celestial body at a given date and time. | -| [EquatorEpoch](doc/-equator-epoch/index.md)
enum [EquatorEpoch](doc/-equator-epoch/index.md) : Enum<[EquatorEpoch](doc/-equator-epoch/index.md)>
Selects the date for which the Earth's equator is to be used for representing equatorial coordinates. | -| [Equatorial](doc/-equatorial/index.md)
class [Equatorial](doc/-equatorial/index.md)(ra: Double, dec: Double, dist: Double, vec: [Vector](doc/-vector/index.md))
Equatorial angular and cartesian coordinates. | -| [GlobalSolarEclipseInfo](doc/-global-solar-eclipse-info/index.md)
class [GlobalSolarEclipseInfo](doc/-global-solar-eclipse-info/index.md)(kind: [EclipseKind](doc/-eclipse-kind/index.md), obscuration: Double, peak: [Time](doc/-time/index.md), distance: Double, latitude: Double, longitude: Double)
Reports the time and geographic location of the peak of a solar eclipse. | +| [Aberration](doc/-aberration/index.md)
enum [Aberration](doc/-aberration/index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[Aberration](doc/-aberration/index.md)>
Aberration calculation options. | +| [ApsisInfo](doc/-apsis-info/index.md)
class [ApsisInfo](doc/-apsis-info/index.md)(time: [Time](doc/-time/index.md), kind: [ApsisKind](doc/-apsis-kind/index.md), distanceAu: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
An apsis event: pericenter (closest approach) or apocenter (farthest distance). | +| [ApsisKind](doc/-apsis-kind/index.md)
enum [ApsisKind](doc/-apsis-kind/index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[ApsisKind](doc/-apsis-kind/index.md)>
The type of apsis: pericenter (closest approach) or apocenter (farthest distance). | +| [AxisInfo](doc/-axis-info/index.md)
class [AxisInfo](doc/-axis-info/index.md)(ra: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), dec: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), spin: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), north: [Vector](doc/-vector/index.md))
Information about a body's rotation axis at a given time. | +| [Body](doc/-body/index.md)
enum [Body](doc/-body/index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[Body](doc/-body/index.md)>
The enumeration of celestial bodies supported by Astronomy Engine. | +| [ConstellationInfo](doc/-constellation-info/index.md)
class [ConstellationInfo](doc/-constellation-info/index.md)(symbol: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), ra1875: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), dec1875: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
Reports the constellation that a given celestial point lies within. | +| [DateTime](doc/-date-time/index.md)
class [DateTime](doc/-date-time/index.md)(year: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), month: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), day: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), hour: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), minute: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), second: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
A universal time resolved into UTC calendar date and time fields. | +| [Direction](doc/-direction/index.md)
enum [Direction](doc/-direction/index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[Direction](doc/-direction/index.md)>
Selects whether to search for a rising event or a setting event for a celestial body. | +| [EarthNotAllowedException](doc/-earth-not-allowed-exception/index.md)
class [EarthNotAllowedException](doc/-earth-not-allowed-exception/index.md) : [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html)
The Earth is not allowed as the body parameter. | +| [EclipseEvent](doc/-eclipse-event/index.md)
class [EclipseEvent](doc/-eclipse-event/index.md)(time: [Time](doc/-time/index.md), altitude: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
Holds a time and the observed altitude of the Sun at that time. | +| [EclipseKind](doc/-eclipse-kind/index.md)
enum [EclipseKind](doc/-eclipse-kind/index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[EclipseKind](doc/-eclipse-kind/index.md)>
The different kinds of lunar/solar eclipses. | +| [Ecliptic](doc/-ecliptic/index.md)
data class [Ecliptic](doc/-ecliptic/index.md)(vec: [Vector](doc/-vector/index.md), elat: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), elon: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
Ecliptic angular and Cartesian coordinates. | +| [ElongationInfo](doc/-elongation-info/index.md)
class [ElongationInfo](doc/-elongation-info/index.md)(time: [Time](doc/-time/index.md), visibility: [Visibility](doc/-visibility/index.md), elongation: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), eclipticSeparation: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
Contains information about the visibility of a celestial body at a given date and time. | +| [EquatorEpoch](doc/-equator-epoch/index.md)
enum [EquatorEpoch](doc/-equator-epoch/index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[EquatorEpoch](doc/-equator-epoch/index.md)>
Selects the date for which the Earth's equator is to be used for representing equatorial coordinates. | +| [Equatorial](doc/-equatorial/index.md)
class [Equatorial](doc/-equatorial/index.md)(ra: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), dec: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), dist: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), vec: [Vector](doc/-vector/index.md))
Equatorial angular and cartesian coordinates. | +| [GlobalSolarEclipseInfo](doc/-global-solar-eclipse-info/index.md)
class [GlobalSolarEclipseInfo](doc/-global-solar-eclipse-info/index.md)(kind: [EclipseKind](doc/-eclipse-kind/index.md), obscuration: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), peak: [Time](doc/-time/index.md), distance: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), latitude: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), longitude: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
Reports the time and geographic location of the peak of a solar eclipse. | | [GravitySimulator](doc/-gravity-simulator/index.md)
class [GravitySimulator](doc/-gravity-simulator/index.md)
A simulation of zero or more small bodies moving through the Solar System. | | [HourAngleInfo](doc/-hour-angle-info/index.md)
class [HourAngleInfo](doc/-hour-angle-info/index.md)(time: [Time](doc/-time/index.md), hor: [Topocentric](doc/-topocentric/index.md))
Information about a celestial body crossing a specific hour angle. | -| [IlluminationInfo](doc/-illumination-info/index.md)
class [IlluminationInfo](doc/-illumination-info/index.md)(time: [Time](doc/-time/index.md), mag: Double, phaseAngle: Double, phaseFraction: Double, helioDist: Double, ringTilt: Double)
Information about the brightness and illuminated shape of a celestial body. | -| [InternalError](doc/-internal-error/index.md)
class [InternalError](doc/-internal-error/index.md)(message: String) : Exception
An unexpected internal error occurred in Astronomy Engine | -| [InvalidBodyException](doc/-invalid-body-exception/index.md)
class [InvalidBodyException](doc/-invalid-body-exception/index.md)(body: [Body](doc/-body/index.md)) : Exception
An invalid body was specified for the given function. | +| [IlluminationInfo](doc/-illumination-info/index.md)
class [IlluminationInfo](doc/-illumination-info/index.md)(time: [Time](doc/-time/index.md), mag: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), phaseAngle: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), phaseFraction: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), helioDist: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), ringTilt: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
Information about the brightness and illuminated shape of a celestial body. | +| [InternalError](doc/-internal-error/index.md)
class [InternalError](doc/-internal-error/index.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) : [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html)
An unexpected internal error occurred in Astronomy Engine | +| [InvalidBodyException](doc/-invalid-body-exception/index.md)
class [InvalidBodyException](doc/-invalid-body-exception/index.md)(body: [Body](doc/-body/index.md)) : [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html)
An invalid body was specified for the given function. | | [JupiterMoonsInfo](doc/-jupiter-moons-info/index.md)
class [JupiterMoonsInfo](doc/-jupiter-moons-info/index.md)(io: [StateVector](doc/-state-vector/index.md), europa: [StateVector](doc/-state-vector/index.md), ganymede: [StateVector](doc/-state-vector/index.md), callisto: [StateVector](doc/-state-vector/index.md))
Holds the positions and velocities of Jupiter's major 4 moons. | -| [LibrationInfo](doc/-libration-info/index.md)
data class [LibrationInfo](doc/-libration-info/index.md)(elat: Double, elon: Double, mlat: Double, mlon: Double, distanceKm: Double, diamDeg: Double)
Lunar libration angles, returned by [libration](doc/libration.md). | -| [LocalSolarEclipseInfo](doc/-local-solar-eclipse-info/index.md)
class [LocalSolarEclipseInfo](doc/-local-solar-eclipse-info/index.md)(kind: [EclipseKind](doc/-eclipse-kind/index.md), obscuration: Double, partialBegin: [EclipseEvent](doc/-eclipse-event/index.md), totalBegin: [EclipseEvent](doc/-eclipse-event/index.md)?, peak: [EclipseEvent](doc/-eclipse-event/index.md), totalEnd: [EclipseEvent](doc/-eclipse-event/index.md)?, partialEnd: [EclipseEvent](doc/-eclipse-event/index.md))
Information about a solar eclipse as seen by an observer at a given time and geographic location. | -| [LunarEclipseInfo](doc/-lunar-eclipse-info/index.md)
class [LunarEclipseInfo](doc/-lunar-eclipse-info/index.md)(kind: [EclipseKind](doc/-eclipse-kind/index.md), obscuration: Double, peak: [Time](doc/-time/index.md), sdPenum: Double, sdPartial: Double, sdTotal: Double)
Information about a lunar eclipse. | -| [MoonQuarterInfo](doc/-moon-quarter-info/index.md)
class [MoonQuarterInfo](doc/-moon-quarter-info/index.md)(quarter: Int, time: [Time](doc/-time/index.md))
A lunar quarter event (new moon, first quarter, full moon, or third quarter) along with its date and time. | +| [LibrationInfo](doc/-libration-info/index.md)
data class [LibrationInfo](doc/-libration-info/index.md)(elat: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), elon: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), mlat: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), mlon: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), distanceKm: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), diamDeg: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
Lunar libration angles, returned by [libration](doc/libration.md). | +| [LocalSolarEclipseInfo](doc/-local-solar-eclipse-info/index.md)
class [LocalSolarEclipseInfo](doc/-local-solar-eclipse-info/index.md)(kind: [EclipseKind](doc/-eclipse-kind/index.md), obscuration: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), partialBegin: [EclipseEvent](doc/-eclipse-event/index.md), totalBegin: [EclipseEvent](doc/-eclipse-event/index.md)?, peak: [EclipseEvent](doc/-eclipse-event/index.md), totalEnd: [EclipseEvent](doc/-eclipse-event/index.md)?, partialEnd: [EclipseEvent](doc/-eclipse-event/index.md))
Information about a solar eclipse as seen by an observer at a given time and geographic location. | +| [LunarEclipseInfo](doc/-lunar-eclipse-info/index.md)
class [LunarEclipseInfo](doc/-lunar-eclipse-info/index.md)(kind: [EclipseKind](doc/-eclipse-kind/index.md), obscuration: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), peak: [Time](doc/-time/index.md), sdPenum: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), sdPartial: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), sdTotal: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
Information about a lunar eclipse. | +| [MoonQuarterInfo](doc/-moon-quarter-info/index.md)
class [MoonQuarterInfo](doc/-moon-quarter-info/index.md)(quarter: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), time: [Time](doc/-time/index.md))
A lunar quarter event (new moon, first quarter, full moon, or third quarter) along with its date and time. | | [NodeEventInfo](doc/-node-event-info/index.md)
class [NodeEventInfo](doc/-node-event-info/index.md)(time: [Time](doc/-time/index.md), kind: [NodeEventKind](doc/-node-event-kind/index.md))
Information about an ascending or descending node of a body. | -| [NodeEventKind](doc/-node-event-kind/index.md)
enum [NodeEventKind](doc/-node-event-kind/index.md) : Enum<[NodeEventKind](doc/-node-event-kind/index.md)>
Indicates whether a crossing through the ecliptic plane is ascending or descending. | -| [Observer](doc/-observer/index.md)
data class [Observer](doc/-observer/index.md)(latitude: Double, longitude: Double, height: Double)
The location of an observer on (or near) the surface of the Earth. | +| [NodeEventKind](doc/-node-event-kind/index.md)
enum [NodeEventKind](doc/-node-event-kind/index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[NodeEventKind](doc/-node-event-kind/index.md)>
Indicates whether a crossing through the ecliptic plane is ascending or descending. | +| [Observer](doc/-observer/index.md)
data class [Observer](doc/-observer/index.md)(latitude: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), longitude: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), height: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
The location of an observer on (or near) the surface of the Earth. | | [PositionFunction](doc/-position-function/index.md)
fun interface [PositionFunction](doc/-position-function/index.md)
A function for which to solve a light-travel time problem. | -| [Refraction](doc/-refraction/index.md)
enum [Refraction](doc/-refraction/index.md) : Enum<[Refraction](doc/-refraction/index.md)>
Selects whether to correct for atmospheric refraction, and if so, how. | -| [RotationMatrix](doc/-rotation-matrix/index.md)
class [RotationMatrix](doc/-rotation-matrix/index.md)(rot: Array<DoubleArray>)
A rotation matrix that can be used to transform one coordinate system to another. | +| [Refraction](doc/-refraction/index.md)
enum [Refraction](doc/-refraction/index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[Refraction](doc/-refraction/index.md)>
Selects whether to correct for atmospheric refraction, and if so, how. | +| [RotationMatrix](doc/-rotation-matrix/index.md)
class [RotationMatrix](doc/-rotation-matrix/index.md)(rot: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[DoubleArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double-array/index.html)>)
A rotation matrix that can be used to transform one coordinate system to another. | | [SearchContext](doc/-search-context/index.md)
fun interface [SearchContext](doc/-search-context/index.md)
Represents a function whose ascending root is to be found. | | [SeasonsInfo](doc/-seasons-info/index.md)
class [SeasonsInfo](doc/-seasons-info/index.md)(marchEquinox: [Time](doc/-time/index.md), juneSolstice: [Time](doc/-time/index.md), septemberEquinox: [Time](doc/-time/index.md), decemberSolstice: [Time](doc/-time/index.md))
The dates and times of changes of season for a given calendar year. | -| [Spherical](doc/-spherical/index.md)
data class [Spherical](doc/-spherical/index.md)(lat: Double, lon: Double, dist: Double)
Spherical coordinates: latitude, longitude, distance. | -| [StateVector](doc/-state-vector/index.md)
data class [StateVector](doc/-state-vector/index.md)(x: Double, y: Double, z: Double, vx: Double, vy: Double, vz: Double, t: [Time](doc/-time/index.md))
Represents a combined position vector and velocity vector at a given moment in time. | -| [Time](doc/-time/index.md)
class [Time](doc/-time/index.md) : Comparable<[Time](doc/-time/index.md)>
A date and time used for astronomical calculations. | -| [Topocentric](doc/-topocentric/index.md)
data class [Topocentric](doc/-topocentric/index.md)(azimuth: Double, altitude: Double, ra: Double, dec: Double)
Coordinates of a celestial body as seen by a topocentric observer. | -| [TransitInfo](doc/-transit-info/index.md)
class [TransitInfo](doc/-transit-info/index.md)(start: [Time](doc/-time/index.md), peak: [Time](doc/-time/index.md), finish: [Time](doc/-time/index.md), separation: Double)
Information about a transit of Mercury or Venus, as seen from the Earth. | -| [Vector](doc/-vector/index.md)
data class [Vector](doc/-vector/index.md)(x: Double, y: Double, z: Double, t: [Time](doc/-time/index.md))
A 3D Cartesian vector whose components are expressed in Astronomical Units (AU). | -| [Visibility](doc/-visibility/index.md)
enum [Visibility](doc/-visibility/index.md) : Enum<[Visibility](doc/-visibility/index.md)>
Indicates whether a body (especially Mercury or Venus) is best seen in the morning or evening. | +| [Spherical](doc/-spherical/index.md)
data class [Spherical](doc/-spherical/index.md)(lat: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), lon: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), dist: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
Spherical coordinates: latitude, longitude, distance. | +| [StateVector](doc/-state-vector/index.md)
data class [StateVector](doc/-state-vector/index.md)(x: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), y: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), z: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), vx: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), vy: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), vz: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), t: [Time](doc/-time/index.md))
Represents a combined position vector and velocity vector at a given moment in time. | +| [Time](doc/-time/index.md)
class [Time](doc/-time/index.md) : [Comparable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-comparable/index.html)<[Time](doc/-time/index.md)>
A date and time used for astronomical calculations. | +| [Topocentric](doc/-topocentric/index.md)
data class [Topocentric](doc/-topocentric/index.md)(azimuth: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), altitude: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), ra: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), dec: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
Coordinates of a celestial body as seen by a topocentric observer. | +| [TransitInfo](doc/-transit-info/index.md)
class [TransitInfo](doc/-transit-info/index.md)(start: [Time](doc/-time/index.md), peak: [Time](doc/-time/index.md), finish: [Time](doc/-time/index.md), separation: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
Information about a transit of Mercury or Venus, as seen from the Earth. | +| [Vector](doc/-vector/index.md)
data class [Vector](doc/-vector/index.md)(x: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), y: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), z: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), t: [Time](doc/-time/index.md))
A 3D Cartesian vector whose components are expressed in Astronomical Units (AU). | +| [Visibility](doc/-visibility/index.md)
enum [Visibility](doc/-visibility/index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[Visibility](doc/-visibility/index.md)>
Indicates whether a body (especially Mercury or Venus) is best seen in the morning or evening. | ## Functions | Name | Summary | |---|---| -| [angleFromSun](doc/angle-from-sun.md)
fun [angleFromSun](doc/angle-from-sun.md)(body: [Body](doc/-body/index.md), time: [Time](doc/-time/index.md)): Double
Returns the angle between the given body and the Sun, as seen from the Earth. | +| [angleFromSun](doc/angle-from-sun.md)
fun [angleFromSun](doc/angle-from-sun.md)(body: [Body](doc/-body/index.md), time: [Time](doc/-time/index.md)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Returns the angle between the given body and the Sun, as seen from the Earth. | | [backdatePosition](doc/backdate-position.md)
fun [backdatePosition](doc/backdate-position.md)(time: [Time](doc/-time/index.md), observerBody: [Body](doc/-body/index.md), targetBody: [Body](doc/-body/index.md), aberration: [Aberration](doc/-aberration/index.md)): [Vector](doc/-vector/index.md)
Solve for light travel time correction of apparent position. | | [baryState](doc/bary-state.md)
fun [baryState](doc/bary-state.md)(body: [Body](doc/-body/index.md), time: [Time](doc/-time/index.md)): [StateVector](doc/-state-vector/index.md)
Calculates barycentric position and velocity vectors for the given body. | -| [constellation](doc/constellation.md)
fun [constellation](doc/constellation.md)(ra: Double, dec: Double): [ConstellationInfo](doc/-constellation-info/index.md)
Determines the constellation that contains the given point in the sky. | +| [constellation](doc/constellation.md)
fun [constellation](doc/constellation.md)(ra: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), dec: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [ConstellationInfo](doc/-constellation-info/index.md)
Determines the constellation that contains the given point in the sky. | | [correctLightTravel](doc/correct-light-travel.md)
fun [correctLightTravel](doc/correct-light-travel.md)(func: [PositionFunction](doc/-position-function/index.md), time: [Time](doc/-time/index.md)): [Vector](doc/-vector/index.md)
Solve for light travel time of a vector function. | -| [degreesToRadians](doc/degrees-to-radians.md)
fun Double.[degreesToRadians](doc/degrees-to-radians.md)(): Double
Convert an angle expressed in degrees to an angle expressed in radians. | +| [degreesToRadians](doc/degrees-to-radians.md)
fun [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html).[degreesToRadians](doc/degrees-to-radians.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Convert an angle expressed in degrees to an angle expressed in radians. | | [eclipticGeoMoon](doc/ecliptic-geo-moon.md)
fun [eclipticGeoMoon](doc/ecliptic-geo-moon.md)(time: [Time](doc/-time/index.md)): [Spherical](doc/-spherical/index.md)
Calculates spherical ecliptic geocentric position of the Moon. | -| [eclipticLongitude](doc/ecliptic-longitude.md)
fun [eclipticLongitude](doc/ecliptic-longitude.md)(body: [Body](doc/-body/index.md), time: [Time](doc/-time/index.md)): Double
Calculates heliocentric ecliptic longitude of a body based on the J2000 equinox. | +| [eclipticLongitude](doc/ecliptic-longitude.md)
fun [eclipticLongitude](doc/ecliptic-longitude.md)(body: [Body](doc/-body/index.md), time: [Time](doc/-time/index.md)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Calculates heliocentric ecliptic longitude of a body based on the J2000 equinox. | | [elongation](doc/elongation.md)
fun [elongation](doc/elongation.md)(body: [Body](doc/-body/index.md), time: [Time](doc/-time/index.md)): [ElongationInfo](doc/-elongation-info/index.md)
Determines visibility of a celestial body relative to the Sun, as seen from the Earth. | | [equator](doc/equator.md)
fun [equator](doc/equator.md)(body: [Body](doc/-body/index.md), time: [Time](doc/-time/index.md), observer: [Observer](doc/-observer/index.md), equdate: [EquatorEpoch](doc/-equator-epoch/index.md), aberration: [Aberration](doc/-aberration/index.md)): [Equatorial](doc/-equatorial/index.md)
Calculates equatorial coordinates of a celestial body as seen by an observer on the Earth's surface. | | [equatorialToEcliptic](doc/equatorial-to-ecliptic.md)
fun [equatorialToEcliptic](doc/equatorial-to-ecliptic.md)(equ: [Vector](doc/-vector/index.md)): [Ecliptic](doc/-ecliptic/index.md)
Converts J2000 equatorial Cartesian coordinates to J2000 ecliptic coordinates. | @@ -135,24 +135,24 @@ movement through the Solar System. | [geoMoon](doc/geo-moon.md)
fun [geoMoon](doc/geo-moon.md)(time: [Time](doc/-time/index.md)): [Vector](doc/-vector/index.md)
Calculates equatorial geocentric position of the Moon at a given time. | | [geoMoonState](doc/geo-moon-state.md)
fun [geoMoonState](doc/geo-moon-state.md)(time: [Time](doc/-time/index.md)): [StateVector](doc/-state-vector/index.md)
Calculates equatorial geocentric position and velocity of the Moon at a given time. | | [geoVector](doc/geo-vector.md)
fun [geoVector](doc/geo-vector.md)(body: [Body](doc/-body/index.md), time: [Time](doc/-time/index.md), aberration: [Aberration](doc/-aberration/index.md)): [Vector](doc/-vector/index.md)
Calculates geocentric Cartesian coordinates of a body in the J2000 equatorial system. | -| [globalSolarEclipsesAfter](doc/global-solar-eclipses-after.md)
fun [globalSolarEclipsesAfter](doc/global-solar-eclipses-after.md)(startTime: [Time](doc/-time/index.md)): Sequence<[GlobalSolarEclipseInfo](doc/-global-solar-eclipse-info/index.md)>
Enumerates a series of consecutive global solar eclipses that occur after a given time. | -| [helioDistance](doc/helio-distance.md)
fun [helioDistance](doc/helio-distance.md)(body: [Body](doc/-body/index.md), time: [Time](doc/-time/index.md)): Double
Calculates the distance between a body and the Sun at a given time. | +| [globalSolarEclipsesAfter](doc/global-solar-eclipses-after.md)
fun [globalSolarEclipsesAfter](doc/global-solar-eclipses-after.md)(startTime: [Time](doc/-time/index.md)): [Sequence](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.sequences/-sequence/index.html)<[GlobalSolarEclipseInfo](doc/-global-solar-eclipse-info/index.md)>
Enumerates a series of consecutive global solar eclipses that occur after a given time. | +| [helioDistance](doc/helio-distance.md)
fun [helioDistance](doc/helio-distance.md)(body: [Body](doc/-body/index.md), time: [Time](doc/-time/index.md)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Calculates the distance between a body and the Sun at a given time. | | [helioState](doc/helio-state.md)
fun [helioState](doc/helio-state.md)(body: [Body](doc/-body/index.md), time: [Time](doc/-time/index.md)): [StateVector](doc/-state-vector/index.md)
Calculates heliocentric position and velocity vectors for the given body. | | [helioVector](doc/helio-vector.md)
fun [helioVector](doc/helio-vector.md)(body: [Body](doc/-body/index.md), time: [Time](doc/-time/index.md)): [Vector](doc/-vector/index.md)
Calculates heliocentric Cartesian coordinates of a body in the J2000 equatorial system. | -| [horizon](doc/horizon.md)
fun [horizon](doc/horizon.md)(time: [Time](doc/-time/index.md), observer: [Observer](doc/-observer/index.md), ra: Double, dec: Double, refraction: [Refraction](doc/-refraction/index.md)): [Topocentric](doc/-topocentric/index.md)
Calculates the apparent location of a body relative to the local horizon of an observer on the Earth. | +| [horizon](doc/horizon.md)
fun [horizon](doc/horizon.md)(time: [Time](doc/-time/index.md), observer: [Observer](doc/-observer/index.md), ra: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), dec: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), refraction: [Refraction](doc/-refraction/index.md)): [Topocentric](doc/-topocentric/index.md)
Calculates the apparent location of a body relative to the local horizon of an observer on the Earth. | | [illumination](doc/illumination.md)
fun [illumination](doc/illumination.md)(body: [Body](doc/-body/index.md), time: [Time](doc/-time/index.md)): [IlluminationInfo](doc/-illumination-info/index.md)
Finds visual magnitude, phase angle, and other illumination information about a celestial body. | -| [inverseRefractionAngle](doc/inverse-refraction-angle.md)
fun [inverseRefractionAngle](doc/inverse-refraction-angle.md)(refraction: [Refraction](doc/-refraction/index.md), bentAltitude: Double): Double
Calculates the inverse of an atmospheric refraction angle. | +| [inverseRefractionAngle](doc/inverse-refraction-angle.md)
fun [inverseRefractionAngle](doc/inverse-refraction-angle.md)(refraction: [Refraction](doc/-refraction/index.md), bentAltitude: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Calculates the inverse of an atmospheric refraction angle. | | [jupiterMoons](doc/jupiter-moons.md)
fun [jupiterMoons](doc/jupiter-moons.md)(time: [Time](doc/-time/index.md)): [JupiterMoonsInfo](doc/-jupiter-moons-info/index.md)
Calculates jovicentric positions and velocities of Jupiter's largest 4 moons. | -| [lagrangePoint](doc/lagrange-point.md)
fun [lagrangePoint](doc/lagrange-point.md)(point: Int, time: [Time](doc/-time/index.md), majorBody: [Body](doc/-body/index.md), minorBody: [Body](doc/-body/index.md)): [StateVector](doc/-state-vector/index.md)
Calculates one of the 5 Lagrange points for a pair of co-orbiting bodies. | -| [lagrangePointFast](doc/lagrange-point-fast.md)
fun [lagrangePointFast](doc/lagrange-point-fast.md)(point: Int, majorState: [StateVector](doc/-state-vector/index.md), majorMass: Double, minorState: [StateVector](doc/-state-vector/index.md), minorMass: Double): [StateVector](doc/-state-vector/index.md)
Calculates one of the 5 Lagrange points from body masses and state vectors. | +| [lagrangePoint](doc/lagrange-point.md)
fun [lagrangePoint](doc/lagrange-point.md)(point: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), time: [Time](doc/-time/index.md), majorBody: [Body](doc/-body/index.md), minorBody: [Body](doc/-body/index.md)): [StateVector](doc/-state-vector/index.md)
Calculates one of the 5 Lagrange points for a pair of co-orbiting bodies. | +| [lagrangePointFast](doc/lagrange-point-fast.md)
fun [lagrangePointFast](doc/lagrange-point-fast.md)(point: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), majorState: [StateVector](doc/-state-vector/index.md), majorMass: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), minorState: [StateVector](doc/-state-vector/index.md), minorMass: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [StateVector](doc/-state-vector/index.md)
Calculates one of the 5 Lagrange points from body masses and state vectors. | | [libration](doc/libration.md)
fun [libration](doc/libration.md)(time: [Time](doc/-time/index.md)): [LibrationInfo](doc/-libration-info/index.md)
Calculates the Moon's libration angles at a given moment in time. | -| [localSolarEclipsesAfter](doc/local-solar-eclipses-after.md)
fun [localSolarEclipsesAfter](doc/local-solar-eclipses-after.md)(startTime: [Time](doc/-time/index.md), observer: [Observer](doc/-observer/index.md)): Sequence<[LocalSolarEclipseInfo](doc/-local-solar-eclipse-info/index.md)>
Enumerates a series of consecutive local solar eclipses that occur after a given time. | -| [lunarApsidesAfter](doc/lunar-apsides-after.md)
fun [lunarApsidesAfter](doc/lunar-apsides-after.md)(startTime: [Time](doc/-time/index.md)): Sequence<[ApsisInfo](doc/-apsis-info/index.md)>
Enumerates a series of consecutive lunar apsides that occur after a given time. | -| [lunarEclipsesAfter](doc/lunar-eclipses-after.md)
fun [lunarEclipsesAfter](doc/lunar-eclipses-after.md)(startTime: [Time](doc/-time/index.md)): Sequence<[LunarEclipseInfo](doc/-lunar-eclipse-info/index.md)>
Enumerates a series of consecutive lunar eclipses that occur after a given time. | -| [massProduct](doc/mass-product.md)
fun [massProduct](doc/mass-product.md)(body: [Body](doc/-body/index.md)): Double
Returns the product of mass and universal gravitational constant of a Solar System body. | -| [moonNodesAfter](doc/moon-nodes-after.md)
fun [moonNodesAfter](doc/moon-nodes-after.md)(startTime: [Time](doc/-time/index.md)): Sequence<[NodeEventInfo](doc/-node-event-info/index.md)>
Enumerates a series of consecutive ascending/descending nodes of the Moon. | -| [moonPhase](doc/moon-phase.md)
fun [moonPhase](doc/moon-phase.md)(time: [Time](doc/-time/index.md)): Double
Returns the Moon's phase as an angle from 0 to 360 degrees. | -| [moonQuartersAfter](doc/moon-quarters-after.md)
fun [moonQuartersAfter](doc/moon-quarters-after.md)(startTime: [Time](doc/-time/index.md)): Sequence<[MoonQuarterInfo](doc/-moon-quarter-info/index.md)>
Enumerates a series of consecutive moon quarter phase events. | +| [localSolarEclipsesAfter](doc/local-solar-eclipses-after.md)
fun [localSolarEclipsesAfter](doc/local-solar-eclipses-after.md)(startTime: [Time](doc/-time/index.md), observer: [Observer](doc/-observer/index.md)): [Sequence](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.sequences/-sequence/index.html)<[LocalSolarEclipseInfo](doc/-local-solar-eclipse-info/index.md)>
Enumerates a series of consecutive local solar eclipses that occur after a given time. | +| [lunarApsidesAfter](doc/lunar-apsides-after.md)
fun [lunarApsidesAfter](doc/lunar-apsides-after.md)(startTime: [Time](doc/-time/index.md)): [Sequence](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.sequences/-sequence/index.html)<[ApsisInfo](doc/-apsis-info/index.md)>
Enumerates a series of consecutive lunar apsides that occur after a given time. | +| [lunarEclipsesAfter](doc/lunar-eclipses-after.md)
fun [lunarEclipsesAfter](doc/lunar-eclipses-after.md)(startTime: [Time](doc/-time/index.md)): [Sequence](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.sequences/-sequence/index.html)<[LunarEclipseInfo](doc/-lunar-eclipse-info/index.md)>
Enumerates a series of consecutive lunar eclipses that occur after a given time. | +| [massProduct](doc/mass-product.md)
fun [massProduct](doc/mass-product.md)(body: [Body](doc/-body/index.md)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Returns the product of mass and universal gravitational constant of a Solar System body. | +| [moonNodesAfter](doc/moon-nodes-after.md)
fun [moonNodesAfter](doc/moon-nodes-after.md)(startTime: [Time](doc/-time/index.md)): [Sequence](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.sequences/-sequence/index.html)<[NodeEventInfo](doc/-node-event-info/index.md)>
Enumerates a series of consecutive ascending/descending nodes of the Moon. | +| [moonPhase](doc/moon-phase.md)
fun [moonPhase](doc/moon-phase.md)(time: [Time](doc/-time/index.md)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Returns the Moon's phase as an angle from 0 to 360 degrees. | +| [moonQuartersAfter](doc/moon-quarters-after.md)
fun [moonQuartersAfter](doc/moon-quarters-after.md)(startTime: [Time](doc/-time/index.md)): [Sequence](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.sequences/-sequence/index.html)<[MoonQuarterInfo](doc/-moon-quarter-info/index.md)>
Enumerates a series of consecutive moon quarter phase events. | | [nextGlobalSolarEclipse](doc/next-global-solar-eclipse.md)
fun [nextGlobalSolarEclipse](doc/next-global-solar-eclipse.md)(prevEclipseTime: [Time](doc/-time/index.md)): [GlobalSolarEclipseInfo](doc/-global-solar-eclipse-info/index.md)
Searches for the next global solar eclipse in a series. | | [nextLocalSolarEclipse](doc/next-local-solar-eclipse.md)
fun [nextLocalSolarEclipse](doc/next-local-solar-eclipse.md)(prevEclipseTime: [Time](doc/-time/index.md), observer: [Observer](doc/-observer/index.md)): [LocalSolarEclipseInfo](doc/-local-solar-eclipse-info/index.md)
Searches for the next local solar eclipse in a series. | | [nextLunarApsis](doc/next-lunar-apsis.md)
fun [nextLunarApsis](doc/next-lunar-apsis.md)(apsis: [ApsisInfo](doc/-apsis-info/index.md)): [ApsisInfo](doc/-apsis-info/index.md)
Finds the next lunar perigee or apogee event in a series. | @@ -161,12 +161,12 @@ movement through the Solar System. | [nextMoonQuarter](doc/next-moon-quarter.md)
fun [nextMoonQuarter](doc/next-moon-quarter.md)(mq: [MoonQuarterInfo](doc/-moon-quarter-info/index.md)): [MoonQuarterInfo](doc/-moon-quarter-info/index.md)
Continues searching for lunar quarters from a previous search. | | [nextPlanetApsis](doc/next-planet-apsis.md)
fun [nextPlanetApsis](doc/next-planet-apsis.md)(body: [Body](doc/-body/index.md), apsis: [ApsisInfo](doc/-apsis-info/index.md)): [ApsisInfo](doc/-apsis-info/index.md)
Finds the next planetary perihelion or aphelion event in a series. | | [nextTransit](doc/next-transit.md)
fun [nextTransit](doc/next-transit.md)(body: [Body](doc/-body/index.md), prevTransitTime: [Time](doc/-time/index.md)): [TransitInfo](doc/-transit-info/index.md)
Searches for another transit of Mercury or Venus. | -| [observerGravity](doc/observer-gravity.md)
fun [observerGravity](doc/observer-gravity.md)(latitude: Double, height: Double): Double
Calculates the gravitational acceleration experienced by an observer on the Earth. | -| [pairLongitude](doc/pair-longitude.md)
fun [pairLongitude](doc/pair-longitude.md)(body1: [Body](doc/-body/index.md), body2: [Body](doc/-body/index.md), time: [Time](doc/-time/index.md)): Double
Returns one body's ecliptic longitude with respect to another, as seen from the Earth. | -| [planetApsidesAfter](doc/planet-apsides-after.md)
fun [planetApsidesAfter](doc/planet-apsides-after.md)(body: [Body](doc/-body/index.md), startTime: [Time](doc/-time/index.md)): Sequence<[ApsisInfo](doc/-apsis-info/index.md)>
Enumerates a series of consecutive planetary perihelia/aphelia events. | -| [planetOrbitalPeriod](doc/planet-orbital-period.md)
fun [planetOrbitalPeriod](doc/planet-orbital-period.md)(body: [Body](doc/-body/index.md)): Double
Returns the average number of days it takes for a planet to orbit the Sun. | -| [radiansToDegrees](doc/radians-to-degrees.md)
fun Double.[radiansToDegrees](doc/radians-to-degrees.md)(): Double
Convert an angle expressed in radians to an angle expressed in degrees. | -| [refractionAngle](doc/refraction-angle.md)
fun [refractionAngle](doc/refraction-angle.md)(refraction: [Refraction](doc/-refraction/index.md), altitude: Double): Double
Calculates the amount of "lift" to an altitude angle caused by atmospheric refraction. | +| [observerGravity](doc/observer-gravity.md)
fun [observerGravity](doc/observer-gravity.md)(latitude: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), height: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Calculates the gravitational acceleration experienced by an observer on the Earth. | +| [pairLongitude](doc/pair-longitude.md)
fun [pairLongitude](doc/pair-longitude.md)(body1: [Body](doc/-body/index.md), body2: [Body](doc/-body/index.md), time: [Time](doc/-time/index.md)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Returns one body's ecliptic longitude with respect to another, as seen from the Earth. | +| [planetApsidesAfter](doc/planet-apsides-after.md)
fun [planetApsidesAfter](doc/planet-apsides-after.md)(body: [Body](doc/-body/index.md), startTime: [Time](doc/-time/index.md)): [Sequence](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.sequences/-sequence/index.html)<[ApsisInfo](doc/-apsis-info/index.md)>
Enumerates a series of consecutive planetary perihelia/aphelia events. | +| [planetOrbitalPeriod](doc/planet-orbital-period.md)
fun [planetOrbitalPeriod](doc/planet-orbital-period.md)(body: [Body](doc/-body/index.md)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Returns the average number of days it takes for a planet to orbit the Sun. | +| [radiansToDegrees](doc/radians-to-degrees.md)
fun [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html).[radiansToDegrees](doc/radians-to-degrees.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Convert an angle expressed in radians to an angle expressed in degrees. | +| [refractionAngle](doc/refraction-angle.md)
fun [refractionAngle](doc/refraction-angle.md)(refraction: [Refraction](doc/-refraction/index.md), altitude: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Calculates the amount of "lift" to an altitude angle caused by atmospheric refraction. | | [rotationAxis](doc/rotation-axis.md)
fun [rotationAxis](doc/rotation-axis.md)(body: [Body](doc/-body/index.md), time: [Time](doc/-time/index.md)): [AxisInfo](doc/-axis-info/index.md)
Calculates information about a body's rotation axis at a given time. | | [rotationEclEqd](doc/rotation-ecl-eqd.md)
fun [rotationEclEqd](doc/rotation-ecl-eqd.md)(time: [Time](doc/-time/index.md)): [RotationMatrix](doc/-rotation-matrix/index.md)
Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial of-date (EQD). | | [rotationEclEqj](doc/rotation-ecl-eqj.md)
fun [rotationEclEqj](doc/rotation-ecl-eqj.md)(): [RotationMatrix](doc/-rotation-matrix/index.md)
Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial J2000 (EQJ). | @@ -182,46 +182,46 @@ movement through the Solar System. | [rotationHorEcl](doc/rotation-hor-ecl.md)
fun [rotationHorEcl](doc/rotation-hor-ecl.md)(time: [Time](doc/-time/index.md), observer: [Observer](doc/-observer/index.md)): [RotationMatrix](doc/-rotation-matrix/index.md)
Calculates a rotation matrix from horizontal (HOR) to ecliptic J2000 (ECL). | | [rotationHorEqd](doc/rotation-hor-eqd.md)
fun [rotationHorEqd](doc/rotation-hor-eqd.md)(time: [Time](doc/-time/index.md), observer: [Observer](doc/-observer/index.md)): [RotationMatrix](doc/-rotation-matrix/index.md)
Calculates a rotation matrix from horizontal (HOR) to equatorial of-date (EQD). | | [rotationHorEqj](doc/rotation-hor-eqj.md)
fun [rotationHorEqj](doc/rotation-hor-eqj.md)(time: [Time](doc/-time/index.md), observer: [Observer](doc/-observer/index.md)): [RotationMatrix](doc/-rotation-matrix/index.md)
Calculates a rotation matrix from horizontal (HOR) to J2000 equatorial (EQJ). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. Source: HOR = horizontal system (x=North, y=West, z=Zenith). Target: EQJ = equatorial system, using equator at the J2000 epoch. | -| [search](doc/search.md)
fun [search](doc/search.md)(time1: [Time](doc/-time/index.md), time2: [Time](doc/-time/index.md), toleranceSeconds: Double, func: [SearchContext](doc/-search-context/index.md)): [Time](doc/-time/index.md)?
Searches for a time at which a function's value increases through zero. | -| [searchAltitude](doc/search-altitude.md)
fun [searchAltitude](doc/search-altitude.md)(body: [Body](doc/-body/index.md), observer: [Observer](doc/-observer/index.md), direction: [Direction](doc/-direction/index.md), startTime: [Time](doc/-time/index.md), limitDays: Double, altitude: Double): [Time](doc/-time/index.md)?
Finds the next time a body reaches a given altitude. | +| [search](doc/search.md)
fun [search](doc/search.md)(time1: [Time](doc/-time/index.md), time2: [Time](doc/-time/index.md), toleranceSeconds: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), func: [SearchContext](doc/-search-context/index.md)): [Time](doc/-time/index.md)?
Searches for a time at which a function's value increases through zero. | +| [searchAltitude](doc/search-altitude.md)
fun [searchAltitude](doc/search-altitude.md)(body: [Body](doc/-body/index.md), observer: [Observer](doc/-observer/index.md), direction: [Direction](doc/-direction/index.md), startTime: [Time](doc/-time/index.md), limitDays: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), altitude: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [Time](doc/-time/index.md)?
Finds the next time a body reaches a given altitude. | | [searchGlobalSolarEclipse](doc/search-global-solar-eclipse.md)
fun [searchGlobalSolarEclipse](doc/search-global-solar-eclipse.md)(startTime: [Time](doc/-time/index.md)): [GlobalSolarEclipseInfo](doc/-global-solar-eclipse-info/index.md)
Searches for a solar eclipse visible anywhere on the Earth's surface. | -| [searchHourAngle](doc/search-hour-angle.md)
fun [searchHourAngle](doc/search-hour-angle.md)(body: [Body](doc/-body/index.md), observer: [Observer](doc/-observer/index.md), hourAngle: Double, startTime: [Time](doc/-time/index.md), direction: Int = +1): [HourAngleInfo](doc/-hour-angle-info/index.md)
Searches for the time when a celestial body reaches a specified hour angle as seen by an observer on the Earth. | +| [searchHourAngle](doc/search-hour-angle.md)
fun [searchHourAngle](doc/search-hour-angle.md)(body: [Body](doc/-body/index.md), observer: [Observer](doc/-observer/index.md), hourAngle: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), startTime: [Time](doc/-time/index.md), direction: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = +1): [HourAngleInfo](doc/-hour-angle-info/index.md)
Searches for the time when a celestial body reaches a specified hour angle as seen by an observer on the Earth. | | [searchLocalSolarEclipse](doc/search-local-solar-eclipse.md)
fun [searchLocalSolarEclipse](doc/search-local-solar-eclipse.md)(startTime: [Time](doc/-time/index.md), observer: [Observer](doc/-observer/index.md)): [LocalSolarEclipseInfo](doc/-local-solar-eclipse-info/index.md)
Searches for a solar eclipse visible at a specific location on the Earth's surface. | | [searchLunarApsis](doc/search-lunar-apsis.md)
fun [searchLunarApsis](doc/search-lunar-apsis.md)(startTime: [Time](doc/-time/index.md)): [ApsisInfo](doc/-apsis-info/index.md)
Finds the date and time of the Moon's perigee or apogee. | | [searchLunarEclipse](doc/search-lunar-eclipse.md)
fun [searchLunarEclipse](doc/search-lunar-eclipse.md)(startTime: [Time](doc/-time/index.md)): [LunarEclipseInfo](doc/-lunar-eclipse-info/index.md)
Searches for a lunar eclipse. | | [searchMaxElongation](doc/search-max-elongation.md)
fun [searchMaxElongation](doc/search-max-elongation.md)(body: [Body](doc/-body/index.md), startTime: [Time](doc/-time/index.md)): [ElongationInfo](doc/-elongation-info/index.md)
Finds a date and time when Mercury or Venus reaches its maximum angle from the Sun as seen from the Earth. | | [searchMoonNode](doc/search-moon-node.md)
fun [searchMoonNode](doc/search-moon-node.md)(startTime: [Time](doc/-time/index.md)): [NodeEventInfo](doc/-node-event-info/index.md)
Searches for a time when the Moon's center crosses through the ecliptic plane. | -| [searchMoonPhase](doc/search-moon-phase.md)
fun [searchMoonPhase](doc/search-moon-phase.md)(targetLon: Double, startTime: [Time](doc/-time/index.md), limitDays: Double): [Time](doc/-time/index.md)?
Searches for the time that the Moon reaches a specified phase. | +| [searchMoonPhase](doc/search-moon-phase.md)
fun [searchMoonPhase](doc/search-moon-phase.md)(targetLon: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), startTime: [Time](doc/-time/index.md), limitDays: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [Time](doc/-time/index.md)?
Searches for the time that the Moon reaches a specified phase. | | [searchMoonQuarter](doc/search-moon-quarter.md)
fun [searchMoonQuarter](doc/search-moon-quarter.md)(startTime: [Time](doc/-time/index.md)): [MoonQuarterInfo](doc/-moon-quarter-info/index.md)
Finds the first lunar quarter after the specified date and time. A lunar quarter is one of the following four lunar phase events: new moon, first quarter, full moon, third quarter. This function finds the lunar quarter that happens soonest after the specified date and time. | | [searchPeakMagnitude](doc/search-peak-magnitude.md)
fun [searchPeakMagnitude](doc/search-peak-magnitude.md)(body: [Body](doc/-body/index.md), startTime: [Time](doc/-time/index.md)): [IlluminationInfo](doc/-illumination-info/index.md)
Searches for the date and time Venus will next appear brightest as seen from the Earth. | | [searchPlanetApsis](doc/search-planet-apsis.md)
fun [searchPlanetApsis](doc/search-planet-apsis.md)(body: [Body](doc/-body/index.md), startTime: [Time](doc/-time/index.md)): [ApsisInfo](doc/-apsis-info/index.md)
Finds the first aphelion or perihelion for a planet after a given time. | -| [searchRelativeLongitude](doc/search-relative-longitude.md)
fun [searchRelativeLongitude](doc/search-relative-longitude.md)(body: [Body](doc/-body/index.md), targetRelativeLongitude: Double, startTime: [Time](doc/-time/index.md)): [Time](doc/-time/index.md)
Searches for the time when the Earth and another planet are separated by a specified angle in ecliptic longitude, as seen from the Sun. | -| [searchRiseSet](doc/search-rise-set.md)
fun [searchRiseSet](doc/search-rise-set.md)(body: [Body](doc/-body/index.md), observer: [Observer](doc/-observer/index.md), direction: [Direction](doc/-direction/index.md), startTime: [Time](doc/-time/index.md), limitDays: Double): [Time](doc/-time/index.md)?
Searches for the next time a celestial body rises or sets as seen by an observer on the Earth. | -| [searchSunLongitude](doc/search-sun-longitude.md)
fun [searchSunLongitude](doc/search-sun-longitude.md)(targetLon: Double, startTime: [Time](doc/-time/index.md), limitDays: Double): [Time](doc/-time/index.md)?
Searches for the time when the Sun reaches an apparent ecliptic longitude as seen from the Earth. | +| [searchRelativeLongitude](doc/search-relative-longitude.md)
fun [searchRelativeLongitude](doc/search-relative-longitude.md)(body: [Body](doc/-body/index.md), targetRelativeLongitude: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), startTime: [Time](doc/-time/index.md)): [Time](doc/-time/index.md)
Searches for the time when the Earth and another planet are separated by a specified angle in ecliptic longitude, as seen from the Sun. | +| [searchRiseSet](doc/search-rise-set.md)
fun [searchRiseSet](doc/search-rise-set.md)(body: [Body](doc/-body/index.md), observer: [Observer](doc/-observer/index.md), direction: [Direction](doc/-direction/index.md), startTime: [Time](doc/-time/index.md), limitDays: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [Time](doc/-time/index.md)?
Searches for the next time a celestial body rises or sets as seen by an observer on the Earth. | +| [searchSunLongitude](doc/search-sun-longitude.md)
fun [searchSunLongitude](doc/search-sun-longitude.md)(targetLon: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), startTime: [Time](doc/-time/index.md), limitDays: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [Time](doc/-time/index.md)?
Searches for the time when the Sun reaches an apparent ecliptic longitude as seen from the Earth. | | [searchTransit](doc/search-transit.md)
fun [searchTransit](doc/search-transit.md)(body: [Body](doc/-body/index.md), startTime: [Time](doc/-time/index.md)): [TransitInfo](doc/-transit-info/index.md)
Searches for the first transit of Mercury or Venus after a given date. | -| [seasons](doc/seasons.md)
fun [seasons](doc/seasons.md)(year: Int): [SeasonsInfo](doc/-seasons-info/index.md)
Finds both equinoxes and both solstices for a given calendar year. | -| [siderealTime](doc/sidereal-time.md)
fun [siderealTime](doc/sidereal-time.md)(time: [Time](doc/-time/index.md)): Double
Calculates Greenwich Apparent Sidereal Time (GAST). | +| [seasons](doc/seasons.md)
fun [seasons](doc/seasons.md)(year: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [SeasonsInfo](doc/-seasons-info/index.md)
Finds both equinoxes and both solstices for a given calendar year. | +| [siderealTime](doc/sidereal-time.md)
fun [siderealTime](doc/sidereal-time.md)(time: [Time](doc/-time/index.md)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Calculates Greenwich Apparent Sidereal Time (GAST). | | [sunPosition](doc/sun-position.md)
fun [sunPosition](doc/sun-position.md)(time: [Time](doc/-time/index.md)): [Ecliptic](doc/-ecliptic/index.md)
Calculates geocentric ecliptic coordinates for the Sun. | -| [times](doc/times.md)
operator fun Double.[times](doc/times.md)(vec: [Vector](doc/-vector/index.md)): [Vector](doc/-vector/index.md)
Multiply a scalar by a vector, yielding another vector. | -| [transitsAfter](doc/transits-after.md)
fun [transitsAfter](doc/transits-after.md)(body: [Body](doc/-body/index.md), startTime: [Time](doc/-time/index.md)): Sequence<[TransitInfo](doc/-transit-info/index.md)>
Enumerates a series of consecutive transits of Mercury or Venus. | +| [times](doc/times.md)
operator fun [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html).[times](doc/times.md)(vec: [Vector](doc/-vector/index.md)): [Vector](doc/-vector/index.md)
Multiply a scalar by a vector, yielding another vector. | +| [transitsAfter](doc/transits-after.md)
fun [transitsAfter](doc/transits-after.md)(body: [Body](doc/-body/index.md), startTime: [Time](doc/-time/index.md)): [Sequence](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.sequences/-sequence/index.html)<[TransitInfo](doc/-transit-info/index.md)>
Enumerates a series of consecutive transits of Mercury or Venus. | ## Properties | Name | Summary | |---|---| -| [C_AUDAY](doc/-c_-a-u-d-a-y.md)
const val [C_AUDAY](doc/-c_-a-u-d-a-y.md): Double = 173.1446326846693
The speed of light in AU/day. | -| [CALLISTO_RADIUS_KM](doc/-c-a-l-l-i-s-t-o_-r-a-d-i-u-s_-k-m.md)
const val [CALLISTO_RADIUS_KM](doc/-c-a-l-l-i-s-t-o_-r-a-d-i-u-s_-k-m.md): Double = 2410.3
The mean radius of Jupiter's moon Callisto, expressed in kilometers. | -| [DEG2RAD](doc/-d-e-g2-r-a-d.md)
const val [DEG2RAD](doc/-d-e-g2-r-a-d.md): Double = 0.017453292519943295
The factor to convert degrees to radians = pi/180. | -| [EUROPA_RADIUS_KM](doc/-e-u-r-o-p-a_-r-a-d-i-u-s_-k-m.md)
const val [EUROPA_RADIUS_KM](doc/-e-u-r-o-p-a_-r-a-d-i-u-s_-k-m.md): Double = 1560.8
The mean radius of Jupiter's moon Europa, expressed in kilometers. | -| [GANYMEDE_RADIUS_KM](doc/-g-a-n-y-m-e-d-e_-r-a-d-i-u-s_-k-m.md)
const val [GANYMEDE_RADIUS_KM](doc/-g-a-n-y-m-e-d-e_-r-a-d-i-u-s_-k-m.md): Double = 2631.2
The mean radius of Jupiter's moon Ganymede, expressed in kilometers. | -| [HOUR2RAD](doc/-h-o-u-r2-r-a-d.md)
const val [HOUR2RAD](doc/-h-o-u-r2-r-a-d.md): Double = 0.26179938779914946
The factor to convert sidereal hours to radians = pi/12. | -| [IO_RADIUS_KM](doc/-i-o_-r-a-d-i-u-s_-k-m.md)
const val [IO_RADIUS_KM](doc/-i-o_-r-a-d-i-u-s_-k-m.md): Double = 1821.6
The mean radius of Jupiter's moon Io, expressed in kilometers. | -| [JUPITER_EQUATORIAL_RADIUS_KM](doc/-j-u-p-i-t-e-r_-e-q-u-a-t-o-r-i-a-l_-r-a-d-i-u-s_-k-m.md)
const val [JUPITER_EQUATORIAL_RADIUS_KM](doc/-j-u-p-i-t-e-r_-e-q-u-a-t-o-r-i-a-l_-r-a-d-i-u-s_-k-m.md): Double = 71492.0
The equatorial radius of Jupiter, expressed in kilometers. | -| [JUPITER_MEAN_RADIUS_KM](doc/-j-u-p-i-t-e-r_-m-e-a-n_-r-a-d-i-u-s_-k-m.md)
const val [JUPITER_MEAN_RADIUS_KM](doc/-j-u-p-i-t-e-r_-m-e-a-n_-r-a-d-i-u-s_-k-m.md): Double = 69911.0
The volumetric mean radius of Jupiter, expressed in kilometers. | -| [JUPITER_POLAR_RADIUS_KM](doc/-j-u-p-i-t-e-r_-p-o-l-a-r_-r-a-d-i-u-s_-k-m.md)
const val [JUPITER_POLAR_RADIUS_KM](doc/-j-u-p-i-t-e-r_-p-o-l-a-r_-r-a-d-i-u-s_-k-m.md): Double = 66854.0
The polar radius of Jupiter, expressed in kilometers. | -| [KM_PER_AU](doc/-k-m_-p-e-r_-a-u.md)
const val [KM_PER_AU](doc/-k-m_-p-e-r_-a-u.md): Double = 1.4959787069098932E8
The number of kilometers in one astronomical unit (AU). | -| [MILLISECONDS_PER_DAY](doc/-m-i-l-l-i-s-e-c-o-n-d-s_-p-e-r_-d-a-y.md)
const val [MILLISECONDS_PER_DAY](doc/-m-i-l-l-i-s-e-c-o-n-d-s_-p-e-r_-d-a-y.md): Double
The number of milliseconds in a day. | -| [MINUTES_PER_DAY](doc/-m-i-n-u-t-e-s_-p-e-r_-d-a-y.md)
const val [MINUTES_PER_DAY](doc/-m-i-n-u-t-e-s_-p-e-r_-d-a-y.md): Double
The number of minutes in a day. | -| [RAD2DEG](doc/-r-a-d2-d-e-g.md)
const val [RAD2DEG](doc/-r-a-d2-d-e-g.md): Double = 57.29577951308232
The factor to convert radians to degrees = 180/pi. | -| [RAD2HOUR](doc/-r-a-d2-h-o-u-r.md)
const val [RAD2HOUR](doc/-r-a-d2-h-o-u-r.md): Double = 3.819718634205488
The factor to convert radians to sidereal hours = 12/pi. | -| [SECONDS_PER_DAY](doc/-s-e-c-o-n-d-s_-p-e-r_-d-a-y.md)
const val [SECONDS_PER_DAY](doc/-s-e-c-o-n-d-s_-p-e-r_-d-a-y.md): Double
The number of seconds in a day. | +| [C_AUDAY](doc/-c_-a-u-d-a-y.md)
const val [C_AUDAY](doc/-c_-a-u-d-a-y.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) = 173.1446326846693
The speed of light in AU/day. | +| [CALLISTO_RADIUS_KM](doc/-c-a-l-l-i-s-t-o_-r-a-d-i-u-s_-k-m.md)
const val [CALLISTO_RADIUS_KM](doc/-c-a-l-l-i-s-t-o_-r-a-d-i-u-s_-k-m.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) = 2410.3
The mean radius of Jupiter's moon Callisto, expressed in kilometers. | +| [DEG2RAD](doc/-d-e-g2-r-a-d.md)
const val [DEG2RAD](doc/-d-e-g2-r-a-d.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) = 0.017453292519943295
The factor to convert degrees to radians = pi/180. | +| [EUROPA_RADIUS_KM](doc/-e-u-r-o-p-a_-r-a-d-i-u-s_-k-m.md)
const val [EUROPA_RADIUS_KM](doc/-e-u-r-o-p-a_-r-a-d-i-u-s_-k-m.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) = 1560.8
The mean radius of Jupiter's moon Europa, expressed in kilometers. | +| [GANYMEDE_RADIUS_KM](doc/-g-a-n-y-m-e-d-e_-r-a-d-i-u-s_-k-m.md)
const val [GANYMEDE_RADIUS_KM](doc/-g-a-n-y-m-e-d-e_-r-a-d-i-u-s_-k-m.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) = 2631.2
The mean radius of Jupiter's moon Ganymede, expressed in kilometers. | +| [HOUR2RAD](doc/-h-o-u-r2-r-a-d.md)
const val [HOUR2RAD](doc/-h-o-u-r2-r-a-d.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) = 0.26179938779914946
The factor to convert sidereal hours to radians = pi/12. | +| [IO_RADIUS_KM](doc/-i-o_-r-a-d-i-u-s_-k-m.md)
const val [IO_RADIUS_KM](doc/-i-o_-r-a-d-i-u-s_-k-m.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) = 1821.6
The mean radius of Jupiter's moon Io, expressed in kilometers. | +| [JUPITER_EQUATORIAL_RADIUS_KM](doc/-j-u-p-i-t-e-r_-e-q-u-a-t-o-r-i-a-l_-r-a-d-i-u-s_-k-m.md)
const val [JUPITER_EQUATORIAL_RADIUS_KM](doc/-j-u-p-i-t-e-r_-e-q-u-a-t-o-r-i-a-l_-r-a-d-i-u-s_-k-m.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) = 71492.0
The equatorial radius of Jupiter, expressed in kilometers. | +| [JUPITER_MEAN_RADIUS_KM](doc/-j-u-p-i-t-e-r_-m-e-a-n_-r-a-d-i-u-s_-k-m.md)
const val [JUPITER_MEAN_RADIUS_KM](doc/-j-u-p-i-t-e-r_-m-e-a-n_-r-a-d-i-u-s_-k-m.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) = 69911.0
The volumetric mean radius of Jupiter, expressed in kilometers. | +| [JUPITER_POLAR_RADIUS_KM](doc/-j-u-p-i-t-e-r_-p-o-l-a-r_-r-a-d-i-u-s_-k-m.md)
const val [JUPITER_POLAR_RADIUS_KM](doc/-j-u-p-i-t-e-r_-p-o-l-a-r_-r-a-d-i-u-s_-k-m.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) = 66854.0
The polar radius of Jupiter, expressed in kilometers. | +| [KM_PER_AU](doc/-k-m_-p-e-r_-a-u.md)
const val [KM_PER_AU](doc/-k-m_-p-e-r_-a-u.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) = 1.4959787069098932E8
The number of kilometers in one astronomical unit (AU). | +| [MILLISECONDS_PER_DAY](doc/-m-i-l-l-i-s-e-c-o-n-d-s_-p-e-r_-d-a-y.md)
const val [MILLISECONDS_PER_DAY](doc/-m-i-l-l-i-s-e-c-o-n-d-s_-p-e-r_-d-a-y.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
The number of milliseconds in a day. | +| [MINUTES_PER_DAY](doc/-m-i-n-u-t-e-s_-p-e-r_-d-a-y.md)
const val [MINUTES_PER_DAY](doc/-m-i-n-u-t-e-s_-p-e-r_-d-a-y.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
The number of minutes in a day. | +| [RAD2DEG](doc/-r-a-d2-d-e-g.md)
const val [RAD2DEG](doc/-r-a-d2-d-e-g.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) = 57.29577951308232
The factor to convert radians to degrees = 180/pi. | +| [RAD2HOUR](doc/-r-a-d2-h-o-u-r.md)
const val [RAD2HOUR](doc/-r-a-d2-h-o-u-r.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) = 3.819718634205488
The factor to convert radians to sidereal hours = 12/pi. | +| [SECONDS_PER_DAY](doc/-s-e-c-o-n-d-s_-p-e-r_-d-a-y.md)
const val [SECONDS_PER_DAY](doc/-s-e-c-o-n-d-s_-p-e-r_-d-a-y.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
The number of seconds in a day. | diff --git a/source/kotlin/build.gradle.kts b/source/kotlin/build.gradle.kts index 3fc4f110..3b4761df 100644 --- a/source/kotlin/build.gradle.kts +++ b/source/kotlin/build.gradle.kts @@ -6,7 +6,7 @@ plugins { } group = "io.github.cosinekitty" -version = "2.1.10" +version = "2.1.11" repositories { mavenCentral() diff --git a/source/kotlin/doc/-aberration/index.md b/source/kotlin/doc/-aberration/index.md index 9b07a97e..2691d56e 100644 --- a/source/kotlin/doc/-aberration/index.md +++ b/source/kotlin/doc/-aberration/index.md @@ -2,7 +2,7 @@ # Aberration -enum [Aberration](index.md) : Enum<[Aberration](index.md)> +enum [Aberration](index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[Aberration](index.md)> Aberration calculation options. diff --git a/source/kotlin/doc/-apsis-info/-apsis-info.md b/source/kotlin/doc/-apsis-info/-apsis-info.md index 5ff17116..e2b11eed 100644 --- a/source/kotlin/doc/-apsis-info/-apsis-info.md +++ b/source/kotlin/doc/-apsis-info/-apsis-info.md @@ -2,4 +2,4 @@ # ApsisInfo -fun [ApsisInfo](-apsis-info.md)(time: [Time](../-time/index.md), kind: [ApsisKind](../-apsis-kind/index.md), distanceAu: Double) +fun [ApsisInfo](-apsis-info.md)(time: [Time](../-time/index.md), kind: [ApsisKind](../-apsis-kind/index.md), distanceAu: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) diff --git a/source/kotlin/doc/-apsis-info/distance-au.md b/source/kotlin/doc/-apsis-info/distance-au.md index 5626349e..9341eb77 100644 --- a/source/kotlin/doc/-apsis-info/distance-au.md +++ b/source/kotlin/doc/-apsis-info/distance-au.md @@ -2,6 +2,6 @@ # distanceAu -val [distanceAu](distance-au.md): Double +val [distanceAu](distance-au.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) The distance between the centers of the bodies in astronomical units. diff --git a/source/kotlin/doc/-apsis-info/distance-km.md b/source/kotlin/doc/-apsis-info/distance-km.md index fab9150c..16cfbb28 100644 --- a/source/kotlin/doc/-apsis-info/distance-km.md +++ b/source/kotlin/doc/-apsis-info/distance-km.md @@ -2,6 +2,6 @@ # distanceKm -val [distanceKm](distance-km.md): Double +val [distanceKm](distance-km.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) The distance between the centers of the bodies in kilometers. diff --git a/source/kotlin/doc/-apsis-info/index.md b/source/kotlin/doc/-apsis-info/index.md index f725cf41..56119cd6 100644 --- a/source/kotlin/doc/-apsis-info/index.md +++ b/source/kotlin/doc/-apsis-info/index.md @@ -2,7 +2,7 @@ # ApsisInfo -class [ApsisInfo](index.md)(time: [Time](../-time/index.md), kind: [ApsisKind](../-apsis-kind/index.md), distanceAu: Double) +class [ApsisInfo](index.md)(time: [Time](../-time/index.md), kind: [ApsisKind](../-apsis-kind/index.md), distanceAu: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) An apsis event: pericenter (closest approach) or apocenter (farthest distance). @@ -16,13 +16,13 @@ This data structure is returned by [searchLunarApsis](../search-lunar-apsis.md) | | | |---|---| -| [ApsisInfo](-apsis-info.md)
fun [ApsisInfo](-apsis-info.md)(time: [Time](../-time/index.md), kind: [ApsisKind](../-apsis-kind/index.md), distanceAu: Double) | +| [ApsisInfo](-apsis-info.md)
fun [ApsisInfo](-apsis-info.md)(time: [Time](../-time/index.md), kind: [ApsisKind](../-apsis-kind/index.md), distanceAu: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) | ## Properties | Name | Summary | |---|---| -| [distanceAu](distance-au.md)
val [distanceAu](distance-au.md): Double
The distance between the centers of the bodies in astronomical units. | -| [distanceKm](distance-km.md)
val [distanceKm](distance-km.md): Double
The distance between the centers of the bodies in kilometers. | +| [distanceAu](distance-au.md)
val [distanceAu](distance-au.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
The distance between the centers of the bodies in astronomical units. | +| [distanceKm](distance-km.md)
val [distanceKm](distance-km.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
The distance between the centers of the bodies in kilometers. | | [kind](kind.md)
val [kind](kind.md): [ApsisKind](../-apsis-kind/index.md)
Whether this is a pericenter or apocenter event. | | [time](time.md)
val [time](time.md): [Time](../-time/index.md)
The date and time of the apsis. | diff --git a/source/kotlin/doc/-apsis-kind/index.md b/source/kotlin/doc/-apsis-kind/index.md index d225fa01..e7d2fbc8 100644 --- a/source/kotlin/doc/-apsis-kind/index.md +++ b/source/kotlin/doc/-apsis-kind/index.md @@ -2,7 +2,7 @@ # ApsisKind -enum [ApsisKind](index.md) : Enum<[ApsisKind](index.md)> +enum [ApsisKind](index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[ApsisKind](index.md)> The type of apsis: pericenter (closest approach) or apocenter (farthest distance). diff --git a/source/kotlin/doc/-axis-info/-axis-info.md b/source/kotlin/doc/-axis-info/-axis-info.md index 0da322df..53629922 100644 --- a/source/kotlin/doc/-axis-info/-axis-info.md +++ b/source/kotlin/doc/-axis-info/-axis-info.md @@ -2,4 +2,4 @@ # AxisInfo -fun [AxisInfo](-axis-info.md)(ra: Double, dec: Double, spin: Double, north: [Vector](../-vector/index.md)) +fun [AxisInfo](-axis-info.md)(ra: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), dec: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), spin: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), north: [Vector](../-vector/index.md)) diff --git a/source/kotlin/doc/-axis-info/dec.md b/source/kotlin/doc/-axis-info/dec.md index e36a57a0..07d5389a 100644 --- a/source/kotlin/doc/-axis-info/dec.md +++ b/source/kotlin/doc/-axis-info/dec.md @@ -2,6 +2,6 @@ # dec -val [dec](dec.md): Double +val [dec](dec.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) The J2000 declination of the body's north pole direction, in degrees. diff --git a/source/kotlin/doc/-axis-info/index.md b/source/kotlin/doc/-axis-info/index.md index 259dfedc..c3361c1f 100644 --- a/source/kotlin/doc/-axis-info/index.md +++ b/source/kotlin/doc/-axis-info/index.md @@ -2,7 +2,7 @@ # AxisInfo -class [AxisInfo](index.md)(ra: Double, dec: Double, spin: Double, north: [Vector](../-vector/index.md)) +class [AxisInfo](index.md)(ra: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), dec: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), spin: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), north: [Vector](../-vector/index.md)) Information about a body's rotation axis at a given time. @@ -20,13 +20,13 @@ The field north is a unit vector pointing in the direction of the body's north p | | | |---|---| -| [AxisInfo](-axis-info.md)
fun [AxisInfo](-axis-info.md)(ra: Double, dec: Double, spin: Double, north: [Vector](../-vector/index.md)) | +| [AxisInfo](-axis-info.md)
fun [AxisInfo](-axis-info.md)(ra: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), dec: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), spin: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), north: [Vector](../-vector/index.md)) | ## Properties | Name | Summary | |---|---| -| [dec](dec.md)
val [dec](dec.md): Double
The J2000 declination of the body's north pole direction, in degrees. | +| [dec](dec.md)
val [dec](dec.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
The J2000 declination of the body's north pole direction, in degrees. | | [north](north.md)
val [north](north.md): [Vector](../-vector/index.md)
A J2000 dimensionless unit vector pointing in the direction of the body's north pole. | -| [ra](ra.md)
val [ra](ra.md): Double
The J2000 right ascension of the body's north pole direction, in sidereal hours. | -| [spin](spin.md)
val [spin](spin.md): Double
Rotation angle of the body's prime meridian, in degrees. | +| [ra](ra.md)
val [ra](ra.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
The J2000 right ascension of the body's north pole direction, in sidereal hours. | +| [spin](spin.md)
val [spin](spin.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Rotation angle of the body's prime meridian, in degrees. | diff --git a/source/kotlin/doc/-axis-info/ra.md b/source/kotlin/doc/-axis-info/ra.md index 868224aa..62fae23b 100644 --- a/source/kotlin/doc/-axis-info/ra.md +++ b/source/kotlin/doc/-axis-info/ra.md @@ -2,6 +2,6 @@ # ra -val [ra](ra.md): Double +val [ra](ra.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) The J2000 right ascension of the body's north pole direction, in sidereal hours. diff --git a/source/kotlin/doc/-axis-info/spin.md b/source/kotlin/doc/-axis-info/spin.md index 9a4251e3..26a8e905 100644 --- a/source/kotlin/doc/-axis-info/spin.md +++ b/source/kotlin/doc/-axis-info/spin.md @@ -2,6 +2,6 @@ # spin -val [spin](spin.md): Double +val [spin](spin.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) Rotation angle of the body's prime meridian, in degrees. diff --git a/source/kotlin/doc/-body/index.md b/source/kotlin/doc/-body/index.md index 191ce6dd..de752332 100644 --- a/source/kotlin/doc/-body/index.md +++ b/source/kotlin/doc/-body/index.md @@ -2,7 +2,7 @@ # Body -enum [Body](index.md) : Enum<[Body](index.md)> +enum [Body](index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[Body](index.md)> The enumeration of celestial bodies supported by Astronomy Engine. diff --git a/source/kotlin/doc/-c-a-l-l-i-s-t-o_-r-a-d-i-u-s_-k-m.md b/source/kotlin/doc/-c-a-l-l-i-s-t-o_-r-a-d-i-u-s_-k-m.md index ee9c9246..60d7e187 100644 --- a/source/kotlin/doc/-c-a-l-l-i-s-t-o_-r-a-d-i-u-s_-k-m.md +++ b/source/kotlin/doc/-c-a-l-l-i-s-t-o_-r-a-d-i-u-s_-k-m.md @@ -2,6 +2,6 @@ # CALLISTO_RADIUS_KM -const val [CALLISTO_RADIUS_KM](-c-a-l-l-i-s-t-o_-r-a-d-i-u-s_-k-m.md): Double = 2410.3 +const val [CALLISTO_RADIUS_KM](-c-a-l-l-i-s-t-o_-r-a-d-i-u-s_-k-m.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) = 2410.3 The mean radius of Jupiter's moon Callisto, expressed in kilometers. diff --git a/source/kotlin/doc/-c_-a-u-d-a-y.md b/source/kotlin/doc/-c_-a-u-d-a-y.md index c9d74506..95543485 100644 --- a/source/kotlin/doc/-c_-a-u-d-a-y.md +++ b/source/kotlin/doc/-c_-a-u-d-a-y.md @@ -2,6 +2,6 @@ # C_AUDAY -const val [C_AUDAY](-c_-a-u-d-a-y.md): Double = 173.1446326846693 +const val [C_AUDAY](-c_-a-u-d-a-y.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) = 173.1446326846693 The speed of light in AU/day. diff --git a/source/kotlin/doc/-constellation-info/-constellation-info.md b/source/kotlin/doc/-constellation-info/-constellation-info.md index 119420f2..7b58f530 100644 --- a/source/kotlin/doc/-constellation-info/-constellation-info.md +++ b/source/kotlin/doc/-constellation-info/-constellation-info.md @@ -2,4 +2,4 @@ # ConstellationInfo -fun [ConstellationInfo](-constellation-info.md)(symbol: String, name: String, ra1875: Double, dec1875: Double) +fun [ConstellationInfo](-constellation-info.md)(symbol: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), ra1875: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), dec1875: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) diff --git a/source/kotlin/doc/-constellation-info/dec1875.md b/source/kotlin/doc/-constellation-info/dec1875.md index c82ca526..618f0b39 100644 --- a/source/kotlin/doc/-constellation-info/dec1875.md +++ b/source/kotlin/doc/-constellation-info/dec1875.md @@ -2,6 +2,6 @@ # dec1875 -val [dec1875](dec1875.md): Double +val [dec1875](dec1875.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) Declination expressed in B1875 coordinates. diff --git a/source/kotlin/doc/-constellation-info/index.md b/source/kotlin/doc/-constellation-info/index.md index b7819f46..18627b36 100644 --- a/source/kotlin/doc/-constellation-info/index.md +++ b/source/kotlin/doc/-constellation-info/index.md @@ -2,7 +2,7 @@ # ConstellationInfo -class [ConstellationInfo](index.md)(symbol: String, name: String, ra1875: Double, dec1875: Double) +class [ConstellationInfo](index.md)(symbol: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), ra1875: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), dec1875: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) Reports the constellation that a given celestial point lies within. @@ -12,13 +12,13 @@ The [constellation](../constellation.md) function returns this object to report | | | |---|---| -| [ConstellationInfo](-constellation-info.md)
fun [ConstellationInfo](-constellation-info.md)(symbol: String, name: String, ra1875: Double, dec1875: Double) | +| [ConstellationInfo](-constellation-info.md)
fun [ConstellationInfo](-constellation-info.md)(symbol: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), ra1875: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), dec1875: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) | ## Properties | Name | Summary | |---|---| -| [dec1875](dec1875.md)
val [dec1875](dec1875.md): Double
Declination expressed in B1875 coordinates. | -| [name](name.md)
val [name](name.md): String
Full name of constellation, e.g. "Orion". | -| [ra1875](ra1875.md)
val [ra1875](ra1875.md): Double
Right ascension expressed in B1875 coordinates. | -| [symbol](symbol.md)
val [symbol](symbol.md): String
3-character mnemonic symbol for the constellation, e.g. "Ori". | +| [dec1875](dec1875.md)
val [dec1875](dec1875.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Declination expressed in B1875 coordinates. | +| [name](name.md)
val [name](name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Full name of constellation, e.g. "Orion". | +| [ra1875](ra1875.md)
val [ra1875](ra1875.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Right ascension expressed in B1875 coordinates. | +| [symbol](symbol.md)
val [symbol](symbol.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
3-character mnemonic symbol for the constellation, e.g. "Ori". | diff --git a/source/kotlin/doc/-constellation-info/name.md b/source/kotlin/doc/-constellation-info/name.md index 1e3e4c32..a2416b24 100644 --- a/source/kotlin/doc/-constellation-info/name.md +++ b/source/kotlin/doc/-constellation-info/name.md @@ -2,6 +2,6 @@ # name -val [name](name.md): String +val [name](name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) Full name of constellation, e.g. "Orion". diff --git a/source/kotlin/doc/-constellation-info/ra1875.md b/source/kotlin/doc/-constellation-info/ra1875.md index 60599180..d74b12f9 100644 --- a/source/kotlin/doc/-constellation-info/ra1875.md +++ b/source/kotlin/doc/-constellation-info/ra1875.md @@ -2,6 +2,6 @@ # ra1875 -val [ra1875](ra1875.md): Double +val [ra1875](ra1875.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) Right ascension expressed in B1875 coordinates. diff --git a/source/kotlin/doc/-constellation-info/symbol.md b/source/kotlin/doc/-constellation-info/symbol.md index 78233f61..0c1198e2 100644 --- a/source/kotlin/doc/-constellation-info/symbol.md +++ b/source/kotlin/doc/-constellation-info/symbol.md @@ -2,6 +2,6 @@ # symbol -val [symbol](symbol.md): String +val [symbol](symbol.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) 3-character mnemonic symbol for the constellation, e.g. "Ori". diff --git a/source/kotlin/doc/-d-e-g2-r-a-d.md b/source/kotlin/doc/-d-e-g2-r-a-d.md index 3ee8c5fe..d4a37cf1 100644 --- a/source/kotlin/doc/-d-e-g2-r-a-d.md +++ b/source/kotlin/doc/-d-e-g2-r-a-d.md @@ -2,6 +2,6 @@ # DEG2RAD -const val [DEG2RAD](-d-e-g2-r-a-d.md): Double = 0.017453292519943295 +const val [DEG2RAD](-d-e-g2-r-a-d.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) = 0.017453292519943295 The factor to convert degrees to radians = pi/180. diff --git a/source/kotlin/doc/-date-time/-date-time.md b/source/kotlin/doc/-date-time/-date-time.md index 9367a8bb..afd1d0de 100644 --- a/source/kotlin/doc/-date-time/-date-time.md +++ b/source/kotlin/doc/-date-time/-date-time.md @@ -2,4 +2,4 @@ # DateTime -fun [DateTime](-date-time.md)(year: Int, month: Int, day: Int, hour: Int, minute: Int, second: Double) +fun [DateTime](-date-time.md)(year: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), month: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), day: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), hour: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), minute: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), second: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) diff --git a/source/kotlin/doc/-date-time/day.md b/source/kotlin/doc/-date-time/day.md index 6fb52719..a72ade32 100644 --- a/source/kotlin/doc/-date-time/day.md +++ b/source/kotlin/doc/-date-time/day.md @@ -2,6 +2,6 @@ # day -val [day](day.md): Int +val [day](day.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) The day of the month, 1..31. diff --git a/source/kotlin/doc/-date-time/hour.md b/source/kotlin/doc/-date-time/hour.md index bfff51f3..9a4c6471 100644 --- a/source/kotlin/doc/-date-time/hour.md +++ b/source/kotlin/doc/-date-time/hour.md @@ -2,6 +2,6 @@ # hour -val [hour](hour.md): Int +val [hour](hour.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) The hour of the day, 0..23. diff --git a/source/kotlin/doc/-date-time/index.md b/source/kotlin/doc/-date-time/index.md index 8c8e9415..159ca215 100644 --- a/source/kotlin/doc/-date-time/index.md +++ b/source/kotlin/doc/-date-time/index.md @@ -2,7 +2,7 @@ # DateTime -class [DateTime](index.md)(year: Int, month: Int, day: Int, hour: Int, minute: Int, second: Double) +class [DateTime](index.md)(year: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), month: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), day: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), hour: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), minute: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), second: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) A universal time resolved into UTC calendar date and time fields. @@ -10,23 +10,23 @@ A universal time resolved into UTC calendar date and time fields. | | | |---|---| -| [DateTime](-date-time.md)
fun [DateTime](-date-time.md)(year: Int, month: Int, day: Int, hour: Int, minute: Int, second: Double) | +| [DateTime](-date-time.md)
fun [DateTime](-date-time.md)(year: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), month: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), day: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), hour: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), minute: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), second: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) | ## Functions | Name | Summary | |---|---| -| [toDays](to-days.md)
fun [toDays](to-days.md)(): Double
Convert this date and time to the floating point number of days since the J2000 epoch. | -| [toString](to-string.md)
open override fun [toString](to-string.md)(): String
Converts this DateTime to ISO 8601 format, expressed in UTC with millisecond resolution. | +| [toDays](to-days.md)
fun [toDays](to-days.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Convert this date and time to the floating point number of days since the J2000 epoch. | +| [toString](to-string.md)
open override fun [toString](to-string.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Converts this DateTime to ISO 8601 format, expressed in UTC with millisecond resolution. | | [toTime](to-time.md)
fun [toTime](to-time.md)(): [Time](../-time/index.md)
Convert this date and time to a [Time](../-time/index.md) value that can be used for astronomy calculations. | ## Properties | Name | Summary | |---|---| -| [day](day.md)
val [day](day.md): Int
The day of the month, 1..31. | -| [hour](hour.md)
val [hour](hour.md): Int
The hour of the day, 0..23. | -| [minute](minute.md)
val [minute](minute.md): Int
The minute value 0..59. | -| [month](month.md)
val [month](month.md): Int
The month value 1=January, ..., 12=December. | -| [second](second.md)
val [second](second.md): Double
The floating point second value in the half-open range [0, 60). | -| [year](year.md)
val [year](year.md): Int
The integer year value. | +| [day](day.md)
val [day](day.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
The day of the month, 1..31. | +| [hour](hour.md)
val [hour](hour.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
The hour of the day, 0..23. | +| [minute](minute.md)
val [minute](minute.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
The minute value 0..59. | +| [month](month.md)
val [month](month.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
The month value 1=January, ..., 12=December. | +| [second](second.md)
val [second](second.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
The floating point second value in the half-open range [0, 60). | +| [year](year.md)
val [year](year.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
The integer year value. | diff --git a/source/kotlin/doc/-date-time/minute.md b/source/kotlin/doc/-date-time/minute.md index 5e217f8f..a7e92e2b 100644 --- a/source/kotlin/doc/-date-time/minute.md +++ b/source/kotlin/doc/-date-time/minute.md @@ -2,6 +2,6 @@ # minute -val [minute](minute.md): Int +val [minute](minute.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) The minute value 0..59. diff --git a/source/kotlin/doc/-date-time/month.md b/source/kotlin/doc/-date-time/month.md index 40dfdeae..1a921449 100644 --- a/source/kotlin/doc/-date-time/month.md +++ b/source/kotlin/doc/-date-time/month.md @@ -2,6 +2,6 @@ # month -val [month](month.md): Int +val [month](month.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) The month value 1=January, ..., 12=December. diff --git a/source/kotlin/doc/-date-time/second.md b/source/kotlin/doc/-date-time/second.md index 5972fd07..5a03f0aa 100644 --- a/source/kotlin/doc/-date-time/second.md +++ b/source/kotlin/doc/-date-time/second.md @@ -2,6 +2,6 @@ # second -val [second](second.md): Double +val [second](second.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) The floating point second value in the half-open range [0, 60). diff --git a/source/kotlin/doc/-date-time/to-days.md b/source/kotlin/doc/-date-time/to-days.md index f8f45754..2eeb231c 100644 --- a/source/kotlin/doc/-date-time/to-days.md +++ b/source/kotlin/doc/-date-time/to-days.md @@ -2,6 +2,6 @@ # toDays -fun [toDays](to-days.md)(): Double +fun [toDays](to-days.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) Convert this date and time to the floating point number of days since the J2000 epoch. diff --git a/source/kotlin/doc/-date-time/to-string.md b/source/kotlin/doc/-date-time/to-string.md index 5acfb96e..b6c917fe 100644 --- a/source/kotlin/doc/-date-time/to-string.md +++ b/source/kotlin/doc/-date-time/to-string.md @@ -2,7 +2,7 @@ # toString -open override fun [toString](to-string.md)(): String +open override fun [toString](to-string.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) Converts this DateTime to ISO 8601 format, expressed in UTC with millisecond resolution. diff --git a/source/kotlin/doc/-date-time/year.md b/source/kotlin/doc/-date-time/year.md index 9b2fccc8..1e25bd66 100644 --- a/source/kotlin/doc/-date-time/year.md +++ b/source/kotlin/doc/-date-time/year.md @@ -2,6 +2,6 @@ # year -val [year](year.md): Int +val [year](year.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) The integer year value. diff --git a/source/kotlin/doc/-direction/-rise/index.md b/source/kotlin/doc/-direction/-rise/index.md index e1c6c03b..f1b6f31b 100644 --- a/source/kotlin/doc/-direction/-rise/index.md +++ b/source/kotlin/doc/-direction/-rise/index.md @@ -8,5 +8,5 @@ Indicates a rising event: a celestial body is observed to rise above the horizon | Name | Summary | |---|---| -| [sign](../sign.md)
val [sign](../sign.md): Int
A numeric value that is helpful in formulas involving rise/set. The sign is +1 for a rising event, or -1 for a setting event. | +| [sign](../sign.md)
val [sign](../sign.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
A numeric value that is helpful in formulas involving rise/set. The sign is +1 for a rising event, or -1 for a setting event. | diff --git a/source/kotlin/doc/-direction/-set/index.md b/source/kotlin/doc/-direction/-set/index.md index 14dda38a..a7dddab0 100644 --- a/source/kotlin/doc/-direction/-set/index.md +++ b/source/kotlin/doc/-direction/-set/index.md @@ -8,5 +8,5 @@ Indicates a setting event: a celestial body is observed to sink below the horizo | Name | Summary | |---|---| -| [sign](../sign.md)
val [sign](../sign.md): Int
A numeric value that is helpful in formulas involving rise/set. The sign is +1 for a rising event, or -1 for a setting event. | +| [sign](../sign.md)
val [sign](../sign.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
A numeric value that is helpful in formulas involving rise/set. The sign is +1 for a rising event, or -1 for a setting event. | diff --git a/source/kotlin/doc/-direction/index.md b/source/kotlin/doc/-direction/index.md index d4aa474a..a1707179 100644 --- a/source/kotlin/doc/-direction/index.md +++ b/source/kotlin/doc/-direction/index.md @@ -2,7 +2,7 @@ # Direction -enum [Direction](index.md) : Enum<[Direction](index.md)> +enum [Direction](index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[Direction](index.md)> Selects whether to search for a rising event or a setting event for a celestial body. @@ -17,5 +17,5 @@ Selects whether to search for a rising event or a setting event for a celestial | Name | Summary | |---|---| -| [sign](sign.md)
val [sign](sign.md): Int
A numeric value that is helpful in formulas involving rise/set. The sign is +1 for a rising event, or -1 for a setting event. | +| [sign](sign.md)
val [sign](sign.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
A numeric value that is helpful in formulas involving rise/set. The sign is +1 for a rising event, or -1 for a setting event. | diff --git a/source/kotlin/doc/-direction/sign.md b/source/kotlin/doc/-direction/sign.md index da8db482..8e79c4c1 100644 --- a/source/kotlin/doc/-direction/sign.md +++ b/source/kotlin/doc/-direction/sign.md @@ -2,6 +2,6 @@ # sign -val [sign](sign.md): Int +val [sign](sign.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) A numeric value that is helpful in formulas involving rise/set. The sign is +1 for a rising event, or -1 for a setting event. diff --git a/source/kotlin/doc/-e-u-r-o-p-a_-r-a-d-i-u-s_-k-m.md b/source/kotlin/doc/-e-u-r-o-p-a_-r-a-d-i-u-s_-k-m.md index 129309da..d1272d9e 100644 --- a/source/kotlin/doc/-e-u-r-o-p-a_-r-a-d-i-u-s_-k-m.md +++ b/source/kotlin/doc/-e-u-r-o-p-a_-r-a-d-i-u-s_-k-m.md @@ -2,6 +2,6 @@ # EUROPA_RADIUS_KM -const val [EUROPA_RADIUS_KM](-e-u-r-o-p-a_-r-a-d-i-u-s_-k-m.md): Double = 1560.8 +const val [EUROPA_RADIUS_KM](-e-u-r-o-p-a_-r-a-d-i-u-s_-k-m.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) = 1560.8 The mean radius of Jupiter's moon Europa, expressed in kilometers. diff --git a/source/kotlin/doc/-earth-not-allowed-exception/index.md b/source/kotlin/doc/-earth-not-allowed-exception/index.md index 46c0fa41..45478059 100644 --- a/source/kotlin/doc/-earth-not-allowed-exception/index.md +++ b/source/kotlin/doc/-earth-not-allowed-exception/index.md @@ -2,7 +2,7 @@ # EarthNotAllowedException -class [EarthNotAllowedException](index.md) : Exception +class [EarthNotAllowedException](index.md) : [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) The Earth is not allowed as the body parameter. @@ -16,18 +16,18 @@ The Earth is not allowed as the body parameter. | Name | Summary | |---|---| -| [addSuppressed](../-internal-error/index.md#282858770%2FFunctions%2F-1216412040)
fun [addSuppressed](../-internal-error/index.md#282858770%2FFunctions%2F-1216412040)(p0: Throwable) | -| [fillInStackTrace](../-internal-error/index.md#-1102069925%2FFunctions%2F-1216412040)
open fun [fillInStackTrace](../-internal-error/index.md#-1102069925%2FFunctions%2F-1216412040)(): Throwable | -| [getLocalizedMessage](../-internal-error/index.md#1043865560%2FFunctions%2F-1216412040)
open fun [getLocalizedMessage](../-internal-error/index.md#1043865560%2FFunctions%2F-1216412040)(): String | -| [getStackTrace](../-internal-error/index.md#2050903719%2FFunctions%2F-1216412040)
open fun [getStackTrace](../-internal-error/index.md#2050903719%2FFunctions%2F-1216412040)(): Array<StackTraceElement> | -| [getSuppressed](../-internal-error/index.md#672492560%2FFunctions%2F-1216412040)
fun [getSuppressed](../-internal-error/index.md#672492560%2FFunctions%2F-1216412040)(): Array<Throwable> | -| [initCause](../-internal-error/index.md#-418225042%2FFunctions%2F-1216412040)
open fun [initCause](../-internal-error/index.md#-418225042%2FFunctions%2F-1216412040)(p0: Throwable): Throwable | -| [printStackTrace](../-internal-error/index.md#-1769529168%2FFunctions%2F-1216412040)
open fun [printStackTrace](../-internal-error/index.md#-1769529168%2FFunctions%2F-1216412040)()
open fun [printStackTrace](../-internal-error/index.md#1841853697%2FFunctions%2F-1216412040)(p0: PrintStream)
open fun [printStackTrace](../-internal-error/index.md#1175535278%2FFunctions%2F-1216412040)(p0: PrintWriter) | -| [setStackTrace](../-internal-error/index.md#2135801318%2FFunctions%2F-1216412040)
open fun [setStackTrace](../-internal-error/index.md#2135801318%2FFunctions%2F-1216412040)(p0: Array<StackTraceElement>) | +| [addSuppressed](../-internal-error/index.md#282858770%2FFunctions%2F-1216412040)
fun [addSuppressed](../-internal-error/index.md#282858770%2FFunctions%2F-1216412040)(p0: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)) | +| [fillInStackTrace](../-internal-error/index.md#-1102069925%2FFunctions%2F-1216412040)
open fun [fillInStackTrace](../-internal-error/index.md#-1102069925%2FFunctions%2F-1216412040)(): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html) | +| [getLocalizedMessage](../-internal-error/index.md#1043865560%2FFunctions%2F-1216412040)
open fun [getLocalizedMessage](../-internal-error/index.md#1043865560%2FFunctions%2F-1216412040)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [getStackTrace](../-internal-error/index.md#2050903719%2FFunctions%2F-1216412040)
open fun [getStackTrace](../-internal-error/index.md#2050903719%2FFunctions%2F-1216412040)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[StackTraceElement](https://docs.oracle.com/javase/8/docs/api/java/lang/StackTraceElement.html)> | +| [getSuppressed](../-internal-error/index.md#672492560%2FFunctions%2F-1216412040)
fun [getSuppressed](../-internal-error/index.md#672492560%2FFunctions%2F-1216412040)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)> | +| [initCause](../-internal-error/index.md#-418225042%2FFunctions%2F-1216412040)
open fun [initCause](../-internal-error/index.md#-418225042%2FFunctions%2F-1216412040)(p0: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html) | +| [printStackTrace](../-internal-error/index.md#-1769529168%2FFunctions%2F-1216412040)
open fun [printStackTrace](../-internal-error/index.md#-1769529168%2FFunctions%2F-1216412040)()
open fun [printStackTrace](../-internal-error/index.md#1841853697%2FFunctions%2F-1216412040)(p0: [PrintStream](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html))
open fun [printStackTrace](../-internal-error/index.md#1175535278%2FFunctions%2F-1216412040)(p0: [PrintWriter](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html)) | +| [setStackTrace](../-internal-error/index.md#2135801318%2FFunctions%2F-1216412040)
open fun [setStackTrace](../-internal-error/index.md#2135801318%2FFunctions%2F-1216412040)(p0: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[StackTraceElement](https://docs.oracle.com/javase/8/docs/api/java/lang/StackTraceElement.html)>) | ## Properties | Name | Summary | |---|---| -| [cause](../-internal-error/index.md#-654012527%2FProperties%2F-1216412040)
open val [cause](../-internal-error/index.md#-654012527%2FProperties%2F-1216412040): Throwable? | -| [message](../-internal-error/index.md#1824300659%2FProperties%2F-1216412040)
open val [message](../-internal-error/index.md#1824300659%2FProperties%2F-1216412040): String? | +| [cause](../-internal-error/index.md#-654012527%2FProperties%2F-1216412040)
open val [cause](../-internal-error/index.md#-654012527%2FProperties%2F-1216412040): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? | +| [message](../-internal-error/index.md#1824300659%2FProperties%2F-1216412040)
open val [message](../-internal-error/index.md#1824300659%2FProperties%2F-1216412040): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? | diff --git a/source/kotlin/doc/-eclipse-event/-eclipse-event.md b/source/kotlin/doc/-eclipse-event/-eclipse-event.md index f1a7e4c9..3df63c12 100644 --- a/source/kotlin/doc/-eclipse-event/-eclipse-event.md +++ b/source/kotlin/doc/-eclipse-event/-eclipse-event.md @@ -2,4 +2,4 @@ # EclipseEvent -fun [EclipseEvent](-eclipse-event.md)(time: [Time](../-time/index.md), altitude: Double) +fun [EclipseEvent](-eclipse-event.md)(time: [Time](../-time/index.md), altitude: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) diff --git a/source/kotlin/doc/-eclipse-event/altitude.md b/source/kotlin/doc/-eclipse-event/altitude.md index 589f1e3c..b0b1322e 100644 --- a/source/kotlin/doc/-eclipse-event/altitude.md +++ b/source/kotlin/doc/-eclipse-event/altitude.md @@ -2,6 +2,6 @@ # altitude -val [altitude](altitude.md): Double +val [altitude](altitude.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) The angular altitude of the center of the Sun above/below the horizon, at time, corrected for atmospheric refraction and expressed in degrees. diff --git a/source/kotlin/doc/-eclipse-event/index.md b/source/kotlin/doc/-eclipse-event/index.md index a539ea0f..d57f80f1 100644 --- a/source/kotlin/doc/-eclipse-event/index.md +++ b/source/kotlin/doc/-eclipse-event/index.md @@ -2,7 +2,7 @@ # EclipseEvent -class [EclipseEvent](index.md)(time: [Time](../-time/index.md), altitude: Double) +class [EclipseEvent](index.md)(time: [Time](../-time/index.md), altitude: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) Holds a time and the observed altitude of the Sun at that time. @@ -14,11 +14,11 @@ If altitude is negative, the event is theoretical only; it would be visible if t | | | |---|---| -| [EclipseEvent](-eclipse-event.md)
fun [EclipseEvent](-eclipse-event.md)(time: [Time](../-time/index.md), altitude: Double) | +| [EclipseEvent](-eclipse-event.md)
fun [EclipseEvent](-eclipse-event.md)(time: [Time](../-time/index.md), altitude: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) | ## Properties | Name | Summary | |---|---| -| [altitude](altitude.md)
val [altitude](altitude.md): Double
The angular altitude of the center of the Sun above/below the horizon, at time, corrected for atmospheric refraction and expressed in degrees. | +| [altitude](altitude.md)
val [altitude](altitude.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
The angular altitude of the center of the Sun above/below the horizon, at time, corrected for atmospheric refraction and expressed in degrees. | | [time](time.md)
val [time](time.md): [Time](../-time/index.md)
The date and time of the event. | diff --git a/source/kotlin/doc/-eclipse-kind/index.md b/source/kotlin/doc/-eclipse-kind/index.md index 5ab63323..be1c7f91 100644 --- a/source/kotlin/doc/-eclipse-kind/index.md +++ b/source/kotlin/doc/-eclipse-kind/index.md @@ -2,7 +2,7 @@ # EclipseKind -enum [EclipseKind](index.md) : Enum<[EclipseKind](index.md)> +enum [EclipseKind](index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[EclipseKind](index.md)> The different kinds of lunar/solar eclipses. diff --git a/source/kotlin/doc/-ecliptic/-ecliptic.md b/source/kotlin/doc/-ecliptic/-ecliptic.md index 4ed7a13f..6d155be2 100644 --- a/source/kotlin/doc/-ecliptic/-ecliptic.md +++ b/source/kotlin/doc/-ecliptic/-ecliptic.md @@ -2,4 +2,4 @@ # Ecliptic -fun [Ecliptic](-ecliptic.md)(vec: [Vector](../-vector/index.md), elat: Double, elon: Double) +fun [Ecliptic](-ecliptic.md)(vec: [Vector](../-vector/index.md), elat: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), elon: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) diff --git a/source/kotlin/doc/-ecliptic/elat.md b/source/kotlin/doc/-ecliptic/elat.md index 8f241fd0..9109c7de 100644 --- a/source/kotlin/doc/-ecliptic/elat.md +++ b/source/kotlin/doc/-ecliptic/elat.md @@ -2,6 +2,6 @@ # elat -val [elat](elat.md): Double +val [elat](elat.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) Latitude in degrees north (positive) or south (negative) of the ecliptic plane. diff --git a/source/kotlin/doc/-ecliptic/elon.md b/source/kotlin/doc/-ecliptic/elon.md index ccd5b8b8..3fc3ed4c 100644 --- a/source/kotlin/doc/-ecliptic/elon.md +++ b/source/kotlin/doc/-ecliptic/elon.md @@ -2,6 +2,6 @@ # elon -val [elon](elon.md): Double +val [elon](elon.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) Longitude in degrees around the ecliptic plane prograde from the equinox. diff --git a/source/kotlin/doc/-ecliptic/index.md b/source/kotlin/doc/-ecliptic/index.md index 5295ed24..e0b7bdc9 100644 --- a/source/kotlin/doc/-ecliptic/index.md +++ b/source/kotlin/doc/-ecliptic/index.md @@ -2,7 +2,7 @@ # Ecliptic -data class [Ecliptic](index.md)(vec: [Vector](../-vector/index.md), elat: Double, elon: Double) +data class [Ecliptic](index.md)(vec: [Vector](../-vector/index.md), elat: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), elon: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) Ecliptic angular and Cartesian coordinates. @@ -12,12 +12,12 @@ Coordinates of a celestial body as seen from the center of the Sun (heliocentric | | | |---|---| -| [Ecliptic](-ecliptic.md)
fun [Ecliptic](-ecliptic.md)(vec: [Vector](../-vector/index.md), elat: Double, elon: Double) | +| [Ecliptic](-ecliptic.md)
fun [Ecliptic](-ecliptic.md)(vec: [Vector](../-vector/index.md), elat: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), elon: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) | ## Properties | Name | Summary | |---|---| -| [elat](elat.md)
val [elat](elat.md): Double
Latitude in degrees north (positive) or south (negative) of the ecliptic plane. | -| [elon](elon.md)
val [elon](elon.md): Double
Longitude in degrees around the ecliptic plane prograde from the equinox. | +| [elat](elat.md)
val [elat](elat.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Latitude in degrees north (positive) or south (negative) of the ecliptic plane. | +| [elon](elon.md)
val [elon](elon.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Longitude in degrees around the ecliptic plane prograde from the equinox. | | [vec](vec.md)
val [vec](vec.md): [Vector](../-vector/index.md)
Cartesian ecliptic vector, with components as follows: x: the direction of the equinox along the ecliptic plane. y: in the ecliptic plane 90 degrees prograde from the equinox. z: perpendicular to the ecliptic plane. Positive is north. | diff --git a/source/kotlin/doc/-elongation-info/-elongation-info.md b/source/kotlin/doc/-elongation-info/-elongation-info.md index 91b9b8b5..930cc1be 100644 --- a/source/kotlin/doc/-elongation-info/-elongation-info.md +++ b/source/kotlin/doc/-elongation-info/-elongation-info.md @@ -2,4 +2,4 @@ # ElongationInfo -fun [ElongationInfo](-elongation-info.md)(time: [Time](../-time/index.md), visibility: [Visibility](../-visibility/index.md), elongation: Double, eclipticSeparation: Double) +fun [ElongationInfo](-elongation-info.md)(time: [Time](../-time/index.md), visibility: [Visibility](../-visibility/index.md), elongation: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), eclipticSeparation: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) diff --git a/source/kotlin/doc/-elongation-info/ecliptic-separation.md b/source/kotlin/doc/-elongation-info/ecliptic-separation.md index 33ec2d52..179843d6 100644 --- a/source/kotlin/doc/-elongation-info/ecliptic-separation.md +++ b/source/kotlin/doc/-elongation-info/ecliptic-separation.md @@ -2,6 +2,6 @@ # eclipticSeparation -val [eclipticSeparation](ecliptic-separation.md): Double +val [eclipticSeparation](ecliptic-separation.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) The difference between the ecliptic longitudes of the body and the Sun, as seen from the Earth. diff --git a/source/kotlin/doc/-elongation-info/elongation.md b/source/kotlin/doc/-elongation-info/elongation.md index c87ea816..5d1d4f2d 100644 --- a/source/kotlin/doc/-elongation-info/elongation.md +++ b/source/kotlin/doc/-elongation-info/elongation.md @@ -2,6 +2,6 @@ # elongation -val [elongation](elongation.md): Double +val [elongation](elongation.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) The angle in degrees between the body and the Sun, as seen from the Earth. diff --git a/source/kotlin/doc/-elongation-info/index.md b/source/kotlin/doc/-elongation-info/index.md index 8adfc8de..815ad980 100644 --- a/source/kotlin/doc/-elongation-info/index.md +++ b/source/kotlin/doc/-elongation-info/index.md @@ -2,7 +2,7 @@ # ElongationInfo -class [ElongationInfo](index.md)(time: [Time](../-time/index.md), visibility: [Visibility](../-visibility/index.md), elongation: Double, eclipticSeparation: Double) +class [ElongationInfo](index.md)(time: [Time](../-time/index.md), visibility: [Visibility](../-visibility/index.md), elongation: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), eclipticSeparation: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) Contains information about the visibility of a celestial body at a given date and time. @@ -12,13 +12,13 @@ See [elongation](elongation.md) for more detailed information about the members | | | |---|---| -| [ElongationInfo](-elongation-info.md)
fun [ElongationInfo](-elongation-info.md)(time: [Time](../-time/index.md), visibility: [Visibility](../-visibility/index.md), elongation: Double, eclipticSeparation: Double) | +| [ElongationInfo](-elongation-info.md)
fun [ElongationInfo](-elongation-info.md)(time: [Time](../-time/index.md), visibility: [Visibility](../-visibility/index.md), elongation: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), eclipticSeparation: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) | ## Properties | Name | Summary | |---|---| -| [eclipticSeparation](ecliptic-separation.md)
val [eclipticSeparation](ecliptic-separation.md): Double
The difference between the ecliptic longitudes of the body and the Sun, as seen from the Earth. | -| [elongation](elongation.md)
val [elongation](elongation.md): Double
The angle in degrees between the body and the Sun, as seen from the Earth. | +| [eclipticSeparation](ecliptic-separation.md)
val [eclipticSeparation](ecliptic-separation.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
The difference between the ecliptic longitudes of the body and the Sun, as seen from the Earth. | +| [elongation](elongation.md)
val [elongation](elongation.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
The angle in degrees between the body and the Sun, as seen from the Earth. | | [time](time.md)
val [time](time.md): [Time](../-time/index.md)
The date and time of the observation. | | [visibility](visibility.md)
val [visibility](visibility.md): [Visibility](../-visibility/index.md)
Whether the body is best seen in the morning or the evening. | diff --git a/source/kotlin/doc/-equator-epoch/index.md b/source/kotlin/doc/-equator-epoch/index.md index f7cf53f9..425f3cf1 100644 --- a/source/kotlin/doc/-equator-epoch/index.md +++ b/source/kotlin/doc/-equator-epoch/index.md @@ -2,7 +2,7 @@ # EquatorEpoch -enum [EquatorEpoch](index.md) : Enum<[EquatorEpoch](index.md)> +enum [EquatorEpoch](index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[EquatorEpoch](index.md)> Selects the date for which the Earth's equator is to be used for representing equatorial coordinates. diff --git a/source/kotlin/doc/-equatorial/-equatorial.md b/source/kotlin/doc/-equatorial/-equatorial.md index d9df3cf6..6997b92e 100644 --- a/source/kotlin/doc/-equatorial/-equatorial.md +++ b/source/kotlin/doc/-equatorial/-equatorial.md @@ -2,4 +2,4 @@ # Equatorial -fun [Equatorial](-equatorial.md)(ra: Double, dec: Double, dist: Double, vec: [Vector](../-vector/index.md)) +fun [Equatorial](-equatorial.md)(ra: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), dec: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), dist: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), vec: [Vector](../-vector/index.md)) diff --git a/source/kotlin/doc/-equatorial/dec.md b/source/kotlin/doc/-equatorial/dec.md index 7571d157..40e26d95 100644 --- a/source/kotlin/doc/-equatorial/dec.md +++ b/source/kotlin/doc/-equatorial/dec.md @@ -2,6 +2,6 @@ # dec -val [dec](dec.md): Double +val [dec](dec.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) Declination in degrees. diff --git a/source/kotlin/doc/-equatorial/dist.md b/source/kotlin/doc/-equatorial/dist.md index b250ccf8..ab747883 100644 --- a/source/kotlin/doc/-equatorial/dist.md +++ b/source/kotlin/doc/-equatorial/dist.md @@ -2,6 +2,6 @@ # dist -val [dist](dist.md): Double +val [dist](dist.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) Distance to the celestial body in AU. diff --git a/source/kotlin/doc/-equatorial/index.md b/source/kotlin/doc/-equatorial/index.md index a7a7a4f6..a096e5bd 100644 --- a/source/kotlin/doc/-equatorial/index.md +++ b/source/kotlin/doc/-equatorial/index.md @@ -2,7 +2,7 @@ # Equatorial -class [Equatorial](index.md)(ra: Double, dec: Double, dist: Double, vec: [Vector](../-vector/index.md)) +class [Equatorial](index.md)(ra: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), dec: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), dist: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), vec: [Vector](../-vector/index.md)) Equatorial angular and cartesian coordinates. @@ -12,13 +12,13 @@ Coordinates of a celestial body as seen from the Earth (geocentric or topocentri | | | |---|---| -| [Equatorial](-equatorial.md)
fun [Equatorial](-equatorial.md)(ra: Double, dec: Double, dist: Double, vec: [Vector](../-vector/index.md)) | +| [Equatorial](-equatorial.md)
fun [Equatorial](-equatorial.md)(ra: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), dec: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), dist: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), vec: [Vector](../-vector/index.md)) | ## Properties | Name | Summary | |---|---| -| [dec](dec.md)
val [dec](dec.md): Double
Declination in degrees. | -| [dist](dist.md)
val [dist](dist.md): Double
Distance to the celestial body in AU. | -| [ra](ra.md)
val [ra](ra.md): Double
Right ascension in sidereal hours. | +| [dec](dec.md)
val [dec](dec.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Declination in degrees. | +| [dist](dist.md)
val [dist](dist.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Distance to the celestial body in AU. | +| [ra](ra.md)
val [ra](ra.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Right ascension in sidereal hours. | | [vec](vec.md)
val [vec](vec.md): [Vector](../-vector/index.md)
Equatorial coordinates in cartesian vector form: x = March equinox, y = June solstice, z = north. | diff --git a/source/kotlin/doc/-equatorial/ra.md b/source/kotlin/doc/-equatorial/ra.md index 8925cead..d6d77f2a 100644 --- a/source/kotlin/doc/-equatorial/ra.md +++ b/source/kotlin/doc/-equatorial/ra.md @@ -2,6 +2,6 @@ # ra -val [ra](ra.md): Double +val [ra](ra.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) Right ascension in sidereal hours. diff --git a/source/kotlin/doc/-g-a-n-y-m-e-d-e_-r-a-d-i-u-s_-k-m.md b/source/kotlin/doc/-g-a-n-y-m-e-d-e_-r-a-d-i-u-s_-k-m.md index 99b8edf3..673ed6fb 100644 --- a/source/kotlin/doc/-g-a-n-y-m-e-d-e_-r-a-d-i-u-s_-k-m.md +++ b/source/kotlin/doc/-g-a-n-y-m-e-d-e_-r-a-d-i-u-s_-k-m.md @@ -2,6 +2,6 @@ # GANYMEDE_RADIUS_KM -const val [GANYMEDE_RADIUS_KM](-g-a-n-y-m-e-d-e_-r-a-d-i-u-s_-k-m.md): Double = 2631.2 +const val [GANYMEDE_RADIUS_KM](-g-a-n-y-m-e-d-e_-r-a-d-i-u-s_-k-m.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) = 2631.2 The mean radius of Jupiter's moon Ganymede, expressed in kilometers. diff --git a/source/kotlin/doc/-global-solar-eclipse-info/-global-solar-eclipse-info.md b/source/kotlin/doc/-global-solar-eclipse-info/-global-solar-eclipse-info.md index 29f56745..835fac1a 100644 --- a/source/kotlin/doc/-global-solar-eclipse-info/-global-solar-eclipse-info.md +++ b/source/kotlin/doc/-global-solar-eclipse-info/-global-solar-eclipse-info.md @@ -2,4 +2,4 @@ # GlobalSolarEclipseInfo -fun [GlobalSolarEclipseInfo](-global-solar-eclipse-info.md)(kind: [EclipseKind](../-eclipse-kind/index.md), obscuration: Double, peak: [Time](../-time/index.md), distance: Double, latitude: Double, longitude: Double) +fun [GlobalSolarEclipseInfo](-global-solar-eclipse-info.md)(kind: [EclipseKind](../-eclipse-kind/index.md), obscuration: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), peak: [Time](../-time/index.md), distance: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), latitude: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), longitude: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) diff --git a/source/kotlin/doc/-global-solar-eclipse-info/distance.md b/source/kotlin/doc/-global-solar-eclipse-info/distance.md index 47b56bbb..da6fc3af 100644 --- a/source/kotlin/doc/-global-solar-eclipse-info/distance.md +++ b/source/kotlin/doc/-global-solar-eclipse-info/distance.md @@ -2,6 +2,6 @@ # distance -val [distance](distance.md): Double +val [distance](distance.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) The distance between the Sun/Moon shadow axis and the center of the Earth, in kilometers. diff --git a/source/kotlin/doc/-global-solar-eclipse-info/index.md b/source/kotlin/doc/-global-solar-eclipse-info/index.md index 1a764180..5d359723 100644 --- a/source/kotlin/doc/-global-solar-eclipse-info/index.md +++ b/source/kotlin/doc/-global-solar-eclipse-info/index.md @@ -2,7 +2,7 @@ # GlobalSolarEclipseInfo -class [GlobalSolarEclipseInfo](index.md)(kind: [EclipseKind](../-eclipse-kind/index.md), obscuration: Double, peak: [Time](../-time/index.md), distance: Double, latitude: Double, longitude: Double) +class [GlobalSolarEclipseInfo](index.md)(kind: [EclipseKind](../-eclipse-kind/index.md), obscuration: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), peak: [Time](../-time/index.md), distance: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), latitude: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), longitude: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) Reports the time and geographic location of the peak of a solar eclipse. @@ -20,15 +20,15 @@ For total or annular eclipses, the obscuration field holds the fraction (0, 1] o | | | |---|---| -| [GlobalSolarEclipseInfo](-global-solar-eclipse-info.md)
fun [GlobalSolarEclipseInfo](-global-solar-eclipse-info.md)(kind: [EclipseKind](../-eclipse-kind/index.md), obscuration: Double, peak: [Time](../-time/index.md), distance: Double, latitude: Double, longitude: Double) | +| [GlobalSolarEclipseInfo](-global-solar-eclipse-info.md)
fun [GlobalSolarEclipseInfo](-global-solar-eclipse-info.md)(kind: [EclipseKind](../-eclipse-kind/index.md), obscuration: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), peak: [Time](../-time/index.md), distance: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), latitude: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), longitude: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) | ## Properties | Name | Summary | |---|---| -| [distance](distance.md)
val [distance](distance.md): Double
The distance between the Sun/Moon shadow axis and the center of the Earth, in kilometers. | +| [distance](distance.md)
val [distance](distance.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
The distance between the Sun/Moon shadow axis and the center of the Earth, in kilometers. | | [kind](kind.md)
val [kind](kind.md): [EclipseKind](../-eclipse-kind/index.md)
The type of solar eclipse: EclipseKind.Partial, EclipseKind.Annular, or EclipseKind.Total. | -| [latitude](latitude.md)
val [latitude](latitude.md): Double
The geographic latitude at the center of the peak eclipse shadow. | -| [longitude](longitude.md)
val [longitude](longitude.md): Double
The geographic longitude at the center of the peak eclipse shadow. | -| [obscuration](obscuration.md)
val [obscuration](obscuration.md): Double
The peak fraction of the Sun's apparent disc area obscured by the Moon (total and annular eclipses only). | +| [latitude](latitude.md)
val [latitude](latitude.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
The geographic latitude at the center of the peak eclipse shadow. | +| [longitude](longitude.md)
val [longitude](longitude.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
The geographic longitude at the center of the peak eclipse shadow. | +| [obscuration](obscuration.md)
val [obscuration](obscuration.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
The peak fraction of the Sun's apparent disc area obscured by the Moon (total and annular eclipses only). | | [peak](peak.md)
val [peak](peak.md): [Time](../-time/index.md)
The date and time when the solar eclipse is darkest. This is the instant when the axis of the Moon's shadow cone passes closest to the Earth's center. | diff --git a/source/kotlin/doc/-global-solar-eclipse-info/latitude.md b/source/kotlin/doc/-global-solar-eclipse-info/latitude.md index 9621ec0b..d7d291be 100644 --- a/source/kotlin/doc/-global-solar-eclipse-info/latitude.md +++ b/source/kotlin/doc/-global-solar-eclipse-info/latitude.md @@ -2,6 +2,6 @@ # latitude -val [latitude](latitude.md): Double +val [latitude](latitude.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) The geographic latitude at the center of the peak eclipse shadow. diff --git a/source/kotlin/doc/-global-solar-eclipse-info/longitude.md b/source/kotlin/doc/-global-solar-eclipse-info/longitude.md index cc58b09d..c5889b03 100644 --- a/source/kotlin/doc/-global-solar-eclipse-info/longitude.md +++ b/source/kotlin/doc/-global-solar-eclipse-info/longitude.md @@ -2,6 +2,6 @@ # longitude -val [longitude](longitude.md): Double +val [longitude](longitude.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) The geographic longitude at the center of the peak eclipse shadow. diff --git a/source/kotlin/doc/-global-solar-eclipse-info/obscuration.md b/source/kotlin/doc/-global-solar-eclipse-info/obscuration.md index 0b05da4f..381bfd99 100644 --- a/source/kotlin/doc/-global-solar-eclipse-info/obscuration.md +++ b/source/kotlin/doc/-global-solar-eclipse-info/obscuration.md @@ -2,6 +2,6 @@ # obscuration -val [obscuration](obscuration.md): Double +val [obscuration](obscuration.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) The peak fraction of the Sun's apparent disc area obscured by the Moon (total and annular eclipses only). diff --git a/source/kotlin/doc/-gravity-simulator/-gravity-simulator.md b/source/kotlin/doc/-gravity-simulator/-gravity-simulator.md index f0113fd4..c7a5a4a3 100644 --- a/source/kotlin/doc/-gravity-simulator/-gravity-simulator.md +++ b/source/kotlin/doc/-gravity-simulator/-gravity-simulator.md @@ -2,7 +2,7 @@ # GravitySimulator -fun [GravitySimulator](-gravity-simulator.md)(originBody: [Body](../-body/index.md), time: [Time](../-time/index.md), bodyStates: List<[StateVector](../-state-vector/index.md)>) +fun [GravitySimulator](-gravity-simulator.md)(originBody: [Body](../-body/index.md), time: [Time](../-time/index.md), bodyStates: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[StateVector](../-state-vector/index.md)>) Creates a gravity simulation object. diff --git a/source/kotlin/doc/-gravity-simulator/index.md b/source/kotlin/doc/-gravity-simulator/index.md index 9d51b88a..d916eec9 100644 --- a/source/kotlin/doc/-gravity-simulator/index.md +++ b/source/kotlin/doc/-gravity-simulator/index.md @@ -12,7 +12,7 @@ This class calculates the movement of arbitrary small bodies, such as asteroids | | | |---|---| -| [GravitySimulator](-gravity-simulator.md)
fun [GravitySimulator](-gravity-simulator.md)(originBody: [Body](../-body/index.md), time: [Time](../-time/index.md), bodyStates: List<[StateVector](../-state-vector/index.md)>)
Creates a gravity simulation object. | +| [GravitySimulator](-gravity-simulator.md)
fun [GravitySimulator](-gravity-simulator.md)(originBody: [Body](../-body/index.md), time: [Time](../-time/index.md), bodyStates: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)<[StateVector](../-state-vector/index.md)>)
Creates a gravity simulation object. | ## Functions @@ -21,7 +21,7 @@ This class calculates the movement of arbitrary small bodies, such as asteroids | [solarSystemBodyState](solar-system-body-state.md)
fun [solarSystemBodyState](solar-system-body-state.md)(body: [Body](../-body/index.md)): [StateVector](../-state-vector/index.md)
Get the position and velocity of a Solar System body included in the simulation. | | [swap](swap.md)
fun [swap](swap.md)()
Exchange the current time step with the previous time step. | | [time](time.md)
fun [time](time.md)(): [Time](../-time/index.md)
Returns the time of the current simulation step. | -| [update](update.md)
fun [update](update.md)(time: [Time](../-time/index.md)): Array<[StateVector](../-state-vector/index.md)>
Advances the gravity simulation by a small time step. | +| [update](update.md)
fun [update](update.md)(time: [Time](../-time/index.md)): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[StateVector](../-state-vector/index.md)>
Advances the gravity simulation by a small time step. | ## Properties diff --git a/source/kotlin/doc/-gravity-simulator/update.md b/source/kotlin/doc/-gravity-simulator/update.md index 46d8914d..d0feab55 100644 --- a/source/kotlin/doc/-gravity-simulator/update.md +++ b/source/kotlin/doc/-gravity-simulator/update.md @@ -2,7 +2,7 @@ # update -fun [update](update.md)(time: [Time](../-time/index.md)): Array<[StateVector](../-state-vector/index.md)> +fun [update](update.md)(time: [Time](../-time/index.md)): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[StateVector](../-state-vector/index.md)> Advances the gravity simulation by a small time step. diff --git a/source/kotlin/doc/-h-o-u-r2-r-a-d.md b/source/kotlin/doc/-h-o-u-r2-r-a-d.md index a2b9c613..0fecef55 100644 --- a/source/kotlin/doc/-h-o-u-r2-r-a-d.md +++ b/source/kotlin/doc/-h-o-u-r2-r-a-d.md @@ -2,6 +2,6 @@ # HOUR2RAD -const val [HOUR2RAD](-h-o-u-r2-r-a-d.md): Double = 0.26179938779914946 +const val [HOUR2RAD](-h-o-u-r2-r-a-d.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) = 0.26179938779914946 The factor to convert sidereal hours to radians = pi/12. diff --git a/source/kotlin/doc/-i-o_-r-a-d-i-u-s_-k-m.md b/source/kotlin/doc/-i-o_-r-a-d-i-u-s_-k-m.md index 33c8ae8d..2ad82f9d 100644 --- a/source/kotlin/doc/-i-o_-r-a-d-i-u-s_-k-m.md +++ b/source/kotlin/doc/-i-o_-r-a-d-i-u-s_-k-m.md @@ -2,6 +2,6 @@ # IO_RADIUS_KM -const val [IO_RADIUS_KM](-i-o_-r-a-d-i-u-s_-k-m.md): Double = 1821.6 +const val [IO_RADIUS_KM](-i-o_-r-a-d-i-u-s_-k-m.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) = 1821.6 The mean radius of Jupiter's moon Io, expressed in kilometers. diff --git a/source/kotlin/doc/-illumination-info/-illumination-info.md b/source/kotlin/doc/-illumination-info/-illumination-info.md index 694596e6..5f99ba5b 100644 --- a/source/kotlin/doc/-illumination-info/-illumination-info.md +++ b/source/kotlin/doc/-illumination-info/-illumination-info.md @@ -2,4 +2,4 @@ # IlluminationInfo -fun [IlluminationInfo](-illumination-info.md)(time: [Time](../-time/index.md), mag: Double, phaseAngle: Double, phaseFraction: Double, helioDist: Double, ringTilt: Double) +fun [IlluminationInfo](-illumination-info.md)(time: [Time](../-time/index.md), mag: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), phaseAngle: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), phaseFraction: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), helioDist: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), ringTilt: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) diff --git a/source/kotlin/doc/-illumination-info/helio-dist.md b/source/kotlin/doc/-illumination-info/helio-dist.md index 31690abb..fd00f924 100644 --- a/source/kotlin/doc/-illumination-info/helio-dist.md +++ b/source/kotlin/doc/-illumination-info/helio-dist.md @@ -2,6 +2,6 @@ # helioDist -val [helioDist](helio-dist.md): Double +val [helioDist](helio-dist.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) The distance between the Sun and the body at the observation time. diff --git a/source/kotlin/doc/-illumination-info/index.md b/source/kotlin/doc/-illumination-info/index.md index b78bd31c..4ae67298 100644 --- a/source/kotlin/doc/-illumination-info/index.md +++ b/source/kotlin/doc/-illumination-info/index.md @@ -2,7 +2,7 @@ # IlluminationInfo -class [IlluminationInfo](index.md)(time: [Time](../-time/index.md), mag: Double, phaseAngle: Double, phaseFraction: Double, helioDist: Double, ringTilt: Double) +class [IlluminationInfo](index.md)(time: [Time](../-time/index.md), mag: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), phaseAngle: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), phaseFraction: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), helioDist: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), ringTilt: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) Information about the brightness and illuminated shape of a celestial body. @@ -12,15 +12,15 @@ Returned by the functions [illumination](../illumination.md) and [searchPeakMagn | | | |---|---| -| [IlluminationInfo](-illumination-info.md)
fun [IlluminationInfo](-illumination-info.md)(time: [Time](../-time/index.md), mag: Double, phaseAngle: Double, phaseFraction: Double, helioDist: Double, ringTilt: Double) | +| [IlluminationInfo](-illumination-info.md)
fun [IlluminationInfo](-illumination-info.md)(time: [Time](../-time/index.md), mag: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), phaseAngle: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), phaseFraction: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), helioDist: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), ringTilt: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) | ## Properties | Name | Summary | |---|---| -| [helioDist](helio-dist.md)
val [helioDist](helio-dist.md): Double
The distance between the Sun and the body at the observation time. | -| [mag](mag.md)
val [mag](mag.md): Double
The visual magnitude of the body. Smaller values are brighter. | -| [phaseAngle](phase-angle.md)
val [phaseAngle](phase-angle.md): Double
The angle in degrees between the Sun and the Earth, as seen from the body. Indicates the body's phase as seen from the Earth. | -| [phaseFraction](phase-fraction.md)
val [phaseFraction](phase-fraction.md): Double
A value in the range 0.0, 1.0 indicating what fraction of the body's apparent disc is illuminated, as seen from the Earth. | -| [ringTilt](ring-tilt.md)
val [ringTilt](ring-tilt.md): Double
For Saturn, the tilt angle in degrees of its rings as seen from Earth. For all other bodies, 0.0. | +| [helioDist](helio-dist.md)
val [helioDist](helio-dist.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
The distance between the Sun and the body at the observation time. | +| [mag](mag.md)
val [mag](mag.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
The visual magnitude of the body. Smaller values are brighter. | +| [phaseAngle](phase-angle.md)
val [phaseAngle](phase-angle.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
The angle in degrees between the Sun and the Earth, as seen from the body. Indicates the body's phase as seen from the Earth. | +| [phaseFraction](phase-fraction.md)
val [phaseFraction](phase-fraction.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
A value in the range 0.0, 1.0 indicating what fraction of the body's apparent disc is illuminated, as seen from the Earth. | +| [ringTilt](ring-tilt.md)
val [ringTilt](ring-tilt.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
For Saturn, the tilt angle in degrees of its rings as seen from Earth. For all other bodies, 0.0. | | [time](time.md)
val [time](time.md): [Time](../-time/index.md)
The date and time of the observation. | diff --git a/source/kotlin/doc/-illumination-info/mag.md b/source/kotlin/doc/-illumination-info/mag.md index b78080dd..c04a422c 100644 --- a/source/kotlin/doc/-illumination-info/mag.md +++ b/source/kotlin/doc/-illumination-info/mag.md @@ -2,6 +2,6 @@ # mag -val [mag](mag.md): Double +val [mag](mag.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) The visual magnitude of the body. Smaller values are brighter. diff --git a/source/kotlin/doc/-illumination-info/phase-angle.md b/source/kotlin/doc/-illumination-info/phase-angle.md index 234904a1..5a46f813 100644 --- a/source/kotlin/doc/-illumination-info/phase-angle.md +++ b/source/kotlin/doc/-illumination-info/phase-angle.md @@ -2,6 +2,6 @@ # phaseAngle -val [phaseAngle](phase-angle.md): Double +val [phaseAngle](phase-angle.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) The angle in degrees between the Sun and the Earth, as seen from the body. Indicates the body's phase as seen from the Earth. diff --git a/source/kotlin/doc/-illumination-info/phase-fraction.md b/source/kotlin/doc/-illumination-info/phase-fraction.md index 787821b8..4541819a 100644 --- a/source/kotlin/doc/-illumination-info/phase-fraction.md +++ b/source/kotlin/doc/-illumination-info/phase-fraction.md @@ -2,6 +2,6 @@ # phaseFraction -val [phaseFraction](phase-fraction.md): Double +val [phaseFraction](phase-fraction.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) A value in the range 0.0, 1.0 indicating what fraction of the body's apparent disc is illuminated, as seen from the Earth. diff --git a/source/kotlin/doc/-illumination-info/ring-tilt.md b/source/kotlin/doc/-illumination-info/ring-tilt.md index 353ae63e..e2942753 100644 --- a/source/kotlin/doc/-illumination-info/ring-tilt.md +++ b/source/kotlin/doc/-illumination-info/ring-tilt.md @@ -2,6 +2,6 @@ # ringTilt -val [ringTilt](ring-tilt.md): Double +val [ringTilt](ring-tilt.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) For Saturn, the tilt angle in degrees of its rings as seen from Earth. For all other bodies, 0.0. diff --git a/source/kotlin/doc/-internal-error/-internal-error.md b/source/kotlin/doc/-internal-error/-internal-error.md index 3a62787c..b107aa81 100644 --- a/source/kotlin/doc/-internal-error/-internal-error.md +++ b/source/kotlin/doc/-internal-error/-internal-error.md @@ -2,4 +2,4 @@ # InternalError -fun [InternalError](-internal-error.md)(message: String) +fun [InternalError](-internal-error.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) diff --git a/source/kotlin/doc/-internal-error/index.md b/source/kotlin/doc/-internal-error/index.md index d6efb23e..9e937402 100644 --- a/source/kotlin/doc/-internal-error/index.md +++ b/source/kotlin/doc/-internal-error/index.md @@ -2,7 +2,7 @@ # InternalError -class [InternalError](index.md)(message: String) : Exception +class [InternalError](index.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) : [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) An unexpected internal error occurred in Astronomy Engine @@ -10,24 +10,24 @@ An unexpected internal error occurred in Astronomy Engine | | | |---|---| -| [InternalError](-internal-error.md)
fun [InternalError](-internal-error.md)(message: String) | +| [InternalError](-internal-error.md)
fun [InternalError](-internal-error.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) | ## Functions | Name | Summary | |---|---| -| [addSuppressed](index.md#282858770%2FFunctions%2F-1216412040)
fun [addSuppressed](index.md#282858770%2FFunctions%2F-1216412040)(p0: Throwable) | -| [fillInStackTrace](index.md#-1102069925%2FFunctions%2F-1216412040)
open fun [fillInStackTrace](index.md#-1102069925%2FFunctions%2F-1216412040)(): Throwable | -| [getLocalizedMessage](index.md#1043865560%2FFunctions%2F-1216412040)
open fun [getLocalizedMessage](index.md#1043865560%2FFunctions%2F-1216412040)(): String | -| [getStackTrace](index.md#2050903719%2FFunctions%2F-1216412040)
open fun [getStackTrace](index.md#2050903719%2FFunctions%2F-1216412040)(): Array<StackTraceElement> | -| [getSuppressed](index.md#672492560%2FFunctions%2F-1216412040)
fun [getSuppressed](index.md#672492560%2FFunctions%2F-1216412040)(): Array<Throwable> | -| [initCause](index.md#-418225042%2FFunctions%2F-1216412040)
open fun [initCause](index.md#-418225042%2FFunctions%2F-1216412040)(p0: Throwable): Throwable | -| [printStackTrace](index.md#-1769529168%2FFunctions%2F-1216412040)
open fun [printStackTrace](index.md#-1769529168%2FFunctions%2F-1216412040)()
open fun [printStackTrace](index.md#1841853697%2FFunctions%2F-1216412040)(p0: PrintStream)
open fun [printStackTrace](index.md#1175535278%2FFunctions%2F-1216412040)(p0: PrintWriter) | -| [setStackTrace](index.md#2135801318%2FFunctions%2F-1216412040)
open fun [setStackTrace](index.md#2135801318%2FFunctions%2F-1216412040)(p0: Array<StackTraceElement>) | +| [addSuppressed](index.md#282858770%2FFunctions%2F-1216412040)
fun [addSuppressed](index.md#282858770%2FFunctions%2F-1216412040)(p0: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)) | +| [fillInStackTrace](index.md#-1102069925%2FFunctions%2F-1216412040)
open fun [fillInStackTrace](index.md#-1102069925%2FFunctions%2F-1216412040)(): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html) | +| [getLocalizedMessage](index.md#1043865560%2FFunctions%2F-1216412040)
open fun [getLocalizedMessage](index.md#1043865560%2FFunctions%2F-1216412040)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [getStackTrace](index.md#2050903719%2FFunctions%2F-1216412040)
open fun [getStackTrace](index.md#2050903719%2FFunctions%2F-1216412040)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[StackTraceElement](https://docs.oracle.com/javase/8/docs/api/java/lang/StackTraceElement.html)> | +| [getSuppressed](index.md#672492560%2FFunctions%2F-1216412040)
fun [getSuppressed](index.md#672492560%2FFunctions%2F-1216412040)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)> | +| [initCause](index.md#-418225042%2FFunctions%2F-1216412040)
open fun [initCause](index.md#-418225042%2FFunctions%2F-1216412040)(p0: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html) | +| [printStackTrace](index.md#-1769529168%2FFunctions%2F-1216412040)
open fun [printStackTrace](index.md#-1769529168%2FFunctions%2F-1216412040)()
open fun [printStackTrace](index.md#1841853697%2FFunctions%2F-1216412040)(p0: [PrintStream](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html))
open fun [printStackTrace](index.md#1175535278%2FFunctions%2F-1216412040)(p0: [PrintWriter](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html)) | +| [setStackTrace](index.md#2135801318%2FFunctions%2F-1216412040)
open fun [setStackTrace](index.md#2135801318%2FFunctions%2F-1216412040)(p0: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[StackTraceElement](https://docs.oracle.com/javase/8/docs/api/java/lang/StackTraceElement.html)>) | ## Properties | Name | Summary | |---|---| -| [cause](index.md#-654012527%2FProperties%2F-1216412040)
open val [cause](index.md#-654012527%2FProperties%2F-1216412040): Throwable? | -| [message](index.md#1824300659%2FProperties%2F-1216412040)
open val [message](index.md#1824300659%2FProperties%2F-1216412040): String? | +| [cause](index.md#-654012527%2FProperties%2F-1216412040)
open val [cause](index.md#-654012527%2FProperties%2F-1216412040): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? | +| [message](index.md#1824300659%2FProperties%2F-1216412040)
open val [message](index.md#1824300659%2FProperties%2F-1216412040): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? | diff --git a/source/kotlin/doc/-invalid-body-exception/index.md b/source/kotlin/doc/-invalid-body-exception/index.md index d3533034..0907e701 100644 --- a/source/kotlin/doc/-invalid-body-exception/index.md +++ b/source/kotlin/doc/-invalid-body-exception/index.md @@ -2,7 +2,7 @@ # InvalidBodyException -class [InvalidBodyException](index.md)(body: [Body](../-body/index.md)) : Exception +class [InvalidBodyException](index.md)(body: [Body](../-body/index.md)) : [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) An invalid body was specified for the given function. @@ -16,18 +16,18 @@ An invalid body was specified for the given function. | Name | Summary | |---|---| -| [addSuppressed](../-internal-error/index.md#282858770%2FFunctions%2F-1216412040)
fun [addSuppressed](../-internal-error/index.md#282858770%2FFunctions%2F-1216412040)(p0: Throwable) | -| [fillInStackTrace](../-internal-error/index.md#-1102069925%2FFunctions%2F-1216412040)
open fun [fillInStackTrace](../-internal-error/index.md#-1102069925%2FFunctions%2F-1216412040)(): Throwable | -| [getLocalizedMessage](../-internal-error/index.md#1043865560%2FFunctions%2F-1216412040)
open fun [getLocalizedMessage](../-internal-error/index.md#1043865560%2FFunctions%2F-1216412040)(): String | -| [getStackTrace](../-internal-error/index.md#2050903719%2FFunctions%2F-1216412040)
open fun [getStackTrace](../-internal-error/index.md#2050903719%2FFunctions%2F-1216412040)(): Array<StackTraceElement> | -| [getSuppressed](../-internal-error/index.md#672492560%2FFunctions%2F-1216412040)
fun [getSuppressed](../-internal-error/index.md#672492560%2FFunctions%2F-1216412040)(): Array<Throwable> | -| [initCause](../-internal-error/index.md#-418225042%2FFunctions%2F-1216412040)
open fun [initCause](../-internal-error/index.md#-418225042%2FFunctions%2F-1216412040)(p0: Throwable): Throwable | -| [printStackTrace](../-internal-error/index.md#-1769529168%2FFunctions%2F-1216412040)
open fun [printStackTrace](../-internal-error/index.md#-1769529168%2FFunctions%2F-1216412040)()
open fun [printStackTrace](../-internal-error/index.md#1841853697%2FFunctions%2F-1216412040)(p0: PrintStream)
open fun [printStackTrace](../-internal-error/index.md#1175535278%2FFunctions%2F-1216412040)(p0: PrintWriter) | -| [setStackTrace](../-internal-error/index.md#2135801318%2FFunctions%2F-1216412040)
open fun [setStackTrace](../-internal-error/index.md#2135801318%2FFunctions%2F-1216412040)(p0: Array<StackTraceElement>) | +| [addSuppressed](../-internal-error/index.md#282858770%2FFunctions%2F-1216412040)
fun [addSuppressed](../-internal-error/index.md#282858770%2FFunctions%2F-1216412040)(p0: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)) | +| [fillInStackTrace](../-internal-error/index.md#-1102069925%2FFunctions%2F-1216412040)
open fun [fillInStackTrace](../-internal-error/index.md#-1102069925%2FFunctions%2F-1216412040)(): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html) | +| [getLocalizedMessage](../-internal-error/index.md#1043865560%2FFunctions%2F-1216412040)
open fun [getLocalizedMessage](../-internal-error/index.md#1043865560%2FFunctions%2F-1216412040)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [getStackTrace](../-internal-error/index.md#2050903719%2FFunctions%2F-1216412040)
open fun [getStackTrace](../-internal-error/index.md#2050903719%2FFunctions%2F-1216412040)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[StackTraceElement](https://docs.oracle.com/javase/8/docs/api/java/lang/StackTraceElement.html)> | +| [getSuppressed](../-internal-error/index.md#672492560%2FFunctions%2F-1216412040)
fun [getSuppressed](../-internal-error/index.md#672492560%2FFunctions%2F-1216412040)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)> | +| [initCause](../-internal-error/index.md#-418225042%2FFunctions%2F-1216412040)
open fun [initCause](../-internal-error/index.md#-418225042%2FFunctions%2F-1216412040)(p0: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html) | +| [printStackTrace](../-internal-error/index.md#-1769529168%2FFunctions%2F-1216412040)
open fun [printStackTrace](../-internal-error/index.md#-1769529168%2FFunctions%2F-1216412040)()
open fun [printStackTrace](../-internal-error/index.md#1841853697%2FFunctions%2F-1216412040)(p0: [PrintStream](https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html))
open fun [printStackTrace](../-internal-error/index.md#1175535278%2FFunctions%2F-1216412040)(p0: [PrintWriter](https://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html)) | +| [setStackTrace](../-internal-error/index.md#2135801318%2FFunctions%2F-1216412040)
open fun [setStackTrace](../-internal-error/index.md#2135801318%2FFunctions%2F-1216412040)(p0: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[StackTraceElement](https://docs.oracle.com/javase/8/docs/api/java/lang/StackTraceElement.html)>) | ## Properties | Name | Summary | |---|---| -| [cause](../-internal-error/index.md#-654012527%2FProperties%2F-1216412040)
open val [cause](../-internal-error/index.md#-654012527%2FProperties%2F-1216412040): Throwable? | -| [message](../-internal-error/index.md#1824300659%2FProperties%2F-1216412040)
open val [message](../-internal-error/index.md#1824300659%2FProperties%2F-1216412040): String? | +| [cause](../-internal-error/index.md#-654012527%2FProperties%2F-1216412040)
open val [cause](../-internal-error/index.md#-654012527%2FProperties%2F-1216412040): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? | +| [message](../-internal-error/index.md#1824300659%2FProperties%2F-1216412040)
open val [message](../-internal-error/index.md#1824300659%2FProperties%2F-1216412040): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? | diff --git a/source/kotlin/doc/-j-u-p-i-t-e-r_-e-q-u-a-t-o-r-i-a-l_-r-a-d-i-u-s_-k-m.md b/source/kotlin/doc/-j-u-p-i-t-e-r_-e-q-u-a-t-o-r-i-a-l_-r-a-d-i-u-s_-k-m.md index 81854d7a..f8f1f116 100644 --- a/source/kotlin/doc/-j-u-p-i-t-e-r_-e-q-u-a-t-o-r-i-a-l_-r-a-d-i-u-s_-k-m.md +++ b/source/kotlin/doc/-j-u-p-i-t-e-r_-e-q-u-a-t-o-r-i-a-l_-r-a-d-i-u-s_-k-m.md @@ -2,6 +2,6 @@ # JUPITER_EQUATORIAL_RADIUS_KM -const val [JUPITER_EQUATORIAL_RADIUS_KM](-j-u-p-i-t-e-r_-e-q-u-a-t-o-r-i-a-l_-r-a-d-i-u-s_-k-m.md): Double = 71492.0 +const val [JUPITER_EQUATORIAL_RADIUS_KM](-j-u-p-i-t-e-r_-e-q-u-a-t-o-r-i-a-l_-r-a-d-i-u-s_-k-m.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) = 71492.0 The equatorial radius of Jupiter, expressed in kilometers. diff --git a/source/kotlin/doc/-j-u-p-i-t-e-r_-m-e-a-n_-r-a-d-i-u-s_-k-m.md b/source/kotlin/doc/-j-u-p-i-t-e-r_-m-e-a-n_-r-a-d-i-u-s_-k-m.md index c5686e88..3859169f 100644 --- a/source/kotlin/doc/-j-u-p-i-t-e-r_-m-e-a-n_-r-a-d-i-u-s_-k-m.md +++ b/source/kotlin/doc/-j-u-p-i-t-e-r_-m-e-a-n_-r-a-d-i-u-s_-k-m.md @@ -2,6 +2,6 @@ # JUPITER_MEAN_RADIUS_KM -const val [JUPITER_MEAN_RADIUS_KM](-j-u-p-i-t-e-r_-m-e-a-n_-r-a-d-i-u-s_-k-m.md): Double = 69911.0 +const val [JUPITER_MEAN_RADIUS_KM](-j-u-p-i-t-e-r_-m-e-a-n_-r-a-d-i-u-s_-k-m.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) = 69911.0 The volumetric mean radius of Jupiter, expressed in kilometers. diff --git a/source/kotlin/doc/-j-u-p-i-t-e-r_-p-o-l-a-r_-r-a-d-i-u-s_-k-m.md b/source/kotlin/doc/-j-u-p-i-t-e-r_-p-o-l-a-r_-r-a-d-i-u-s_-k-m.md index 22fb9646..9dddb3e1 100644 --- a/source/kotlin/doc/-j-u-p-i-t-e-r_-p-o-l-a-r_-r-a-d-i-u-s_-k-m.md +++ b/source/kotlin/doc/-j-u-p-i-t-e-r_-p-o-l-a-r_-r-a-d-i-u-s_-k-m.md @@ -2,6 +2,6 @@ # JUPITER_POLAR_RADIUS_KM -const val [JUPITER_POLAR_RADIUS_KM](-j-u-p-i-t-e-r_-p-o-l-a-r_-r-a-d-i-u-s_-k-m.md): Double = 66854.0 +const val [JUPITER_POLAR_RADIUS_KM](-j-u-p-i-t-e-r_-p-o-l-a-r_-r-a-d-i-u-s_-k-m.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) = 66854.0 The polar radius of Jupiter, expressed in kilometers. diff --git a/source/kotlin/doc/-k-m_-p-e-r_-a-u.md b/source/kotlin/doc/-k-m_-p-e-r_-a-u.md index 3263d417..ee496d2d 100644 --- a/source/kotlin/doc/-k-m_-p-e-r_-a-u.md +++ b/source/kotlin/doc/-k-m_-p-e-r_-a-u.md @@ -2,6 +2,6 @@ # KM_PER_AU -const val [KM_PER_AU](-k-m_-p-e-r_-a-u.md): Double = 1.4959787069098932E8 +const val [KM_PER_AU](-k-m_-p-e-r_-a-u.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) = 1.4959787069098932E8 The number of kilometers in one astronomical unit (AU). diff --git a/source/kotlin/doc/-libration-info/-libration-info.md b/source/kotlin/doc/-libration-info/-libration-info.md index e7caaea5..054cbcfa 100644 --- a/source/kotlin/doc/-libration-info/-libration-info.md +++ b/source/kotlin/doc/-libration-info/-libration-info.md @@ -2,4 +2,4 @@ # LibrationInfo -fun [LibrationInfo](-libration-info.md)(elat: Double, elon: Double, mlat: Double, mlon: Double, distanceKm: Double, diamDeg: Double) +fun [LibrationInfo](-libration-info.md)(elat: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), elon: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), mlat: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), mlon: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), distanceKm: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), diamDeg: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) diff --git a/source/kotlin/doc/-libration-info/diam-deg.md b/source/kotlin/doc/-libration-info/diam-deg.md index 9f2b344b..e3d398b0 100644 --- a/source/kotlin/doc/-libration-info/diam-deg.md +++ b/source/kotlin/doc/-libration-info/diam-deg.md @@ -2,6 +2,6 @@ # diamDeg -val [diamDeg](diam-deg.md): Double +val [diamDeg](diam-deg.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) The apparent angular diameter of the Moon, in degrees, as seen from the center of the Earth. diff --git a/source/kotlin/doc/-libration-info/distance-km.md b/source/kotlin/doc/-libration-info/distance-km.md index 9d32053e..5db12b0a 100644 --- a/source/kotlin/doc/-libration-info/distance-km.md +++ b/source/kotlin/doc/-libration-info/distance-km.md @@ -2,6 +2,6 @@ # distanceKm -val [distanceKm](distance-km.md): Double +val [distanceKm](distance-km.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) Distance between the centers of the Earth and Moon in kilometers. diff --git a/source/kotlin/doc/-libration-info/elat.md b/source/kotlin/doc/-libration-info/elat.md index c9c5736c..9020a1aa 100644 --- a/source/kotlin/doc/-libration-info/elat.md +++ b/source/kotlin/doc/-libration-info/elat.md @@ -2,6 +2,6 @@ # elat -val [elat](elat.md): Double +val [elat](elat.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) Sub-Earth libration ecliptic latitude angle, in degrees. diff --git a/source/kotlin/doc/-libration-info/elon.md b/source/kotlin/doc/-libration-info/elon.md index 10ca7012..6eb07887 100644 --- a/source/kotlin/doc/-libration-info/elon.md +++ b/source/kotlin/doc/-libration-info/elon.md @@ -2,6 +2,6 @@ # elon -val [elon](elon.md): Double +val [elon](elon.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) Sub-Earth libration ecliptic longitude angle, in degrees. diff --git a/source/kotlin/doc/-libration-info/index.md b/source/kotlin/doc/-libration-info/index.md index c3db1f44..8923ab55 100644 --- a/source/kotlin/doc/-libration-info/index.md +++ b/source/kotlin/doc/-libration-info/index.md @@ -2,7 +2,7 @@ # LibrationInfo -data class [LibrationInfo](index.md)(elat: Double, elon: Double, mlat: Double, mlon: Double, distanceKm: Double, diamDeg: Double) +data class [LibrationInfo](index.md)(elat: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), elon: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), mlat: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), mlon: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), distanceKm: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), diamDeg: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) Lunar libration angles, returned by [libration](../libration.md). @@ -10,15 +10,15 @@ Lunar libration angles, returned by [libration](../libration.md). | | | |---|---| -| [LibrationInfo](-libration-info.md)
fun [LibrationInfo](-libration-info.md)(elat: Double, elon: Double, mlat: Double, mlon: Double, distanceKm: Double, diamDeg: Double) | +| [LibrationInfo](-libration-info.md)
fun [LibrationInfo](-libration-info.md)(elat: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), elon: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), mlat: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), mlon: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), distanceKm: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), diamDeg: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) | ## Properties | Name | Summary | |---|---| -| [diamDeg](diam-deg.md)
val [diamDeg](diam-deg.md): Double
The apparent angular diameter of the Moon, in degrees, as seen from the center of the Earth. | -| [distanceKm](distance-km.md)
val [distanceKm](distance-km.md): Double
Distance between the centers of the Earth and Moon in kilometers. | -| [elat](elat.md)
val [elat](elat.md): Double
Sub-Earth libration ecliptic latitude angle, in degrees. | -| [elon](elon.md)
val [elon](elon.md): Double
Sub-Earth libration ecliptic longitude angle, in degrees. | -| [mlat](mlat.md)
val [mlat](mlat.md): Double
Moon's geocentric ecliptic latitude. | -| [mlon](mlon.md)
val [mlon](mlon.md): Double
Moon's geocentric ecliptic longitude. | +| [diamDeg](diam-deg.md)
val [diamDeg](diam-deg.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
The apparent angular diameter of the Moon, in degrees, as seen from the center of the Earth. | +| [distanceKm](distance-km.md)
val [distanceKm](distance-km.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Distance between the centers of the Earth and Moon in kilometers. | +| [elat](elat.md)
val [elat](elat.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Sub-Earth libration ecliptic latitude angle, in degrees. | +| [elon](elon.md)
val [elon](elon.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Sub-Earth libration ecliptic longitude angle, in degrees. | +| [mlat](mlat.md)
val [mlat](mlat.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Moon's geocentric ecliptic latitude. | +| [mlon](mlon.md)
val [mlon](mlon.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Moon's geocentric ecliptic longitude. | diff --git a/source/kotlin/doc/-libration-info/mlat.md b/source/kotlin/doc/-libration-info/mlat.md index b2593cca..2971b7ba 100644 --- a/source/kotlin/doc/-libration-info/mlat.md +++ b/source/kotlin/doc/-libration-info/mlat.md @@ -2,6 +2,6 @@ # mlat -val [mlat](mlat.md): Double +val [mlat](mlat.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) Moon's geocentric ecliptic latitude. diff --git a/source/kotlin/doc/-libration-info/mlon.md b/source/kotlin/doc/-libration-info/mlon.md index 54a9ecf5..8d19c7d6 100644 --- a/source/kotlin/doc/-libration-info/mlon.md +++ b/source/kotlin/doc/-libration-info/mlon.md @@ -2,6 +2,6 @@ # mlon -val [mlon](mlon.md): Double +val [mlon](mlon.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) Moon's geocentric ecliptic longitude. diff --git a/source/kotlin/doc/-local-solar-eclipse-info/-local-solar-eclipse-info.md b/source/kotlin/doc/-local-solar-eclipse-info/-local-solar-eclipse-info.md index 94ef74de..da7a4e2b 100644 --- a/source/kotlin/doc/-local-solar-eclipse-info/-local-solar-eclipse-info.md +++ b/source/kotlin/doc/-local-solar-eclipse-info/-local-solar-eclipse-info.md @@ -2,4 +2,4 @@ # LocalSolarEclipseInfo -fun [LocalSolarEclipseInfo](-local-solar-eclipse-info.md)(kind: [EclipseKind](../-eclipse-kind/index.md), obscuration: Double, partialBegin: [EclipseEvent](../-eclipse-event/index.md), totalBegin: [EclipseEvent](../-eclipse-event/index.md)?, peak: [EclipseEvent](../-eclipse-event/index.md), totalEnd: [EclipseEvent](../-eclipse-event/index.md)?, partialEnd: [EclipseEvent](../-eclipse-event/index.md)) +fun [LocalSolarEclipseInfo](-local-solar-eclipse-info.md)(kind: [EclipseKind](../-eclipse-kind/index.md), obscuration: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), partialBegin: [EclipseEvent](../-eclipse-event/index.md), totalBegin: [EclipseEvent](../-eclipse-event/index.md)?, peak: [EclipseEvent](../-eclipse-event/index.md), totalEnd: [EclipseEvent](../-eclipse-event/index.md)?, partialEnd: [EclipseEvent](../-eclipse-event/index.md)) diff --git a/source/kotlin/doc/-local-solar-eclipse-info/index.md b/source/kotlin/doc/-local-solar-eclipse-info/index.md index 9a4cfda5..7d0060df 100644 --- a/source/kotlin/doc/-local-solar-eclipse-info/index.md +++ b/source/kotlin/doc/-local-solar-eclipse-info/index.md @@ -2,7 +2,7 @@ # LocalSolarEclipseInfo -class [LocalSolarEclipseInfo](index.md)(kind: [EclipseKind](../-eclipse-kind/index.md), obscuration: Double, partialBegin: [EclipseEvent](../-eclipse-event/index.md), totalBegin: [EclipseEvent](../-eclipse-event/index.md)?, peak: [EclipseEvent](../-eclipse-event/index.md), totalEnd: [EclipseEvent](../-eclipse-event/index.md)?, partialEnd: [EclipseEvent](../-eclipse-event/index.md)) +class [LocalSolarEclipseInfo](index.md)(kind: [EclipseKind](../-eclipse-kind/index.md), obscuration: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), partialBegin: [EclipseEvent](../-eclipse-event/index.md), totalBegin: [EclipseEvent](../-eclipse-event/index.md)?, peak: [EclipseEvent](../-eclipse-event/index.md), totalEnd: [EclipseEvent](../-eclipse-event/index.md)?, partialEnd: [EclipseEvent](../-eclipse-event/index.md)) Information about a solar eclipse as seen by an observer at a given time and geographic location. @@ -18,14 +18,14 @@ There are 5 "event" fields, each of which contains a time and a solar altitude. | | | |---|---| -| [LocalSolarEclipseInfo](-local-solar-eclipse-info.md)
fun [LocalSolarEclipseInfo](-local-solar-eclipse-info.md)(kind: [EclipseKind](../-eclipse-kind/index.md), obscuration: Double, partialBegin: [EclipseEvent](../-eclipse-event/index.md), totalBegin: [EclipseEvent](../-eclipse-event/index.md)?, peak: [EclipseEvent](../-eclipse-event/index.md), totalEnd: [EclipseEvent](../-eclipse-event/index.md)?, partialEnd: [EclipseEvent](../-eclipse-event/index.md)) | +| [LocalSolarEclipseInfo](-local-solar-eclipse-info.md)
fun [LocalSolarEclipseInfo](-local-solar-eclipse-info.md)(kind: [EclipseKind](../-eclipse-kind/index.md), obscuration: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), partialBegin: [EclipseEvent](../-eclipse-event/index.md), totalBegin: [EclipseEvent](../-eclipse-event/index.md)?, peak: [EclipseEvent](../-eclipse-event/index.md), totalEnd: [EclipseEvent](../-eclipse-event/index.md)?, partialEnd: [EclipseEvent](../-eclipse-event/index.md)) | ## Properties | Name | Summary | |---|---| | [kind](kind.md)
val [kind](kind.md): [EclipseKind](../-eclipse-kind/index.md)
The type of solar eclipse: EclipseKind.Partial, EclipseKind.Annular, or EclipseKind.Total. | -| [obscuration](obscuration.md)
val [obscuration](obscuration.md): Double
The fraction of the Sun's apparent disc area obscured by the Moon at the eclipse peak. | +| [obscuration](obscuration.md)
val [obscuration](obscuration.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
The fraction of the Sun's apparent disc area obscured by the Moon at the eclipse peak. | | [partialBegin](partial-begin.md)
val [partialBegin](partial-begin.md): [EclipseEvent](../-eclipse-event/index.md)
The time and Sun altitude at the beginning of the eclipse. | | [partialEnd](partial-end.md)
val [partialEnd](partial-end.md): [EclipseEvent](../-eclipse-event/index.md)
The time and Sun altitude at the end of the eclipse. | | [peak](peak.md)
val [peak](peak.md): [EclipseEvent](../-eclipse-event/index.md)
The time and Sun altitude when the eclipse reaches its peak. | diff --git a/source/kotlin/doc/-local-solar-eclipse-info/obscuration.md b/source/kotlin/doc/-local-solar-eclipse-info/obscuration.md index a8b13a87..f2d6ac4d 100644 --- a/source/kotlin/doc/-local-solar-eclipse-info/obscuration.md +++ b/source/kotlin/doc/-local-solar-eclipse-info/obscuration.md @@ -2,6 +2,6 @@ # obscuration -val [obscuration](obscuration.md): Double +val [obscuration](obscuration.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) The fraction of the Sun's apparent disc area obscured by the Moon at the eclipse peak. diff --git a/source/kotlin/doc/-lunar-eclipse-info/-lunar-eclipse-info.md b/source/kotlin/doc/-lunar-eclipse-info/-lunar-eclipse-info.md index e6e2cd7e..ff46110f 100644 --- a/source/kotlin/doc/-lunar-eclipse-info/-lunar-eclipse-info.md +++ b/source/kotlin/doc/-lunar-eclipse-info/-lunar-eclipse-info.md @@ -2,4 +2,4 @@ # LunarEclipseInfo -fun [LunarEclipseInfo](-lunar-eclipse-info.md)(kind: [EclipseKind](../-eclipse-kind/index.md), obscuration: Double, peak: [Time](../-time/index.md), sdPenum: Double, sdPartial: Double, sdTotal: Double) +fun [LunarEclipseInfo](-lunar-eclipse-info.md)(kind: [EclipseKind](../-eclipse-kind/index.md), obscuration: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), peak: [Time](../-time/index.md), sdPenum: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), sdPartial: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), sdTotal: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) diff --git a/source/kotlin/doc/-lunar-eclipse-info/index.md b/source/kotlin/doc/-lunar-eclipse-info/index.md index 12c3647e..001c5901 100644 --- a/source/kotlin/doc/-lunar-eclipse-info/index.md +++ b/source/kotlin/doc/-lunar-eclipse-info/index.md @@ -2,7 +2,7 @@ # LunarEclipseInfo -class [LunarEclipseInfo](index.md)(kind: [EclipseKind](../-eclipse-kind/index.md), obscuration: Double, peak: [Time](../-time/index.md), sdPenum: Double, sdPartial: Double, sdTotal: Double) +class [LunarEclipseInfo](index.md)(kind: [EclipseKind](../-eclipse-kind/index.md), obscuration: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), peak: [Time](../-time/index.md), sdPenum: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), sdPartial: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), sdTotal: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) Information about a lunar eclipse. @@ -20,15 +20,15 @@ Fields sdPenum, sdPartial, and sdTotal hold the semi-duration of each phase of t | | | |---|---| -| [LunarEclipseInfo](-lunar-eclipse-info.md)
fun [LunarEclipseInfo](-lunar-eclipse-info.md)(kind: [EclipseKind](../-eclipse-kind/index.md), obscuration: Double, peak: [Time](../-time/index.md), sdPenum: Double, sdPartial: Double, sdTotal: Double) | +| [LunarEclipseInfo](-lunar-eclipse-info.md)
fun [LunarEclipseInfo](-lunar-eclipse-info.md)(kind: [EclipseKind](../-eclipse-kind/index.md), obscuration: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), peak: [Time](../-time/index.md), sdPenum: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), sdPartial: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), sdTotal: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) | ## Properties | Name | Summary | |---|---| | [kind](kind.md)
val [kind](kind.md): [EclipseKind](../-eclipse-kind/index.md)
The type of lunar eclipse found. | -| [obscuration](obscuration.md)
val [obscuration](obscuration.md): Double
The peak fraction of the Moon's apparent disc that is covered by the Earth's umbra. | +| [obscuration](obscuration.md)
val [obscuration](obscuration.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
The peak fraction of the Moon's apparent disc that is covered by the Earth's umbra. | | [peak](peak.md)
val [peak](peak.md): [Time](../-time/index.md)
The time of the eclipse at its peak. | -| [sdPartial](sd-partial.md)
val [sdPartial](sd-partial.md): Double
The semi-duration of the partial phase in minutes, or 0.0 if none. | -| [sdPenum](sd-penum.md)
val [sdPenum](sd-penum.md): Double
The semi-duration of the penumbral phase in minutes. | -| [sdTotal](sd-total.md)
val [sdTotal](sd-total.md): Double
The semi-duration of the total phase in minutes, or 0.0 if none. | +| [sdPartial](sd-partial.md)
val [sdPartial](sd-partial.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
The semi-duration of the partial phase in minutes, or 0.0 if none. | +| [sdPenum](sd-penum.md)
val [sdPenum](sd-penum.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
The semi-duration of the penumbral phase in minutes. | +| [sdTotal](sd-total.md)
val [sdTotal](sd-total.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
The semi-duration of the total phase in minutes, or 0.0 if none. | diff --git a/source/kotlin/doc/-lunar-eclipse-info/obscuration.md b/source/kotlin/doc/-lunar-eclipse-info/obscuration.md index ac68ffe3..64a37e1a 100644 --- a/source/kotlin/doc/-lunar-eclipse-info/obscuration.md +++ b/source/kotlin/doc/-lunar-eclipse-info/obscuration.md @@ -2,6 +2,6 @@ # obscuration -val [obscuration](obscuration.md): Double +val [obscuration](obscuration.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) The peak fraction of the Moon's apparent disc that is covered by the Earth's umbra. diff --git a/source/kotlin/doc/-lunar-eclipse-info/sd-partial.md b/source/kotlin/doc/-lunar-eclipse-info/sd-partial.md index 199a0185..5fdfdbab 100644 --- a/source/kotlin/doc/-lunar-eclipse-info/sd-partial.md +++ b/source/kotlin/doc/-lunar-eclipse-info/sd-partial.md @@ -2,6 +2,6 @@ # sdPartial -val [sdPartial](sd-partial.md): Double +val [sdPartial](sd-partial.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) The semi-duration of the partial phase in minutes, or 0.0 if none. diff --git a/source/kotlin/doc/-lunar-eclipse-info/sd-penum.md b/source/kotlin/doc/-lunar-eclipse-info/sd-penum.md index e4402360..aa6e7bb6 100644 --- a/source/kotlin/doc/-lunar-eclipse-info/sd-penum.md +++ b/source/kotlin/doc/-lunar-eclipse-info/sd-penum.md @@ -2,6 +2,6 @@ # sdPenum -val [sdPenum](sd-penum.md): Double +val [sdPenum](sd-penum.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) The semi-duration of the penumbral phase in minutes. diff --git a/source/kotlin/doc/-lunar-eclipse-info/sd-total.md b/source/kotlin/doc/-lunar-eclipse-info/sd-total.md index ab0eb6ec..47c4482d 100644 --- a/source/kotlin/doc/-lunar-eclipse-info/sd-total.md +++ b/source/kotlin/doc/-lunar-eclipse-info/sd-total.md @@ -2,6 +2,6 @@ # sdTotal -val [sdTotal](sd-total.md): Double +val [sdTotal](sd-total.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) The semi-duration of the total phase in minutes, or 0.0 if none. diff --git a/source/kotlin/doc/-m-i-l-l-i-s-e-c-o-n-d-s_-p-e-r_-d-a-y.md b/source/kotlin/doc/-m-i-l-l-i-s-e-c-o-n-d-s_-p-e-r_-d-a-y.md index 5698c21b..74fc7214 100644 --- a/source/kotlin/doc/-m-i-l-l-i-s-e-c-o-n-d-s_-p-e-r_-d-a-y.md +++ b/source/kotlin/doc/-m-i-l-l-i-s-e-c-o-n-d-s_-p-e-r_-d-a-y.md @@ -2,6 +2,6 @@ # MILLISECONDS_PER_DAY -const val [MILLISECONDS_PER_DAY](-m-i-l-l-i-s-e-c-o-n-d-s_-p-e-r_-d-a-y.md): Double +const val [MILLISECONDS_PER_DAY](-m-i-l-l-i-s-e-c-o-n-d-s_-p-e-r_-d-a-y.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) The number of milliseconds in a day. diff --git a/source/kotlin/doc/-m-i-n-u-t-e-s_-p-e-r_-d-a-y.md b/source/kotlin/doc/-m-i-n-u-t-e-s_-p-e-r_-d-a-y.md index 3de38c4e..3bfd4274 100644 --- a/source/kotlin/doc/-m-i-n-u-t-e-s_-p-e-r_-d-a-y.md +++ b/source/kotlin/doc/-m-i-n-u-t-e-s_-p-e-r_-d-a-y.md @@ -2,6 +2,6 @@ # MINUTES_PER_DAY -const val [MINUTES_PER_DAY](-m-i-n-u-t-e-s_-p-e-r_-d-a-y.md): Double +const val [MINUTES_PER_DAY](-m-i-n-u-t-e-s_-p-e-r_-d-a-y.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) The number of minutes in a day. diff --git a/source/kotlin/doc/-moon-quarter-info/-moon-quarter-info.md b/source/kotlin/doc/-moon-quarter-info/-moon-quarter-info.md index 716d8681..c3682b0e 100644 --- a/source/kotlin/doc/-moon-quarter-info/-moon-quarter-info.md +++ b/source/kotlin/doc/-moon-quarter-info/-moon-quarter-info.md @@ -2,4 +2,4 @@ # MoonQuarterInfo -fun [MoonQuarterInfo](-moon-quarter-info.md)(quarter: Int, time: [Time](../-time/index.md)) +fun [MoonQuarterInfo](-moon-quarter-info.md)(quarter: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), time: [Time](../-time/index.md)) diff --git a/source/kotlin/doc/-moon-quarter-info/index.md b/source/kotlin/doc/-moon-quarter-info/index.md index 297647da..4504ebda 100644 --- a/source/kotlin/doc/-moon-quarter-info/index.md +++ b/source/kotlin/doc/-moon-quarter-info/index.md @@ -2,7 +2,7 @@ # MoonQuarterInfo -class [MoonQuarterInfo](index.md)(quarter: Int, time: [Time](../-time/index.md)) +class [MoonQuarterInfo](index.md)(quarter: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), time: [Time](../-time/index.md)) A lunar quarter event (new moon, first quarter, full moon, or third quarter) along with its date and time. @@ -10,11 +10,11 @@ A lunar quarter event (new moon, first quarter, full moon, or third quarter) alo | | | |---|---| -| [MoonQuarterInfo](-moon-quarter-info.md)
fun [MoonQuarterInfo](-moon-quarter-info.md)(quarter: Int, time: [Time](../-time/index.md)) | +| [MoonQuarterInfo](-moon-quarter-info.md)
fun [MoonQuarterInfo](-moon-quarter-info.md)(quarter: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), time: [Time](../-time/index.md)) | ## Properties | Name | Summary | |---|---| -| [quarter](quarter.md)
val [quarter](quarter.md): Int
0=new moon, 1=first quarter, 2=full moon, 3=third quarter. | +| [quarter](quarter.md)
val [quarter](quarter.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
0=new moon, 1=first quarter, 2=full moon, 3=third quarter. | | [time](time.md)
val [time](time.md): [Time](../-time/index.md)
The date and time of the lunar quarter. | diff --git a/source/kotlin/doc/-moon-quarter-info/quarter.md b/source/kotlin/doc/-moon-quarter-info/quarter.md index 2b81e280..4765666e 100644 --- a/source/kotlin/doc/-moon-quarter-info/quarter.md +++ b/source/kotlin/doc/-moon-quarter-info/quarter.md @@ -2,6 +2,6 @@ # quarter -val [quarter](quarter.md): Int +val [quarter](quarter.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) 0=new moon, 1=first quarter, 2=full moon, 3=third quarter. diff --git a/source/kotlin/doc/-node-event-kind/index.md b/source/kotlin/doc/-node-event-kind/index.md index be491bce..e9a266db 100644 --- a/source/kotlin/doc/-node-event-kind/index.md +++ b/source/kotlin/doc/-node-event-kind/index.md @@ -2,7 +2,7 @@ # NodeEventKind -enum [NodeEventKind](index.md) : Enum<[NodeEventKind](index.md)> +enum [NodeEventKind](index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[NodeEventKind](index.md)> Indicates whether a crossing through the ecliptic plane is ascending or descending. diff --git a/source/kotlin/doc/-observer/-observer.md b/source/kotlin/doc/-observer/-observer.md index b1dcfa48..e1dc2aca 100644 --- a/source/kotlin/doc/-observer/-observer.md +++ b/source/kotlin/doc/-observer/-observer.md @@ -2,4 +2,4 @@ # Observer -fun [Observer](-observer.md)(latitude: Double, longitude: Double, height: Double) +fun [Observer](-observer.md)(latitude: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), longitude: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), height: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) diff --git a/source/kotlin/doc/-observer/height.md b/source/kotlin/doc/-observer/height.md index 177d0eef..78c6420d 100644 --- a/source/kotlin/doc/-observer/height.md +++ b/source/kotlin/doc/-observer/height.md @@ -2,6 +2,6 @@ # height -val [height](height.md): Double +val [height](height.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) The height above (positive) or below (negative) sea level, expressed in meters. diff --git a/source/kotlin/doc/-observer/index.md b/source/kotlin/doc/-observer/index.md index 2b749788..1b38b782 100644 --- a/source/kotlin/doc/-observer/index.md +++ b/source/kotlin/doc/-observer/index.md @@ -2,7 +2,7 @@ # Observer -data class [Observer](index.md)(latitude: Double, longitude: Double, height: Double) +data class [Observer](index.md)(latitude: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), longitude: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), height: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) The location of an observer on (or near) the surface of the Earth. @@ -12,7 +12,7 @@ This object is passed to functions that calculate phenomena as observed from a p | | | |---|---| -| [Observer](-observer.md)
fun [Observer](-observer.md)(latitude: Double, longitude: Double, height: Double) | +| [Observer](-observer.md)
fun [Observer](-observer.md)(latitude: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), longitude: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), height: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) | ## Functions @@ -25,6 +25,6 @@ This object is passed to functions that calculate phenomena as observed from a p | Name | Summary | |---|---| -| [height](height.md)
val [height](height.md): Double
The height above (positive) or below (negative) sea level, expressed in meters. | -| [latitude](latitude.md)
val [latitude](latitude.md): Double
Geographic latitude in degrees north (positive) or south (negative) of the equator. | -| [longitude](longitude.md)
val [longitude](longitude.md): Double
Geographic longitude in degrees east (positive) or west (negative) of the prime meridian at Greenwich, England. | +| [height](height.md)
val [height](height.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
The height above (positive) or below (negative) sea level, expressed in meters. | +| [latitude](latitude.md)
val [latitude](latitude.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Geographic latitude in degrees north (positive) or south (negative) of the equator. | +| [longitude](longitude.md)
val [longitude](longitude.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Geographic longitude in degrees east (positive) or west (negative) of the prime meridian at Greenwich, England. | diff --git a/source/kotlin/doc/-observer/latitude.md b/source/kotlin/doc/-observer/latitude.md index b2a0a250..93d2e13d 100644 --- a/source/kotlin/doc/-observer/latitude.md +++ b/source/kotlin/doc/-observer/latitude.md @@ -2,6 +2,6 @@ # latitude -val [latitude](latitude.md): Double +val [latitude](latitude.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) Geographic latitude in degrees north (positive) or south (negative) of the equator. diff --git a/source/kotlin/doc/-observer/longitude.md b/source/kotlin/doc/-observer/longitude.md index 3daef1b0..06a4b422 100644 --- a/source/kotlin/doc/-observer/longitude.md +++ b/source/kotlin/doc/-observer/longitude.md @@ -2,6 +2,6 @@ # longitude -val [longitude](longitude.md): Double +val [longitude](longitude.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) Geographic longitude in degrees east (positive) or west (negative) of the prime meridian at Greenwich, England. diff --git a/source/kotlin/doc/-r-a-d2-d-e-g.md b/source/kotlin/doc/-r-a-d2-d-e-g.md index 603acf62..49758473 100644 --- a/source/kotlin/doc/-r-a-d2-d-e-g.md +++ b/source/kotlin/doc/-r-a-d2-d-e-g.md @@ -2,6 +2,6 @@ # RAD2DEG -const val [RAD2DEG](-r-a-d2-d-e-g.md): Double = 57.29577951308232 +const val [RAD2DEG](-r-a-d2-d-e-g.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) = 57.29577951308232 The factor to convert radians to degrees = 180/pi. diff --git a/source/kotlin/doc/-r-a-d2-h-o-u-r.md b/source/kotlin/doc/-r-a-d2-h-o-u-r.md index a874ad15..7c85826b 100644 --- a/source/kotlin/doc/-r-a-d2-h-o-u-r.md +++ b/source/kotlin/doc/-r-a-d2-h-o-u-r.md @@ -2,6 +2,6 @@ # RAD2HOUR -const val [RAD2HOUR](-r-a-d2-h-o-u-r.md): Double = 3.819718634205488 +const val [RAD2HOUR](-r-a-d2-h-o-u-r.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) = 3.819718634205488 The factor to convert radians to sidereal hours = 12/pi. diff --git a/source/kotlin/doc/-refraction/index.md b/source/kotlin/doc/-refraction/index.md index 1d390cf6..b0883693 100644 --- a/source/kotlin/doc/-refraction/index.md +++ b/source/kotlin/doc/-refraction/index.md @@ -2,7 +2,7 @@ # Refraction -enum [Refraction](index.md) : Enum<[Refraction](index.md)> +enum [Refraction](index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[Refraction](index.md)> Selects whether to correct for atmospheric refraction, and if so, how. diff --git a/source/kotlin/doc/-rotation-matrix/-companion/identity.md b/source/kotlin/doc/-rotation-matrix/-companion/identity.md index 5b681dd7..f988f1d8 100644 --- a/source/kotlin/doc/-rotation-matrix/-companion/identity.md +++ b/source/kotlin/doc/-rotation-matrix/-companion/identity.md @@ -3,7 +3,7 @@ # identity -@JvmStatic +@[JvmStatic](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-static/index.html) fun [identity](identity.md)(): [RotationMatrix](../index.md) diff --git a/source/kotlin/doc/-rotation-matrix/-companion/index.md b/source/kotlin/doc/-rotation-matrix/-companion/index.md index 3c2ff9ad..88aec494 100644 --- a/source/kotlin/doc/-rotation-matrix/-companion/index.md +++ b/source/kotlin/doc/-rotation-matrix/-companion/index.md @@ -8,4 +8,4 @@ object [Companion](index.md) | Name | Summary | |---|---| -| [identity](identity.md)
@JvmStatic
fun [identity](identity.md)(): [RotationMatrix](../index.md)
Creates an identity rotation matrix. | +| [identity](identity.md)
@[JvmStatic](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-static/index.html)
fun [identity](identity.md)(): [RotationMatrix](../index.md)
Creates an identity rotation matrix. | diff --git a/source/kotlin/doc/-rotation-matrix/-rotation-matrix.md b/source/kotlin/doc/-rotation-matrix/-rotation-matrix.md index 1438442c..0463900f 100644 --- a/source/kotlin/doc/-rotation-matrix/-rotation-matrix.md +++ b/source/kotlin/doc/-rotation-matrix/-rotation-matrix.md @@ -2,6 +2,6 @@ # RotationMatrix -fun [RotationMatrix](-rotation-matrix.md)(a00: Double, a01: Double, a02: Double, a10: Double, a11: Double, a12: Double, a20: Double, a21: Double, a22: Double) +fun [RotationMatrix](-rotation-matrix.md)(a00: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), a01: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), a02: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), a10: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), a11: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), a12: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), a20: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), a21: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), a22: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) -fun [RotationMatrix](-rotation-matrix.md)(rot: Array<DoubleArray>) +fun [RotationMatrix](-rotation-matrix.md)(rot: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[DoubleArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double-array/index.html)>) diff --git a/source/kotlin/doc/-rotation-matrix/index.md b/source/kotlin/doc/-rotation-matrix/index.md index 33438ec2..b1cf7325 100644 --- a/source/kotlin/doc/-rotation-matrix/index.md +++ b/source/kotlin/doc/-rotation-matrix/index.md @@ -2,7 +2,7 @@ # RotationMatrix -class [RotationMatrix](index.md)(rot: Array<DoubleArray>) +class [RotationMatrix](index.md)(rot: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[DoubleArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double-array/index.html)>) A rotation matrix that can be used to transform one coordinate system to another. @@ -10,8 +10,8 @@ A rotation matrix that can be used to transform one coordinate system to another | | | |---|---| -| [RotationMatrix](-rotation-matrix.md)
fun [RotationMatrix](-rotation-matrix.md)(a00: Double, a01: Double, a02: Double, a10: Double, a11: Double, a12: Double, a20: Double, a21: Double, a22: Double) | -| [RotationMatrix](-rotation-matrix.md)
fun [RotationMatrix](-rotation-matrix.md)(rot: Array<DoubleArray>) | +| [RotationMatrix](-rotation-matrix.md)
fun [RotationMatrix](-rotation-matrix.md)(a00: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), a01: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), a02: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), a10: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), a11: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), a12: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), a20: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), a21: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), a22: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) | +| [RotationMatrix](-rotation-matrix.md)
fun [RotationMatrix](-rotation-matrix.md)(rot: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[DoubleArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double-array/index.html)>) | ## Types @@ -25,11 +25,11 @@ A rotation matrix that can be used to transform one coordinate system to another |---|---| | [combine](combine.md)
infix fun [combine](combine.md)(other: [RotationMatrix](index.md)): [RotationMatrix](index.md)
Creates a rotation based on applying one rotation followed by another. | | [inverse](inverse.md)
fun [inverse](inverse.md)(): [RotationMatrix](index.md)
Calculates the inverse of a rotation matrix. | -| [pivot](pivot.md)
fun [pivot](pivot.md)(axis: Int, angle: Double): [RotationMatrix](index.md)
Re-orients the rotation matrix by pivoting it by an angle around one of its axes. | +| [pivot](pivot.md)
fun [pivot](pivot.md)(axis: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), angle: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [RotationMatrix](index.md)
Re-orients the rotation matrix by pivoting it by an angle around one of its axes. | | [rotate](rotate.md)
fun [rotate](rotate.md)(state: [StateVector](../-state-vector/index.md)): [StateVector](../-state-vector/index.md)
Applies a rotation to a state vector, yielding a rotated state vector.
[jvm]
fun [rotate](rotate.md)(vec: [Vector](../-vector/index.md)): [Vector](../-vector/index.md)
Applies a rotation to a vector, yielding a rotated vector. | ## Properties | Name | Summary | |---|---| -| [rot](rot.md)
val [rot](rot.md): Array<DoubleArray>
A 3x3 array of numbers to initialize the rotation matrix. | +| [rot](rot.md)
val [rot](rot.md): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[DoubleArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double-array/index.html)>
A 3x3 array of numbers to initialize the rotation matrix. | diff --git a/source/kotlin/doc/-rotation-matrix/pivot.md b/source/kotlin/doc/-rotation-matrix/pivot.md index 77ae0b1b..58bb97c9 100644 --- a/source/kotlin/doc/-rotation-matrix/pivot.md +++ b/source/kotlin/doc/-rotation-matrix/pivot.md @@ -2,7 +2,7 @@ # pivot -fun [pivot](pivot.md)(axis: Int, angle: Double): [RotationMatrix](index.md) +fun [pivot](pivot.md)(axis: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), angle: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [RotationMatrix](index.md) Re-orients the rotation matrix by pivoting it by an angle around one of its axes. diff --git a/source/kotlin/doc/-rotation-matrix/rot.md b/source/kotlin/doc/-rotation-matrix/rot.md index 1817dfdc..7d03d5df 100644 --- a/source/kotlin/doc/-rotation-matrix/rot.md +++ b/source/kotlin/doc/-rotation-matrix/rot.md @@ -2,6 +2,6 @@ # rot -val [rot](rot.md): Array<DoubleArray> +val [rot](rot.md): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[DoubleArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double-array/index.html)> A 3x3 array of numbers to initialize the rotation matrix. diff --git a/source/kotlin/doc/-s-e-c-o-n-d-s_-p-e-r_-d-a-y.md b/source/kotlin/doc/-s-e-c-o-n-d-s_-p-e-r_-d-a-y.md index 1365bfdc..5d689815 100644 --- a/source/kotlin/doc/-s-e-c-o-n-d-s_-p-e-r_-d-a-y.md +++ b/source/kotlin/doc/-s-e-c-o-n-d-s_-p-e-r_-d-a-y.md @@ -2,6 +2,6 @@ # SECONDS_PER_DAY -const val [SECONDS_PER_DAY](-s-e-c-o-n-d-s_-p-e-r_-d-a-y.md): Double +const val [SECONDS_PER_DAY](-s-e-c-o-n-d-s_-p-e-r_-d-a-y.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) The number of seconds in a day. diff --git a/source/kotlin/doc/-search-context/eval.md b/source/kotlin/doc/-search-context/eval.md index 9274f209..0d7a3b0e 100644 --- a/source/kotlin/doc/-search-context/eval.md +++ b/source/kotlin/doc/-search-context/eval.md @@ -2,7 +2,7 @@ # eval -abstract fun [eval](eval.md)(time: [Time](../-time/index.md)): Double +abstract fun [eval](eval.md)(time: [Time](../-time/index.md)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) Evaluates a scalar function at a given time. diff --git a/source/kotlin/doc/-search-context/index.md b/source/kotlin/doc/-search-context/index.md index 0d01bd3b..d57090b5 100644 --- a/source/kotlin/doc/-search-context/index.md +++ b/source/kotlin/doc/-search-context/index.md @@ -12,4 +12,4 @@ This interface must be implemented for callers of [search](../search.md) in orde | Name | Summary | |---|---| -| [eval](eval.md)
abstract fun [eval](eval.md)(time: [Time](../-time/index.md)): Double
Evaluates a scalar function at a given time. | +| [eval](eval.md)
abstract fun [eval](eval.md)(time: [Time](../-time/index.md)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Evaluates a scalar function at a given time. | diff --git a/source/kotlin/doc/-spherical/-spherical.md b/source/kotlin/doc/-spherical/-spherical.md index 1b86396b..03297134 100644 --- a/source/kotlin/doc/-spherical/-spherical.md +++ b/source/kotlin/doc/-spherical/-spherical.md @@ -2,4 +2,4 @@ # Spherical -fun [Spherical](-spherical.md)(lat: Double, lon: Double, dist: Double) +fun [Spherical](-spherical.md)(lat: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), lon: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), dist: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) diff --git a/source/kotlin/doc/-spherical/dist.md b/source/kotlin/doc/-spherical/dist.md index bec9f36d..b6b9bb6e 100644 --- a/source/kotlin/doc/-spherical/dist.md +++ b/source/kotlin/doc/-spherical/dist.md @@ -2,6 +2,6 @@ # dist -val [dist](dist.md): Double +val [dist](dist.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) Distance in AU. diff --git a/source/kotlin/doc/-spherical/index.md b/source/kotlin/doc/-spherical/index.md index cf66ec57..5a3be349 100644 --- a/source/kotlin/doc/-spherical/index.md +++ b/source/kotlin/doc/-spherical/index.md @@ -2,7 +2,7 @@ # Spherical -data class [Spherical](index.md)(lat: Double, lon: Double, dist: Double) +data class [Spherical](index.md)(lat: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), lon: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), dist: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) Spherical coordinates: latitude, longitude, distance. @@ -10,7 +10,7 @@ Spherical coordinates: latitude, longitude, distance. | | | |---|---| -| [Spherical](-spherical.md)
fun [Spherical](-spherical.md)(lat: Double, lon: Double, dist: Double) | +| [Spherical](-spherical.md)
fun [Spherical](-spherical.md)(lat: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), lon: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), dist: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) | ## Functions @@ -23,6 +23,6 @@ Spherical coordinates: latitude, longitude, distance. | Name | Summary | |---|---| -| [dist](dist.md)
val [dist](dist.md): Double
Distance in AU. | -| [lat](lat.md)
val [lat](lat.md): Double
The latitude angle: -90..+90 degrees. | -| [lon](lon.md)
val [lon](lon.md): Double
The longitude angle: 0..360 degrees. | +| [dist](dist.md)
val [dist](dist.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Distance in AU. | +| [lat](lat.md)
val [lat](lat.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
The latitude angle: -90..+90 degrees. | +| [lon](lon.md)
val [lon](lon.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
The longitude angle: 0..360 degrees. | diff --git a/source/kotlin/doc/-spherical/lat.md b/source/kotlin/doc/-spherical/lat.md index ad5a60a9..cdf8b3f3 100644 --- a/source/kotlin/doc/-spherical/lat.md +++ b/source/kotlin/doc/-spherical/lat.md @@ -2,6 +2,6 @@ # lat -val [lat](lat.md): Double +val [lat](lat.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) The latitude angle: -90..+90 degrees. diff --git a/source/kotlin/doc/-spherical/lon.md b/source/kotlin/doc/-spherical/lon.md index 8f2709b2..30e9a069 100644 --- a/source/kotlin/doc/-spherical/lon.md +++ b/source/kotlin/doc/-spherical/lon.md @@ -2,6 +2,6 @@ # lon -val [lon](lon.md): Double +val [lon](lon.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) The longitude angle: 0..360 degrees. diff --git a/source/kotlin/doc/-state-vector/-state-vector.md b/source/kotlin/doc/-state-vector/-state-vector.md index ad3628a6..dbb747ad 100644 --- a/source/kotlin/doc/-state-vector/-state-vector.md +++ b/source/kotlin/doc/-state-vector/-state-vector.md @@ -14,4 +14,4 @@ Combines a position vector and a velocity vector into a single state vector. | vel | A velocity vector. | | time | The common time that represents the given position and velocity. | -fun [StateVector](-state-vector.md)(x: Double, y: Double, z: Double, vx: Double, vy: Double, vz: Double, t: [Time](../-time/index.md)) +fun [StateVector](-state-vector.md)(x: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), y: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), z: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), vx: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), vy: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), vz: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), t: [Time](../-time/index.md)) diff --git a/source/kotlin/doc/-state-vector/div.md b/source/kotlin/doc/-state-vector/div.md index 946b5933..62ff4c3a 100644 --- a/source/kotlin/doc/-state-vector/div.md +++ b/source/kotlin/doc/-state-vector/div.md @@ -2,6 +2,6 @@ # div -operator fun [div](div.md)(denom: Double): [StateVector](index.md) +operator fun [div](div.md)(denom: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [StateVector](index.md) Divides a state vector by a scalar. diff --git a/source/kotlin/doc/-state-vector/index.md b/source/kotlin/doc/-state-vector/index.md index 3c6c335b..a84f802d 100644 --- a/source/kotlin/doc/-state-vector/index.md +++ b/source/kotlin/doc/-state-vector/index.md @@ -2,7 +2,7 @@ # StateVector -data class [StateVector](index.md)(x: Double, y: Double, z: Double, vx: Double, vy: Double, vz: Double, t: [Time](../-time/index.md)) +data class [StateVector](index.md)(x: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), y: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), z: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), vx: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), vy: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), vz: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), t: [Time](../-time/index.md)) Represents a combined position vector and velocity vector at a given moment in time. @@ -11,13 +11,13 @@ Represents a combined position vector and velocity vector at a given moment in t | | | |---|---| | [StateVector](-state-vector.md)
fun [StateVector](-state-vector.md)(pos: [Vector](../-vector/index.md), vel: [Vector](../-vector/index.md), time: [Time](../-time/index.md))
Combines a position vector and a velocity vector into a single state vector. | -| [StateVector](-state-vector.md)
fun [StateVector](-state-vector.md)(x: Double, y: Double, z: Double, vx: Double, vy: Double, vz: Double, t: [Time](../-time/index.md)) | +| [StateVector](-state-vector.md)
fun [StateVector](-state-vector.md)(x: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), y: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), z: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), vx: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), vy: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), vz: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), t: [Time](../-time/index.md)) | ## Functions | Name | Summary | |---|---| -| [div](div.md)
operator fun [div](div.md)(denom: Double): [StateVector](index.md)
Divides a state vector by a scalar. | +| [div](div.md)
operator fun [div](div.md)(denom: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [StateVector](index.md)
Divides a state vector by a scalar. | | [minus](minus.md)
operator fun [minus](minus.md)(other: [StateVector](index.md)): [StateVector](index.md)
Subtracts two state vetors, yielding the state vector difference. | | [plus](plus.md)
operator fun [plus](plus.md)(other: [StateVector](index.md)): [StateVector](index.md)
Adds two state vetors, yielding the state vector sum. | | [position](position.md)
fun [position](position.md)(): [Vector](../-vector/index.md)
Returns the position vector associated with this state vector. | @@ -29,9 +29,9 @@ Represents a combined position vector and velocity vector at a given moment in t | Name | Summary | |---|---| | [t](t.md)
val [t](t.md): [Time](../-time/index.md)
The date and time at which this vector is valid. | -| [vx](vx.md)
val [vx](vx.md): Double
A Cartesian velocity x-component expressed in AU/day. | -| [vy](vy.md)
val [vy](vy.md): Double
A Cartesian velocity y-component expressed in AU/day. | -| [vz](vz.md)
val [vz](vz.md): Double
A Cartesian velocity z-component expressed in AU/day. | -| [x](x.md)
val [x](x.md): Double
A Cartesian position x-coordinate expressed in AU. | -| [y](y.md)
val [y](y.md): Double
A Cartesian position y-coordinate expressed in AU. | -| [z](z.md)
val [z](z.md): Double
A Cartesian position z-coordinate expressed in AU. | +| [vx](vx.md)
val [vx](vx.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
A Cartesian velocity x-component expressed in AU/day. | +| [vy](vy.md)
val [vy](vy.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
A Cartesian velocity y-component expressed in AU/day. | +| [vz](vz.md)
val [vz](vz.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
A Cartesian velocity z-component expressed in AU/day. | +| [x](x.md)
val [x](x.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
A Cartesian position x-coordinate expressed in AU. | +| [y](y.md)
val [y](y.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
A Cartesian position y-coordinate expressed in AU. | +| [z](z.md)
val [z](z.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
A Cartesian position z-coordinate expressed in AU. | diff --git a/source/kotlin/doc/-state-vector/vx.md b/source/kotlin/doc/-state-vector/vx.md index ec75c2ff..39b697b7 100644 --- a/source/kotlin/doc/-state-vector/vx.md +++ b/source/kotlin/doc/-state-vector/vx.md @@ -2,6 +2,6 @@ # vx -val [vx](vx.md): Double +val [vx](vx.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) A Cartesian velocity x-component expressed in AU/day. diff --git a/source/kotlin/doc/-state-vector/vy.md b/source/kotlin/doc/-state-vector/vy.md index e8d75782..99f6908c 100644 --- a/source/kotlin/doc/-state-vector/vy.md +++ b/source/kotlin/doc/-state-vector/vy.md @@ -2,6 +2,6 @@ # vy -val [vy](vy.md): Double +val [vy](vy.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) A Cartesian velocity y-component expressed in AU/day. diff --git a/source/kotlin/doc/-state-vector/vz.md b/source/kotlin/doc/-state-vector/vz.md index d2717085..b0fd9483 100644 --- a/source/kotlin/doc/-state-vector/vz.md +++ b/source/kotlin/doc/-state-vector/vz.md @@ -2,6 +2,6 @@ # vz -val [vz](vz.md): Double +val [vz](vz.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) A Cartesian velocity z-component expressed in AU/day. diff --git a/source/kotlin/doc/-state-vector/x.md b/source/kotlin/doc/-state-vector/x.md index a8d5f451..90087f30 100644 --- a/source/kotlin/doc/-state-vector/x.md +++ b/source/kotlin/doc/-state-vector/x.md @@ -2,6 +2,6 @@ # x -val [x](x.md): Double +val [x](x.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) A Cartesian position x-coordinate expressed in AU. diff --git a/source/kotlin/doc/-state-vector/y.md b/source/kotlin/doc/-state-vector/y.md index 74bab2ac..466218d0 100644 --- a/source/kotlin/doc/-state-vector/y.md +++ b/source/kotlin/doc/-state-vector/y.md @@ -2,6 +2,6 @@ # y -val [y](y.md): Double +val [y](y.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) A Cartesian position y-coordinate expressed in AU. diff --git a/source/kotlin/doc/-state-vector/z.md b/source/kotlin/doc/-state-vector/z.md index 9d424756..d9118fa6 100644 --- a/source/kotlin/doc/-state-vector/z.md +++ b/source/kotlin/doc/-state-vector/z.md @@ -2,6 +2,6 @@ # z -val [z](z.md): Double +val [z](z.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) A Cartesian position z-coordinate expressed in AU. diff --git a/source/kotlin/doc/-time/-companion/from-milliseconds-since1970.md b/source/kotlin/doc/-time/-companion/from-milliseconds-since1970.md index 141f7679..1d358c40 100644 --- a/source/kotlin/doc/-time/-companion/from-milliseconds-since1970.md +++ b/source/kotlin/doc/-time/-companion/from-milliseconds-since1970.md @@ -3,9 +3,9 @@ # fromMillisecondsSince1970 -@JvmStatic +@[JvmStatic](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-static/index.html) -fun [fromMillisecondsSince1970](from-milliseconds-since1970.md)(millis: Long): [Time](../index.md) +fun [fromMillisecondsSince1970](from-milliseconds-since1970.md)(millis: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Time](../index.md) Creates a Time object from the number of milliseconds since the 1970 epoch. diff --git a/source/kotlin/doc/-time/-companion/from-terrestrial-time.md b/source/kotlin/doc/-time/-companion/from-terrestrial-time.md index 1cdef6dc..e4870248 100644 --- a/source/kotlin/doc/-time/-companion/from-terrestrial-time.md +++ b/source/kotlin/doc/-time/-companion/from-terrestrial-time.md @@ -3,9 +3,9 @@ # fromTerrestrialTime -@JvmStatic +@[JvmStatic](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-static/index.html) -fun [fromTerrestrialTime](from-terrestrial-time.md)(tt: Double): [Time](../index.md) +fun [fromTerrestrialTime](from-terrestrial-time.md)(tt: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [Time](../index.md) Creates a Time object from a Terrestrial Time day value. diff --git a/source/kotlin/doc/-time/-companion/index.md b/source/kotlin/doc/-time/-companion/index.md index d1f57b92..c5ad3503 100644 --- a/source/kotlin/doc/-time/-companion/index.md +++ b/source/kotlin/doc/-time/-companion/index.md @@ -8,5 +8,5 @@ object [Companion](index.md) | Name | Summary | |---|---| -| [fromMillisecondsSince1970](from-milliseconds-since1970.md)
@JvmStatic
fun [fromMillisecondsSince1970](from-milliseconds-since1970.md)(millis: Long): [Time](../index.md)
Creates a Time object from the number of milliseconds since the 1970 epoch. | -| [fromTerrestrialTime](from-terrestrial-time.md)
@JvmStatic
fun [fromTerrestrialTime](from-terrestrial-time.md)(tt: Double): [Time](../index.md)
Creates a Time object from a Terrestrial Time day value. | +| [fromMillisecondsSince1970](from-milliseconds-since1970.md)
@[JvmStatic](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-static/index.html)
fun [fromMillisecondsSince1970](from-milliseconds-since1970.md)(millis: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Time](../index.md)
Creates a Time object from the number of milliseconds since the 1970 epoch. | +| [fromTerrestrialTime](from-terrestrial-time.md)
@[JvmStatic](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-static/index.html)
fun [fromTerrestrialTime](from-terrestrial-time.md)(tt: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [Time](../index.md)
Creates a Time object from a Terrestrial Time day value. | diff --git a/source/kotlin/doc/-time/-time.md b/source/kotlin/doc/-time/-time.md index 3b95b70d..de972abf 100644 --- a/source/kotlin/doc/-time/-time.md +++ b/source/kotlin/doc/-time/-time.md @@ -2,9 +2,9 @@ # Time -fun [Time](-time.md)(ut: Double) +fun [Time](-time.md)(ut: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) -fun [Time](-time.md)(year: Int, month: Int, day: Int, hour: Int, minute: Int, second: Double) +fun [Time](-time.md)(year: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), month: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), day: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), hour: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), minute: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), second: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) Creates a Time object from a UTC year, month, day, hour, minute and second. diff --git a/source/kotlin/doc/-time/add-days.md b/source/kotlin/doc/-time/add-days.md index d617a133..4f703335 100644 --- a/source/kotlin/doc/-time/add-days.md +++ b/source/kotlin/doc/-time/add-days.md @@ -2,7 +2,7 @@ # addDays -fun [addDays](add-days.md)(days: Double): [Time](index.md) +fun [addDays](add-days.md)(days: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [Time](index.md) Calculates the sum or difference of an [Time](index.md) with a specified floating point number of days. diff --git a/source/kotlin/doc/-time/compare-to.md b/source/kotlin/doc/-time/compare-to.md index bda16113..6e2f90a2 100644 --- a/source/kotlin/doc/-time/compare-to.md +++ b/source/kotlin/doc/-time/compare-to.md @@ -2,7 +2,7 @@ # compareTo -open operator override fun [compareTo](compare-to.md)(other: [Time](index.md)): Int +open operator override fun [compareTo](compare-to.md)(other: [Time](index.md)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) Compares the chronological order of two Time values. diff --git a/source/kotlin/doc/-time/index.md b/source/kotlin/doc/-time/index.md index ec98aae8..921d4661 100644 --- a/source/kotlin/doc/-time/index.md +++ b/source/kotlin/doc/-time/index.md @@ -2,7 +2,7 @@ # Time -class [Time](index.md) : Comparable<[Time](index.md)> +class [Time](index.md) : [Comparable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-comparable/index.html)<[Time](index.md)> A date and time used for astronomical calculations. @@ -10,8 +10,8 @@ A date and time used for astronomical calculations. | | | |---|---| -| [Time](-time.md)
fun [Time](-time.md)(ut: Double) | -| [Time](-time.md)
fun [Time](-time.md)(year: Int, month: Int, day: Int, hour: Int, minute: Int, second: Double)
Creates a Time object from a UTC year, month, day, hour, minute and second. | +| [Time](-time.md)
fun [Time](-time.md)(ut: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) | +| [Time](-time.md)
fun [Time](-time.md)(year: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), month: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), day: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), hour: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), minute: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), second: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
Creates a Time object from a UTC year, month, day, hour, minute and second. | ## Types @@ -23,15 +23,15 @@ A date and time used for astronomical calculations. | Name | Summary | |---|---| -| [addDays](add-days.md)
fun [addDays](add-days.md)(days: Double): [Time](index.md)
Calculates the sum or difference of an [Time](index.md) with a specified floating point number of days. | -| [compareTo](compare-to.md)
open operator override fun [compareTo](compare-to.md)(other: [Time](index.md)): Int
Compares the chronological order of two Time values. | +| [addDays](add-days.md)
fun [addDays](add-days.md)(days: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [Time](index.md)
Calculates the sum or difference of an [Time](index.md) with a specified floating point number of days. | +| [compareTo](compare-to.md)
open operator override fun [compareTo](compare-to.md)(other: [Time](index.md)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Compares the chronological order of two Time values. | | [toDateTime](to-date-time.md)
fun [toDateTime](to-date-time.md)(): [DateTime](../-date-time/index.md)
Resolves this Time into year, month, day, hour, minute, second. | -| [toMillisecondsSince1970](to-milliseconds-since1970.md)
fun [toMillisecondsSince1970](to-milliseconds-since1970.md)(): Long
Converts this Time to the integer number of millseconds since 1970. | -| [toString](to-string.md)
open override fun [toString](to-string.md)(): String
Converts this Time to ISO 8601 format, expressed in UTC with millisecond resolution. | +| [toMillisecondsSince1970](to-milliseconds-since1970.md)
fun [toMillisecondsSince1970](to-milliseconds-since1970.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
Converts this Time to the integer number of millseconds since 1970. | +| [toString](to-string.md)
open override fun [toString](to-string.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Converts this Time to ISO 8601 format, expressed in UTC with millisecond resolution. | ## Properties | Name | Summary | |---|---| -| [tt](tt.md)
val [tt](tt.md): Double
Terrestrial Time days since noon on January 1, 2000. | -| [ut](ut.md)
val [ut](ut.md): Double
UT1/UTC number of days since noon on January 1, 2000. | +| [tt](tt.md)
val [tt](tt.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Terrestrial Time days since noon on January 1, 2000. | +| [ut](ut.md)
val [ut](ut.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
UT1/UTC number of days since noon on January 1, 2000. | diff --git a/source/kotlin/doc/-time/to-milliseconds-since1970.md b/source/kotlin/doc/-time/to-milliseconds-since1970.md index cc31d8b8..ac2338e9 100644 --- a/source/kotlin/doc/-time/to-milliseconds-since1970.md +++ b/source/kotlin/doc/-time/to-milliseconds-since1970.md @@ -2,6 +2,6 @@ # toMillisecondsSince1970 -fun [toMillisecondsSince1970](to-milliseconds-since1970.md)(): Long +fun [toMillisecondsSince1970](to-milliseconds-since1970.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) Converts this Time to the integer number of millseconds since 1970. diff --git a/source/kotlin/doc/-time/to-string.md b/source/kotlin/doc/-time/to-string.md index 84849c53..da2e9416 100644 --- a/source/kotlin/doc/-time/to-string.md +++ b/source/kotlin/doc/-time/to-string.md @@ -2,7 +2,7 @@ # toString -open override fun [toString](to-string.md)(): String +open override fun [toString](to-string.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) Converts this Time to ISO 8601 format, expressed in UTC with millisecond resolution. diff --git a/source/kotlin/doc/-time/tt.md b/source/kotlin/doc/-time/tt.md index f77c9f96..df4b3581 100644 --- a/source/kotlin/doc/-time/tt.md +++ b/source/kotlin/doc/-time/tt.md @@ -2,7 +2,7 @@ # tt -val [tt](tt.md): Double +val [tt](tt.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) Terrestrial Time days since noon on January 1, 2000. diff --git a/source/kotlin/doc/-time/ut.md b/source/kotlin/doc/-time/ut.md index bf465d66..c810982b 100644 --- a/source/kotlin/doc/-time/ut.md +++ b/source/kotlin/doc/-time/ut.md @@ -2,7 +2,7 @@ # ut -val [ut](ut.md): Double +val [ut](ut.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) UT1/UTC number of days since noon on January 1, 2000. diff --git a/source/kotlin/doc/-topocentric/-topocentric.md b/source/kotlin/doc/-topocentric/-topocentric.md index d7fc3d8f..25f326c0 100644 --- a/source/kotlin/doc/-topocentric/-topocentric.md +++ b/source/kotlin/doc/-topocentric/-topocentric.md @@ -2,4 +2,4 @@ # Topocentric -fun [Topocentric](-topocentric.md)(azimuth: Double, altitude: Double, ra: Double, dec: Double) +fun [Topocentric](-topocentric.md)(azimuth: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), altitude: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), ra: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), dec: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) diff --git a/source/kotlin/doc/-topocentric/altitude.md b/source/kotlin/doc/-topocentric/altitude.md index c92ebd57..72059780 100644 --- a/source/kotlin/doc/-topocentric/altitude.md +++ b/source/kotlin/doc/-topocentric/altitude.md @@ -2,6 +2,6 @@ # altitude -val [altitude](altitude.md): Double +val [altitude](altitude.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) Angle in degrees above (positive) or below (negative) the observer's horizon. diff --git a/source/kotlin/doc/-topocentric/azimuth.md b/source/kotlin/doc/-topocentric/azimuth.md index 72aaffbc..f1b08757 100644 --- a/source/kotlin/doc/-topocentric/azimuth.md +++ b/source/kotlin/doc/-topocentric/azimuth.md @@ -2,6 +2,6 @@ # azimuth -val [azimuth](azimuth.md): Double +val [azimuth](azimuth.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) Compass direction around the horizon in degrees. 0=North, 90=East, 180=South, 270=West. diff --git a/source/kotlin/doc/-topocentric/dec.md b/source/kotlin/doc/-topocentric/dec.md index ea1ecc7f..7b4b793b 100644 --- a/source/kotlin/doc/-topocentric/dec.md +++ b/source/kotlin/doc/-topocentric/dec.md @@ -2,6 +2,6 @@ # dec -val [dec](dec.md): Double +val [dec](dec.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) Declination in degrees. diff --git a/source/kotlin/doc/-topocentric/index.md b/source/kotlin/doc/-topocentric/index.md index 35253ba4..588c8e28 100644 --- a/source/kotlin/doc/-topocentric/index.md +++ b/source/kotlin/doc/-topocentric/index.md @@ -2,7 +2,7 @@ # Topocentric -data class [Topocentric](index.md)(azimuth: Double, altitude: Double, ra: Double, dec: Double) +data class [Topocentric](index.md)(azimuth: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), altitude: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), ra: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), dec: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) Coordinates of a celestial body as seen by a topocentric observer. @@ -12,13 +12,13 @@ Horizontal and equatorial coordinates seen by an observer on or near the surface | | | |---|---| -| [Topocentric](-topocentric.md)
fun [Topocentric](-topocentric.md)(azimuth: Double, altitude: Double, ra: Double, dec: Double) | +| [Topocentric](-topocentric.md)
fun [Topocentric](-topocentric.md)(azimuth: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), altitude: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), ra: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), dec: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) | ## Properties | Name | Summary | |---|---| -| [altitude](altitude.md)
val [altitude](altitude.md): Double
Angle in degrees above (positive) or below (negative) the observer's horizon. | -| [azimuth](azimuth.md)
val [azimuth](azimuth.md): Double
Compass direction around the horizon in degrees. 0=North, 90=East, 180=South, 270=West. | -| [dec](dec.md)
val [dec](dec.md): Double
Declination in degrees. | -| [ra](ra.md)
val [ra](ra.md): Double
Right ascension in sidereal hours. | +| [altitude](altitude.md)
val [altitude](altitude.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Angle in degrees above (positive) or below (negative) the observer's horizon. | +| [azimuth](azimuth.md)
val [azimuth](azimuth.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Compass direction around the horizon in degrees. 0=North, 90=East, 180=South, 270=West. | +| [dec](dec.md)
val [dec](dec.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Declination in degrees. | +| [ra](ra.md)
val [ra](ra.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Right ascension in sidereal hours. | diff --git a/source/kotlin/doc/-topocentric/ra.md b/source/kotlin/doc/-topocentric/ra.md index d91c6f64..408f6cb4 100644 --- a/source/kotlin/doc/-topocentric/ra.md +++ b/source/kotlin/doc/-topocentric/ra.md @@ -2,6 +2,6 @@ # ra -val [ra](ra.md): Double +val [ra](ra.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) Right ascension in sidereal hours. diff --git a/source/kotlin/doc/-transit-info/-transit-info.md b/source/kotlin/doc/-transit-info/-transit-info.md index 21db5078..958aaf69 100644 --- a/source/kotlin/doc/-transit-info/-transit-info.md +++ b/source/kotlin/doc/-transit-info/-transit-info.md @@ -2,4 +2,4 @@ # TransitInfo -fun [TransitInfo](-transit-info.md)(start: [Time](../-time/index.md), peak: [Time](../-time/index.md), finish: [Time](../-time/index.md), separation: Double) +fun [TransitInfo](-transit-info.md)(start: [Time](../-time/index.md), peak: [Time](../-time/index.md), finish: [Time](../-time/index.md), separation: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) diff --git a/source/kotlin/doc/-transit-info/index.md b/source/kotlin/doc/-transit-info/index.md index 2f452531..882bde9f 100644 --- a/source/kotlin/doc/-transit-info/index.md +++ b/source/kotlin/doc/-transit-info/index.md @@ -2,7 +2,7 @@ # TransitInfo -class [TransitInfo](index.md)(start: [Time](../-time/index.md), peak: [Time](../-time/index.md), finish: [Time](../-time/index.md), separation: Double) +class [TransitInfo](index.md)(start: [Time](../-time/index.md), peak: [Time](../-time/index.md), finish: [Time](../-time/index.md), separation: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) Information about a transit of Mercury or Venus, as seen from the Earth. @@ -16,7 +16,7 @@ The calculations are performed from the point of view of a geocentric observer. | | | |---|---| -| [TransitInfo](-transit-info.md)
fun [TransitInfo](-transit-info.md)(start: [Time](../-time/index.md), peak: [Time](../-time/index.md), finish: [Time](../-time/index.md), separation: Double) | +| [TransitInfo](-transit-info.md)
fun [TransitInfo](-transit-info.md)(start: [Time](../-time/index.md), peak: [Time](../-time/index.md), finish: [Time](../-time/index.md), separation: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) | ## Properties @@ -24,5 +24,5 @@ The calculations are performed from the point of view of a geocentric observer. |---|---| | [finish](finish.md)
val [finish](finish.md): [Time](../-time/index.md)
Date and time at the end of the transit. | | [peak](peak.md)
val [peak](peak.md): [Time](../-time/index.md)
Date and time of the peak of the transit. | -| [separation](separation.md)
val [separation](separation.md): Double
Angular separation in arcminutes between the centers of the Sun and the planet at time peak. | +| [separation](separation.md)
val [separation](separation.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Angular separation in arcminutes between the centers of the Sun and the planet at time peak. | | [start](start.md)
val [start](start.md): [Time](../-time/index.md)
Date and time at the beginning of the transit. | diff --git a/source/kotlin/doc/-transit-info/separation.md b/source/kotlin/doc/-transit-info/separation.md index 0b632a89..f0788217 100644 --- a/source/kotlin/doc/-transit-info/separation.md +++ b/source/kotlin/doc/-transit-info/separation.md @@ -2,6 +2,6 @@ # separation -val [separation](separation.md): Double +val [separation](separation.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) Angular separation in arcminutes between the centers of the Sun and the planet at time peak. diff --git a/source/kotlin/doc/-vector/-vector.md b/source/kotlin/doc/-vector/-vector.md index 4487546a..b4f10848 100644 --- a/source/kotlin/doc/-vector/-vector.md +++ b/source/kotlin/doc/-vector/-vector.md @@ -2,4 +2,4 @@ # Vector -fun [Vector](-vector.md)(x: Double, y: Double, z: Double, t: [Time](../-time/index.md)) +fun [Vector](-vector.md)(x: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), y: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), z: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), t: [Time](../-time/index.md)) diff --git a/source/kotlin/doc/-vector/angle-with.md b/source/kotlin/doc/-vector/angle-with.md index 353b23c6..c2d292d3 100644 --- a/source/kotlin/doc/-vector/angle-with.md +++ b/source/kotlin/doc/-vector/angle-with.md @@ -2,6 +2,6 @@ # angleWith -fun [angleWith](angle-with.md)(other: [Vector](index.md)): Double +fun [angleWith](angle-with.md)(other: [Vector](index.md)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) Calculates the angle in degrees (0..180) between two vectors. diff --git a/source/kotlin/doc/-vector/div.md b/source/kotlin/doc/-vector/div.md index 4f834025..708f79c7 100644 --- a/source/kotlin/doc/-vector/div.md +++ b/source/kotlin/doc/-vector/div.md @@ -2,6 +2,6 @@ # div -operator fun [div](div.md)(denom: Double): [Vector](index.md) +operator fun [div](div.md)(denom: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [Vector](index.md) Divides a vector by a scalar. diff --git a/source/kotlin/doc/-vector/dot.md b/source/kotlin/doc/-vector/dot.md index 5925972b..5d07282f 100644 --- a/source/kotlin/doc/-vector/dot.md +++ b/source/kotlin/doc/-vector/dot.md @@ -2,6 +2,6 @@ # dot -infix fun [dot](dot.md)(other: [Vector](index.md)): Double +infix fun [dot](dot.md)(other: [Vector](index.md)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) Takes the dot product of two vectors. diff --git a/source/kotlin/doc/-vector/index.md b/source/kotlin/doc/-vector/index.md index 17c8475c..4116e71a 100644 --- a/source/kotlin/doc/-vector/index.md +++ b/source/kotlin/doc/-vector/index.md @@ -2,7 +2,7 @@ # Vector -data class [Vector](index.md)(x: Double, y: Double, z: Double, t: [Time](../-time/index.md)) +data class [Vector](index.md)(x: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), y: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), z: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), t: [Time](../-time/index.md)) A 3D Cartesian vector whose components are expressed in Astronomical Units (AU). @@ -10,16 +10,16 @@ A 3D Cartesian vector whose components are expressed in Astronomical Units (AU). | | | |---|---| -| [Vector](-vector.md)
fun [Vector](-vector.md)(x: Double, y: Double, z: Double, t: [Time](../-time/index.md)) | +| [Vector](-vector.md)
fun [Vector](-vector.md)(x: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), y: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), z: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), t: [Time](../-time/index.md)) | ## Functions | Name | Summary | |---|---| -| [angleWith](angle-with.md)
fun [angleWith](angle-with.md)(other: [Vector](index.md)): Double
Calculates the angle in degrees (0..180) between two vectors. | -| [div](div.md)
operator fun [div](div.md)(denom: Double): [Vector](index.md)
Divides a vector by a scalar. | -| [dot](dot.md)
infix fun [dot](dot.md)(other: [Vector](index.md)): Double
Takes the dot product of two vectors. | -| [length](length.md)
fun [length](length.md)(): Double
The total distance in AU represented by this vector. | +| [angleWith](angle-with.md)
fun [angleWith](angle-with.md)(other: [Vector](index.md)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Calculates the angle in degrees (0..180) between two vectors. | +| [div](div.md)
operator fun [div](div.md)(denom: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [Vector](index.md)
Divides a vector by a scalar. | +| [dot](dot.md)
infix fun [dot](dot.md)(other: [Vector](index.md)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Takes the dot product of two vectors. | +| [length](length.md)
fun [length](length.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
The total distance in AU represented by this vector. | | [minus](minus.md)
operator fun [minus](minus.md)(other: [Vector](index.md)): [Vector](index.md)
Subtracts one vector from another. Both operands must have identical times. | | [plus](plus.md)
operator fun [plus](plus.md)(other: [Vector](index.md)): [Vector](index.md)
Adds two vectors. Both operands must have identical times. | | [toEquatorial](to-equatorial.md)
fun [toEquatorial](to-equatorial.md)(): [Equatorial](../-equatorial/index.md)
Given an equatorial vector, calculates equatorial angular coordinates. | @@ -34,6 +34,6 @@ A 3D Cartesian vector whose components are expressed in Astronomical Units (AU). | Name | Summary | |---|---| | [t](t.md)
val [t](t.md): [Time](../-time/index.md)
The date and time at which this vector is valid. | -| [x](x.md)
val [x](x.md): Double
A Cartesian x-coordinate expressed in AU. | -| [y](y.md)
val [y](y.md): Double
A Cartesian y-coordinate expressed in AU. | -| [z](z.md)
val [z](z.md): Double
A Cartesian z-coordinate expressed in AU. | +| [x](x.md)
val [x](x.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
A Cartesian x-coordinate expressed in AU. | +| [y](y.md)
val [y](y.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
A Cartesian y-coordinate expressed in AU. | +| [z](z.md)
val [z](z.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
A Cartesian z-coordinate expressed in AU. | diff --git a/source/kotlin/doc/-vector/length.md b/source/kotlin/doc/-vector/length.md index 1bfb2130..02546b26 100644 --- a/source/kotlin/doc/-vector/length.md +++ b/source/kotlin/doc/-vector/length.md @@ -2,6 +2,6 @@ # length -fun [length](length.md)(): Double +fun [length](length.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) The total distance in AU represented by this vector. diff --git a/source/kotlin/doc/-vector/x.md b/source/kotlin/doc/-vector/x.md index 578f7081..12cd0c58 100644 --- a/source/kotlin/doc/-vector/x.md +++ b/source/kotlin/doc/-vector/x.md @@ -2,6 +2,6 @@ # x -val [x](x.md): Double +val [x](x.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) A Cartesian x-coordinate expressed in AU. diff --git a/source/kotlin/doc/-vector/y.md b/source/kotlin/doc/-vector/y.md index 69c80789..a5fa5896 100644 --- a/source/kotlin/doc/-vector/y.md +++ b/source/kotlin/doc/-vector/y.md @@ -2,6 +2,6 @@ # y -val [y](y.md): Double +val [y](y.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) A Cartesian y-coordinate expressed in AU. diff --git a/source/kotlin/doc/-vector/z.md b/source/kotlin/doc/-vector/z.md index 5a8af8ef..be3903a2 100644 --- a/source/kotlin/doc/-vector/z.md +++ b/source/kotlin/doc/-vector/z.md @@ -2,6 +2,6 @@ # z -val [z](z.md): Double +val [z](z.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) A Cartesian z-coordinate expressed in AU. diff --git a/source/kotlin/doc/-visibility/index.md b/source/kotlin/doc/-visibility/index.md index a1ecaaac..c49ae872 100644 --- a/source/kotlin/doc/-visibility/index.md +++ b/source/kotlin/doc/-visibility/index.md @@ -2,7 +2,7 @@ # Visibility -enum [Visibility](index.md) : Enum<[Visibility](index.md)> +enum [Visibility](index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[Visibility](index.md)> Indicates whether a body (especially Mercury or Venus) is best seen in the morning or evening. diff --git a/source/kotlin/doc/angle-from-sun.md b/source/kotlin/doc/angle-from-sun.md index 7fae55fd..3384fb8d 100644 --- a/source/kotlin/doc/angle-from-sun.md +++ b/source/kotlin/doc/angle-from-sun.md @@ -2,7 +2,7 @@ # angleFromSun -fun [angleFromSun](angle-from-sun.md)(body: [Body](-body/index.md), time: [Time](-time/index.md)): Double +fun [angleFromSun](angle-from-sun.md)(body: [Body](-body/index.md), time: [Time](-time/index.md)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) Returns the angle between the given body and the Sun, as seen from the Earth. diff --git a/source/kotlin/doc/constellation.md b/source/kotlin/doc/constellation.md index b9d5388d..5a81e8de 100644 --- a/source/kotlin/doc/constellation.md +++ b/source/kotlin/doc/constellation.md @@ -2,7 +2,7 @@ # constellation -fun [constellation](constellation.md)(ra: Double, dec: Double): [ConstellationInfo](-constellation-info/index.md) +fun [constellation](constellation.md)(ra: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), dec: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [ConstellationInfo](-constellation-info/index.md) Determines the constellation that contains the given point in the sky. diff --git a/source/kotlin/doc/degrees-to-radians.md b/source/kotlin/doc/degrees-to-radians.md index 40b892e9..cde9db17 100644 --- a/source/kotlin/doc/degrees-to-radians.md +++ b/source/kotlin/doc/degrees-to-radians.md @@ -2,6 +2,6 @@ # degreesToRadians -fun Double.[degreesToRadians](degrees-to-radians.md)(): Double +fun [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html).[degreesToRadians](degrees-to-radians.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) Convert an angle expressed in degrees to an angle expressed in radians. diff --git a/source/kotlin/doc/ecliptic-longitude.md b/source/kotlin/doc/ecliptic-longitude.md index cedb88d8..487bd7ea 100644 --- a/source/kotlin/doc/ecliptic-longitude.md +++ b/source/kotlin/doc/ecliptic-longitude.md @@ -2,7 +2,7 @@ # eclipticLongitude -fun [eclipticLongitude](ecliptic-longitude.md)(body: [Body](-body/index.md), time: [Time](-time/index.md)): Double +fun [eclipticLongitude](ecliptic-longitude.md)(body: [Body](-body/index.md), time: [Time](-time/index.md)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) Calculates heliocentric ecliptic longitude of a body based on the J2000 equinox. diff --git a/source/kotlin/doc/global-solar-eclipses-after.md b/source/kotlin/doc/global-solar-eclipses-after.md index 0efc5c0f..5faf1fc5 100644 --- a/source/kotlin/doc/global-solar-eclipses-after.md +++ b/source/kotlin/doc/global-solar-eclipses-after.md @@ -2,7 +2,7 @@ # globalSolarEclipsesAfter -fun [globalSolarEclipsesAfter](global-solar-eclipses-after.md)(startTime: [Time](-time/index.md)): Sequence<[GlobalSolarEclipseInfo](-global-solar-eclipse-info/index.md)> +fun [globalSolarEclipsesAfter](global-solar-eclipses-after.md)(startTime: [Time](-time/index.md)): [Sequence](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.sequences/-sequence/index.html)<[GlobalSolarEclipseInfo](-global-solar-eclipse-info/index.md)> Enumerates a series of consecutive global solar eclipses that occur after a given time. diff --git a/source/kotlin/doc/helio-distance.md b/source/kotlin/doc/helio-distance.md index 230e9da8..cb6b94e6 100644 --- a/source/kotlin/doc/helio-distance.md +++ b/source/kotlin/doc/helio-distance.md @@ -2,7 +2,7 @@ # helioDistance -fun [helioDistance](helio-distance.md)(body: [Body](-body/index.md), time: [Time](-time/index.md)): Double +fun [helioDistance](helio-distance.md)(body: [Body](-body/index.md), time: [Time](-time/index.md)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) Calculates the distance between a body and the Sun at a given time. diff --git a/source/kotlin/doc/horizon.md b/source/kotlin/doc/horizon.md index 8203e060..51ab8cd8 100644 --- a/source/kotlin/doc/horizon.md +++ b/source/kotlin/doc/horizon.md @@ -2,7 +2,7 @@ # horizon -fun [horizon](horizon.md)(time: [Time](-time/index.md), observer: [Observer](-observer/index.md), ra: Double, dec: Double, refraction: [Refraction](-refraction/index.md)): [Topocentric](-topocentric/index.md) +fun [horizon](horizon.md)(time: [Time](-time/index.md), observer: [Observer](-observer/index.md), ra: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), dec: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), refraction: [Refraction](-refraction/index.md)): [Topocentric](-topocentric/index.md) Calculates the apparent location of a body relative to the local horizon of an observer on the Earth. diff --git a/source/kotlin/doc/index.md b/source/kotlin/doc/index.md index 7381c07f..5c437fba 100644 --- a/source/kotlin/doc/index.md +++ b/source/kotlin/doc/index.md @@ -6,60 +6,60 @@ | Name | Summary | |---|---| -| [Aberration](-aberration/index.md)
enum [Aberration](-aberration/index.md) : Enum<[Aberration](-aberration/index.md)>
Aberration calculation options. | -| [ApsisInfo](-apsis-info/index.md)
class [ApsisInfo](-apsis-info/index.md)(time: [Time](-time/index.md), kind: [ApsisKind](-apsis-kind/index.md), distanceAu: Double)
An apsis event: pericenter (closest approach) or apocenter (farthest distance). | -| [ApsisKind](-apsis-kind/index.md)
enum [ApsisKind](-apsis-kind/index.md) : Enum<[ApsisKind](-apsis-kind/index.md)>
The type of apsis: pericenter (closest approach) or apocenter (farthest distance). | -| [AxisInfo](-axis-info/index.md)
class [AxisInfo](-axis-info/index.md)(ra: Double, dec: Double, spin: Double, north: [Vector](-vector/index.md))
Information about a body's rotation axis at a given time. | -| [Body](-body/index.md)
enum [Body](-body/index.md) : Enum<[Body](-body/index.md)>
The enumeration of celestial bodies supported by Astronomy Engine. | -| [ConstellationInfo](-constellation-info/index.md)
class [ConstellationInfo](-constellation-info/index.md)(symbol: String, name: String, ra1875: Double, dec1875: Double)
Reports the constellation that a given celestial point lies within. | -| [DateTime](-date-time/index.md)
class [DateTime](-date-time/index.md)(year: Int, month: Int, day: Int, hour: Int, minute: Int, second: Double)
A universal time resolved into UTC calendar date and time fields. | -| [Direction](-direction/index.md)
enum [Direction](-direction/index.md) : Enum<[Direction](-direction/index.md)>
Selects whether to search for a rising event or a setting event for a celestial body. | -| [EarthNotAllowedException](-earth-not-allowed-exception/index.md)
class [EarthNotAllowedException](-earth-not-allowed-exception/index.md) : Exception
The Earth is not allowed as the body parameter. | -| [EclipseEvent](-eclipse-event/index.md)
class [EclipseEvent](-eclipse-event/index.md)(time: [Time](-time/index.md), altitude: Double)
Holds a time and the observed altitude of the Sun at that time. | -| [EclipseKind](-eclipse-kind/index.md)
enum [EclipseKind](-eclipse-kind/index.md) : Enum<[EclipseKind](-eclipse-kind/index.md)>
The different kinds of lunar/solar eclipses. | -| [Ecliptic](-ecliptic/index.md)
data class [Ecliptic](-ecliptic/index.md)(vec: [Vector](-vector/index.md), elat: Double, elon: Double)
Ecliptic angular and Cartesian coordinates. | -| [ElongationInfo](-elongation-info/index.md)
class [ElongationInfo](-elongation-info/index.md)(time: [Time](-time/index.md), visibility: [Visibility](-visibility/index.md), elongation: Double, eclipticSeparation: Double)
Contains information about the visibility of a celestial body at a given date and time. | -| [EquatorEpoch](-equator-epoch/index.md)
enum [EquatorEpoch](-equator-epoch/index.md) : Enum<[EquatorEpoch](-equator-epoch/index.md)>
Selects the date for which the Earth's equator is to be used for representing equatorial coordinates. | -| [Equatorial](-equatorial/index.md)
class [Equatorial](-equatorial/index.md)(ra: Double, dec: Double, dist: Double, vec: [Vector](-vector/index.md))
Equatorial angular and cartesian coordinates. | -| [GlobalSolarEclipseInfo](-global-solar-eclipse-info/index.md)
class [GlobalSolarEclipseInfo](-global-solar-eclipse-info/index.md)(kind: [EclipseKind](-eclipse-kind/index.md), obscuration: Double, peak: [Time](-time/index.md), distance: Double, latitude: Double, longitude: Double)
Reports the time and geographic location of the peak of a solar eclipse. | +| [Aberration](-aberration/index.md)
enum [Aberration](-aberration/index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[Aberration](-aberration/index.md)>
Aberration calculation options. | +| [ApsisInfo](-apsis-info/index.md)
class [ApsisInfo](-apsis-info/index.md)(time: [Time](-time/index.md), kind: [ApsisKind](-apsis-kind/index.md), distanceAu: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
An apsis event: pericenter (closest approach) or apocenter (farthest distance). | +| [ApsisKind](-apsis-kind/index.md)
enum [ApsisKind](-apsis-kind/index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[ApsisKind](-apsis-kind/index.md)>
The type of apsis: pericenter (closest approach) or apocenter (farthest distance). | +| [AxisInfo](-axis-info/index.md)
class [AxisInfo](-axis-info/index.md)(ra: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), dec: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), spin: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), north: [Vector](-vector/index.md))
Information about a body's rotation axis at a given time. | +| [Body](-body/index.md)
enum [Body](-body/index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[Body](-body/index.md)>
The enumeration of celestial bodies supported by Astronomy Engine. | +| [ConstellationInfo](-constellation-info/index.md)
class [ConstellationInfo](-constellation-info/index.md)(symbol: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), ra1875: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), dec1875: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
Reports the constellation that a given celestial point lies within. | +| [DateTime](-date-time/index.md)
class [DateTime](-date-time/index.md)(year: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), month: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), day: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), hour: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), minute: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), second: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
A universal time resolved into UTC calendar date and time fields. | +| [Direction](-direction/index.md)
enum [Direction](-direction/index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[Direction](-direction/index.md)>
Selects whether to search for a rising event or a setting event for a celestial body. | +| [EarthNotAllowedException](-earth-not-allowed-exception/index.md)
class [EarthNotAllowedException](-earth-not-allowed-exception/index.md) : [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html)
The Earth is not allowed as the body parameter. | +| [EclipseEvent](-eclipse-event/index.md)
class [EclipseEvent](-eclipse-event/index.md)(time: [Time](-time/index.md), altitude: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
Holds a time and the observed altitude of the Sun at that time. | +| [EclipseKind](-eclipse-kind/index.md)
enum [EclipseKind](-eclipse-kind/index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[EclipseKind](-eclipse-kind/index.md)>
The different kinds of lunar/solar eclipses. | +| [Ecliptic](-ecliptic/index.md)
data class [Ecliptic](-ecliptic/index.md)(vec: [Vector](-vector/index.md), elat: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), elon: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
Ecliptic angular and Cartesian coordinates. | +| [ElongationInfo](-elongation-info/index.md)
class [ElongationInfo](-elongation-info/index.md)(time: [Time](-time/index.md), visibility: [Visibility](-visibility/index.md), elongation: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), eclipticSeparation: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
Contains information about the visibility of a celestial body at a given date and time. | +| [EquatorEpoch](-equator-epoch/index.md)
enum [EquatorEpoch](-equator-epoch/index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[EquatorEpoch](-equator-epoch/index.md)>
Selects the date for which the Earth's equator is to be used for representing equatorial coordinates. | +| [Equatorial](-equatorial/index.md)
class [Equatorial](-equatorial/index.md)(ra: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), dec: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), dist: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), vec: [Vector](-vector/index.md))
Equatorial angular and cartesian coordinates. | +| [GlobalSolarEclipseInfo](-global-solar-eclipse-info/index.md)
class [GlobalSolarEclipseInfo](-global-solar-eclipse-info/index.md)(kind: [EclipseKind](-eclipse-kind/index.md), obscuration: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), peak: [Time](-time/index.md), distance: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), latitude: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), longitude: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
Reports the time and geographic location of the peak of a solar eclipse. | | [GravitySimulator](-gravity-simulator/index.md)
class [GravitySimulator](-gravity-simulator/index.md)
A simulation of zero or more small bodies moving through the Solar System. | | [HourAngleInfo](-hour-angle-info/index.md)
class [HourAngleInfo](-hour-angle-info/index.md)(time: [Time](-time/index.md), hor: [Topocentric](-topocentric/index.md))
Information about a celestial body crossing a specific hour angle. | -| [IlluminationInfo](-illumination-info/index.md)
class [IlluminationInfo](-illumination-info/index.md)(time: [Time](-time/index.md), mag: Double, phaseAngle: Double, phaseFraction: Double, helioDist: Double, ringTilt: Double)
Information about the brightness and illuminated shape of a celestial body. | -| [InternalError](-internal-error/index.md)
class [InternalError](-internal-error/index.md)(message: String) : Exception
An unexpected internal error occurred in Astronomy Engine | -| [InvalidBodyException](-invalid-body-exception/index.md)
class [InvalidBodyException](-invalid-body-exception/index.md)(body: [Body](-body/index.md)) : Exception
An invalid body was specified for the given function. | +| [IlluminationInfo](-illumination-info/index.md)
class [IlluminationInfo](-illumination-info/index.md)(time: [Time](-time/index.md), mag: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), phaseAngle: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), phaseFraction: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), helioDist: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), ringTilt: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
Information about the brightness and illuminated shape of a celestial body. | +| [InternalError](-internal-error/index.md)
class [InternalError](-internal-error/index.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) : [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html)
An unexpected internal error occurred in Astronomy Engine | +| [InvalidBodyException](-invalid-body-exception/index.md)
class [InvalidBodyException](-invalid-body-exception/index.md)(body: [Body](-body/index.md)) : [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html)
An invalid body was specified for the given function. | | [JupiterMoonsInfo](-jupiter-moons-info/index.md)
class [JupiterMoonsInfo](-jupiter-moons-info/index.md)(io: [StateVector](-state-vector/index.md), europa: [StateVector](-state-vector/index.md), ganymede: [StateVector](-state-vector/index.md), callisto: [StateVector](-state-vector/index.md))
Holds the positions and velocities of Jupiter's major 4 moons. | -| [LibrationInfo](-libration-info/index.md)
data class [LibrationInfo](-libration-info/index.md)(elat: Double, elon: Double, mlat: Double, mlon: Double, distanceKm: Double, diamDeg: Double)
Lunar libration angles, returned by [libration](libration.md). | -| [LocalSolarEclipseInfo](-local-solar-eclipse-info/index.md)
class [LocalSolarEclipseInfo](-local-solar-eclipse-info/index.md)(kind: [EclipseKind](-eclipse-kind/index.md), obscuration: Double, partialBegin: [EclipseEvent](-eclipse-event/index.md), totalBegin: [EclipseEvent](-eclipse-event/index.md)?, peak: [EclipseEvent](-eclipse-event/index.md), totalEnd: [EclipseEvent](-eclipse-event/index.md)?, partialEnd: [EclipseEvent](-eclipse-event/index.md))
Information about a solar eclipse as seen by an observer at a given time and geographic location. | -| [LunarEclipseInfo](-lunar-eclipse-info/index.md)
class [LunarEclipseInfo](-lunar-eclipse-info/index.md)(kind: [EclipseKind](-eclipse-kind/index.md), obscuration: Double, peak: [Time](-time/index.md), sdPenum: Double, sdPartial: Double, sdTotal: Double)
Information about a lunar eclipse. | -| [MoonQuarterInfo](-moon-quarter-info/index.md)
class [MoonQuarterInfo](-moon-quarter-info/index.md)(quarter: Int, time: [Time](-time/index.md))
A lunar quarter event (new moon, first quarter, full moon, or third quarter) along with its date and time. | +| [LibrationInfo](-libration-info/index.md)
data class [LibrationInfo](-libration-info/index.md)(elat: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), elon: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), mlat: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), mlon: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), distanceKm: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), diamDeg: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
Lunar libration angles, returned by [libration](libration.md). | +| [LocalSolarEclipseInfo](-local-solar-eclipse-info/index.md)
class [LocalSolarEclipseInfo](-local-solar-eclipse-info/index.md)(kind: [EclipseKind](-eclipse-kind/index.md), obscuration: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), partialBegin: [EclipseEvent](-eclipse-event/index.md), totalBegin: [EclipseEvent](-eclipse-event/index.md)?, peak: [EclipseEvent](-eclipse-event/index.md), totalEnd: [EclipseEvent](-eclipse-event/index.md)?, partialEnd: [EclipseEvent](-eclipse-event/index.md))
Information about a solar eclipse as seen by an observer at a given time and geographic location. | +| [LunarEclipseInfo](-lunar-eclipse-info/index.md)
class [LunarEclipseInfo](-lunar-eclipse-info/index.md)(kind: [EclipseKind](-eclipse-kind/index.md), obscuration: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), peak: [Time](-time/index.md), sdPenum: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), sdPartial: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), sdTotal: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
Information about a lunar eclipse. | +| [MoonQuarterInfo](-moon-quarter-info/index.md)
class [MoonQuarterInfo](-moon-quarter-info/index.md)(quarter: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), time: [Time](-time/index.md))
A lunar quarter event (new moon, first quarter, full moon, or third quarter) along with its date and time. | | [NodeEventInfo](-node-event-info/index.md)
class [NodeEventInfo](-node-event-info/index.md)(time: [Time](-time/index.md), kind: [NodeEventKind](-node-event-kind/index.md))
Information about an ascending or descending node of a body. | -| [NodeEventKind](-node-event-kind/index.md)
enum [NodeEventKind](-node-event-kind/index.md) : Enum<[NodeEventKind](-node-event-kind/index.md)>
Indicates whether a crossing through the ecliptic plane is ascending or descending. | -| [Observer](-observer/index.md)
data class [Observer](-observer/index.md)(latitude: Double, longitude: Double, height: Double)
The location of an observer on (or near) the surface of the Earth. | +| [NodeEventKind](-node-event-kind/index.md)
enum [NodeEventKind](-node-event-kind/index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[NodeEventKind](-node-event-kind/index.md)>
Indicates whether a crossing through the ecliptic plane is ascending or descending. | +| [Observer](-observer/index.md)
data class [Observer](-observer/index.md)(latitude: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), longitude: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), height: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
The location of an observer on (or near) the surface of the Earth. | | [PositionFunction](-position-function/index.md)
fun interface [PositionFunction](-position-function/index.md)
A function for which to solve a light-travel time problem. | -| [Refraction](-refraction/index.md)
enum [Refraction](-refraction/index.md) : Enum<[Refraction](-refraction/index.md)>
Selects whether to correct for atmospheric refraction, and if so, how. | -| [RotationMatrix](-rotation-matrix/index.md)
class [RotationMatrix](-rotation-matrix/index.md)(rot: Array<DoubleArray>)
A rotation matrix that can be used to transform one coordinate system to another. | +| [Refraction](-refraction/index.md)
enum [Refraction](-refraction/index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[Refraction](-refraction/index.md)>
Selects whether to correct for atmospheric refraction, and if so, how. | +| [RotationMatrix](-rotation-matrix/index.md)
class [RotationMatrix](-rotation-matrix/index.md)(rot: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[DoubleArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double-array/index.html)>)
A rotation matrix that can be used to transform one coordinate system to another. | | [SearchContext](-search-context/index.md)
fun interface [SearchContext](-search-context/index.md)
Represents a function whose ascending root is to be found. | | [SeasonsInfo](-seasons-info/index.md)
class [SeasonsInfo](-seasons-info/index.md)(marchEquinox: [Time](-time/index.md), juneSolstice: [Time](-time/index.md), septemberEquinox: [Time](-time/index.md), decemberSolstice: [Time](-time/index.md))
The dates and times of changes of season for a given calendar year. | -| [Spherical](-spherical/index.md)
data class [Spherical](-spherical/index.md)(lat: Double, lon: Double, dist: Double)
Spherical coordinates: latitude, longitude, distance. | -| [StateVector](-state-vector/index.md)
data class [StateVector](-state-vector/index.md)(x: Double, y: Double, z: Double, vx: Double, vy: Double, vz: Double, t: [Time](-time/index.md))
Represents a combined position vector and velocity vector at a given moment in time. | -| [Time](-time/index.md)
class [Time](-time/index.md) : Comparable<[Time](-time/index.md)>
A date and time used for astronomical calculations. | -| [Topocentric](-topocentric/index.md)
data class [Topocentric](-topocentric/index.md)(azimuth: Double, altitude: Double, ra: Double, dec: Double)
Coordinates of a celestial body as seen by a topocentric observer. | -| [TransitInfo](-transit-info/index.md)
class [TransitInfo](-transit-info/index.md)(start: [Time](-time/index.md), peak: [Time](-time/index.md), finish: [Time](-time/index.md), separation: Double)
Information about a transit of Mercury or Venus, as seen from the Earth. | -| [Vector](-vector/index.md)
data class [Vector](-vector/index.md)(x: Double, y: Double, z: Double, t: [Time](-time/index.md))
A 3D Cartesian vector whose components are expressed in Astronomical Units (AU). | -| [Visibility](-visibility/index.md)
enum [Visibility](-visibility/index.md) : Enum<[Visibility](-visibility/index.md)>
Indicates whether a body (especially Mercury or Venus) is best seen in the morning or evening. | +| [Spherical](-spherical/index.md)
data class [Spherical](-spherical/index.md)(lat: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), lon: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), dist: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
Spherical coordinates: latitude, longitude, distance. | +| [StateVector](-state-vector/index.md)
data class [StateVector](-state-vector/index.md)(x: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), y: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), z: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), vx: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), vy: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), vz: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), t: [Time](-time/index.md))
Represents a combined position vector and velocity vector at a given moment in time. | +| [Time](-time/index.md)
class [Time](-time/index.md) : [Comparable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-comparable/index.html)<[Time](-time/index.md)>
A date and time used for astronomical calculations. | +| [Topocentric](-topocentric/index.md)
data class [Topocentric](-topocentric/index.md)(azimuth: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), altitude: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), ra: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), dec: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
Coordinates of a celestial body as seen by a topocentric observer. | +| [TransitInfo](-transit-info/index.md)
class [TransitInfo](-transit-info/index.md)(start: [Time](-time/index.md), peak: [Time](-time/index.md), finish: [Time](-time/index.md), separation: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
Information about a transit of Mercury or Venus, as seen from the Earth. | +| [Vector](-vector/index.md)
data class [Vector](-vector/index.md)(x: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), y: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), z: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), t: [Time](-time/index.md))
A 3D Cartesian vector whose components are expressed in Astronomical Units (AU). | +| [Visibility](-visibility/index.md)
enum [Visibility](-visibility/index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[Visibility](-visibility/index.md)>
Indicates whether a body (especially Mercury or Venus) is best seen in the morning or evening. | ## Functions | Name | Summary | |---|---| -| [angleFromSun](angle-from-sun.md)
fun [angleFromSun](angle-from-sun.md)(body: [Body](-body/index.md), time: [Time](-time/index.md)): Double
Returns the angle between the given body and the Sun, as seen from the Earth. | +| [angleFromSun](angle-from-sun.md)
fun [angleFromSun](angle-from-sun.md)(body: [Body](-body/index.md), time: [Time](-time/index.md)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Returns the angle between the given body and the Sun, as seen from the Earth. | | [backdatePosition](backdate-position.md)
fun [backdatePosition](backdate-position.md)(time: [Time](-time/index.md), observerBody: [Body](-body/index.md), targetBody: [Body](-body/index.md), aberration: [Aberration](-aberration/index.md)): [Vector](-vector/index.md)
Solve for light travel time correction of apparent position. | | [baryState](bary-state.md)
fun [baryState](bary-state.md)(body: [Body](-body/index.md), time: [Time](-time/index.md)): [StateVector](-state-vector/index.md)
Calculates barycentric position and velocity vectors for the given body. | -| [constellation](constellation.md)
fun [constellation](constellation.md)(ra: Double, dec: Double): [ConstellationInfo](-constellation-info/index.md)
Determines the constellation that contains the given point in the sky. | +| [constellation](constellation.md)
fun [constellation](constellation.md)(ra: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), dec: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [ConstellationInfo](-constellation-info/index.md)
Determines the constellation that contains the given point in the sky. | | [correctLightTravel](correct-light-travel.md)
fun [correctLightTravel](correct-light-travel.md)(func: [PositionFunction](-position-function/index.md), time: [Time](-time/index.md)): [Vector](-vector/index.md)
Solve for light travel time of a vector function. | -| [degreesToRadians](degrees-to-radians.md)
fun Double.[degreesToRadians](degrees-to-radians.md)(): Double
Convert an angle expressed in degrees to an angle expressed in radians. | +| [degreesToRadians](degrees-to-radians.md)
fun [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html).[degreesToRadians](degrees-to-radians.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Convert an angle expressed in degrees to an angle expressed in radians. | | [eclipticGeoMoon](ecliptic-geo-moon.md)
fun [eclipticGeoMoon](ecliptic-geo-moon.md)(time: [Time](-time/index.md)): [Spherical](-spherical/index.md)
Calculates spherical ecliptic geocentric position of the Moon. | -| [eclipticLongitude](ecliptic-longitude.md)
fun [eclipticLongitude](ecliptic-longitude.md)(body: [Body](-body/index.md), time: [Time](-time/index.md)): Double
Calculates heliocentric ecliptic longitude of a body based on the J2000 equinox. | +| [eclipticLongitude](ecliptic-longitude.md)
fun [eclipticLongitude](ecliptic-longitude.md)(body: [Body](-body/index.md), time: [Time](-time/index.md)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Calculates heliocentric ecliptic longitude of a body based on the J2000 equinox. | | [elongation](elongation.md)
fun [elongation](elongation.md)(body: [Body](-body/index.md), time: [Time](-time/index.md)): [ElongationInfo](-elongation-info/index.md)
Determines visibility of a celestial body relative to the Sun, as seen from the Earth. | | [equator](equator.md)
fun [equator](equator.md)(body: [Body](-body/index.md), time: [Time](-time/index.md), observer: [Observer](-observer/index.md), equdate: [EquatorEpoch](-equator-epoch/index.md), aberration: [Aberration](-aberration/index.md)): [Equatorial](-equatorial/index.md)
Calculates equatorial coordinates of a celestial body as seen by an observer on the Earth's surface. | | [equatorialToEcliptic](equatorial-to-ecliptic.md)
fun [equatorialToEcliptic](equatorial-to-ecliptic.md)(equ: [Vector](-vector/index.md)): [Ecliptic](-ecliptic/index.md)
Converts J2000 equatorial Cartesian coordinates to J2000 ecliptic coordinates. | @@ -67,24 +67,24 @@ | [geoMoon](geo-moon.md)
fun [geoMoon](geo-moon.md)(time: [Time](-time/index.md)): [Vector](-vector/index.md)
Calculates equatorial geocentric position of the Moon at a given time. | | [geoMoonState](geo-moon-state.md)
fun [geoMoonState](geo-moon-state.md)(time: [Time](-time/index.md)): [StateVector](-state-vector/index.md)
Calculates equatorial geocentric position and velocity of the Moon at a given time. | | [geoVector](geo-vector.md)
fun [geoVector](geo-vector.md)(body: [Body](-body/index.md), time: [Time](-time/index.md), aberration: [Aberration](-aberration/index.md)): [Vector](-vector/index.md)
Calculates geocentric Cartesian coordinates of a body in the J2000 equatorial system. | -| [globalSolarEclipsesAfter](global-solar-eclipses-after.md)
fun [globalSolarEclipsesAfter](global-solar-eclipses-after.md)(startTime: [Time](-time/index.md)): Sequence<[GlobalSolarEclipseInfo](-global-solar-eclipse-info/index.md)>
Enumerates a series of consecutive global solar eclipses that occur after a given time. | -| [helioDistance](helio-distance.md)
fun [helioDistance](helio-distance.md)(body: [Body](-body/index.md), time: [Time](-time/index.md)): Double
Calculates the distance between a body and the Sun at a given time. | +| [globalSolarEclipsesAfter](global-solar-eclipses-after.md)
fun [globalSolarEclipsesAfter](global-solar-eclipses-after.md)(startTime: [Time](-time/index.md)): [Sequence](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.sequences/-sequence/index.html)<[GlobalSolarEclipseInfo](-global-solar-eclipse-info/index.md)>
Enumerates a series of consecutive global solar eclipses that occur after a given time. | +| [helioDistance](helio-distance.md)
fun [helioDistance](helio-distance.md)(body: [Body](-body/index.md), time: [Time](-time/index.md)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Calculates the distance between a body and the Sun at a given time. | | [helioState](helio-state.md)
fun [helioState](helio-state.md)(body: [Body](-body/index.md), time: [Time](-time/index.md)): [StateVector](-state-vector/index.md)
Calculates heliocentric position and velocity vectors for the given body. | | [helioVector](helio-vector.md)
fun [helioVector](helio-vector.md)(body: [Body](-body/index.md), time: [Time](-time/index.md)): [Vector](-vector/index.md)
Calculates heliocentric Cartesian coordinates of a body in the J2000 equatorial system. | -| [horizon](horizon.md)
fun [horizon](horizon.md)(time: [Time](-time/index.md), observer: [Observer](-observer/index.md), ra: Double, dec: Double, refraction: [Refraction](-refraction/index.md)): [Topocentric](-topocentric/index.md)
Calculates the apparent location of a body relative to the local horizon of an observer on the Earth. | +| [horizon](horizon.md)
fun [horizon](horizon.md)(time: [Time](-time/index.md), observer: [Observer](-observer/index.md), ra: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), dec: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), refraction: [Refraction](-refraction/index.md)): [Topocentric](-topocentric/index.md)
Calculates the apparent location of a body relative to the local horizon of an observer on the Earth. | | [illumination](illumination.md)
fun [illumination](illumination.md)(body: [Body](-body/index.md), time: [Time](-time/index.md)): [IlluminationInfo](-illumination-info/index.md)
Finds visual magnitude, phase angle, and other illumination information about a celestial body. | -| [inverseRefractionAngle](inverse-refraction-angle.md)
fun [inverseRefractionAngle](inverse-refraction-angle.md)(refraction: [Refraction](-refraction/index.md), bentAltitude: Double): Double
Calculates the inverse of an atmospheric refraction angle. | +| [inverseRefractionAngle](inverse-refraction-angle.md)
fun [inverseRefractionAngle](inverse-refraction-angle.md)(refraction: [Refraction](-refraction/index.md), bentAltitude: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Calculates the inverse of an atmospheric refraction angle. | | [jupiterMoons](jupiter-moons.md)
fun [jupiterMoons](jupiter-moons.md)(time: [Time](-time/index.md)): [JupiterMoonsInfo](-jupiter-moons-info/index.md)
Calculates jovicentric positions and velocities of Jupiter's largest 4 moons. | -| [lagrangePoint](lagrange-point.md)
fun [lagrangePoint](lagrange-point.md)(point: Int, time: [Time](-time/index.md), majorBody: [Body](-body/index.md), minorBody: [Body](-body/index.md)): [StateVector](-state-vector/index.md)
Calculates one of the 5 Lagrange points for a pair of co-orbiting bodies. | -| [lagrangePointFast](lagrange-point-fast.md)
fun [lagrangePointFast](lagrange-point-fast.md)(point: Int, majorState: [StateVector](-state-vector/index.md), majorMass: Double, minorState: [StateVector](-state-vector/index.md), minorMass: Double): [StateVector](-state-vector/index.md)
Calculates one of the 5 Lagrange points from body masses and state vectors. | +| [lagrangePoint](lagrange-point.md)
fun [lagrangePoint](lagrange-point.md)(point: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), time: [Time](-time/index.md), majorBody: [Body](-body/index.md), minorBody: [Body](-body/index.md)): [StateVector](-state-vector/index.md)
Calculates one of the 5 Lagrange points for a pair of co-orbiting bodies. | +| [lagrangePointFast](lagrange-point-fast.md)
fun [lagrangePointFast](lagrange-point-fast.md)(point: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), majorState: [StateVector](-state-vector/index.md), majorMass: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), minorState: [StateVector](-state-vector/index.md), minorMass: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [StateVector](-state-vector/index.md)
Calculates one of the 5 Lagrange points from body masses and state vectors. | | [libration](libration.md)
fun [libration](libration.md)(time: [Time](-time/index.md)): [LibrationInfo](-libration-info/index.md)
Calculates the Moon's libration angles at a given moment in time. | -| [localSolarEclipsesAfter](local-solar-eclipses-after.md)
fun [localSolarEclipsesAfter](local-solar-eclipses-after.md)(startTime: [Time](-time/index.md), observer: [Observer](-observer/index.md)): Sequence<[LocalSolarEclipseInfo](-local-solar-eclipse-info/index.md)>
Enumerates a series of consecutive local solar eclipses that occur after a given time. | -| [lunarApsidesAfter](lunar-apsides-after.md)
fun [lunarApsidesAfter](lunar-apsides-after.md)(startTime: [Time](-time/index.md)): Sequence<[ApsisInfo](-apsis-info/index.md)>
Enumerates a series of consecutive lunar apsides that occur after a given time. | -| [lunarEclipsesAfter](lunar-eclipses-after.md)
fun [lunarEclipsesAfter](lunar-eclipses-after.md)(startTime: [Time](-time/index.md)): Sequence<[LunarEclipseInfo](-lunar-eclipse-info/index.md)>
Enumerates a series of consecutive lunar eclipses that occur after a given time. | -| [massProduct](mass-product.md)
fun [massProduct](mass-product.md)(body: [Body](-body/index.md)): Double
Returns the product of mass and universal gravitational constant of a Solar System body. | -| [moonNodesAfter](moon-nodes-after.md)
fun [moonNodesAfter](moon-nodes-after.md)(startTime: [Time](-time/index.md)): Sequence<[NodeEventInfo](-node-event-info/index.md)>
Enumerates a series of consecutive ascending/descending nodes of the Moon. | -| [moonPhase](moon-phase.md)
fun [moonPhase](moon-phase.md)(time: [Time](-time/index.md)): Double
Returns the Moon's phase as an angle from 0 to 360 degrees. | -| [moonQuartersAfter](moon-quarters-after.md)
fun [moonQuartersAfter](moon-quarters-after.md)(startTime: [Time](-time/index.md)): Sequence<[MoonQuarterInfo](-moon-quarter-info/index.md)>
Enumerates a series of consecutive moon quarter phase events. | +| [localSolarEclipsesAfter](local-solar-eclipses-after.md)
fun [localSolarEclipsesAfter](local-solar-eclipses-after.md)(startTime: [Time](-time/index.md), observer: [Observer](-observer/index.md)): [Sequence](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.sequences/-sequence/index.html)<[LocalSolarEclipseInfo](-local-solar-eclipse-info/index.md)>
Enumerates a series of consecutive local solar eclipses that occur after a given time. | +| [lunarApsidesAfter](lunar-apsides-after.md)
fun [lunarApsidesAfter](lunar-apsides-after.md)(startTime: [Time](-time/index.md)): [Sequence](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.sequences/-sequence/index.html)<[ApsisInfo](-apsis-info/index.md)>
Enumerates a series of consecutive lunar apsides that occur after a given time. | +| [lunarEclipsesAfter](lunar-eclipses-after.md)
fun [lunarEclipsesAfter](lunar-eclipses-after.md)(startTime: [Time](-time/index.md)): [Sequence](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.sequences/-sequence/index.html)<[LunarEclipseInfo](-lunar-eclipse-info/index.md)>
Enumerates a series of consecutive lunar eclipses that occur after a given time. | +| [massProduct](mass-product.md)
fun [massProduct](mass-product.md)(body: [Body](-body/index.md)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Returns the product of mass and universal gravitational constant of a Solar System body. | +| [moonNodesAfter](moon-nodes-after.md)
fun [moonNodesAfter](moon-nodes-after.md)(startTime: [Time](-time/index.md)): [Sequence](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.sequences/-sequence/index.html)<[NodeEventInfo](-node-event-info/index.md)>
Enumerates a series of consecutive ascending/descending nodes of the Moon. | +| [moonPhase](moon-phase.md)
fun [moonPhase](moon-phase.md)(time: [Time](-time/index.md)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Returns the Moon's phase as an angle from 0 to 360 degrees. | +| [moonQuartersAfter](moon-quarters-after.md)
fun [moonQuartersAfter](moon-quarters-after.md)(startTime: [Time](-time/index.md)): [Sequence](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.sequences/-sequence/index.html)<[MoonQuarterInfo](-moon-quarter-info/index.md)>
Enumerates a series of consecutive moon quarter phase events. | | [nextGlobalSolarEclipse](next-global-solar-eclipse.md)
fun [nextGlobalSolarEclipse](next-global-solar-eclipse.md)(prevEclipseTime: [Time](-time/index.md)): [GlobalSolarEclipseInfo](-global-solar-eclipse-info/index.md)
Searches for the next global solar eclipse in a series. | | [nextLocalSolarEclipse](next-local-solar-eclipse.md)
fun [nextLocalSolarEclipse](next-local-solar-eclipse.md)(prevEclipseTime: [Time](-time/index.md), observer: [Observer](-observer/index.md)): [LocalSolarEclipseInfo](-local-solar-eclipse-info/index.md)
Searches for the next local solar eclipse in a series. | | [nextLunarApsis](next-lunar-apsis.md)
fun [nextLunarApsis](next-lunar-apsis.md)(apsis: [ApsisInfo](-apsis-info/index.md)): [ApsisInfo](-apsis-info/index.md)
Finds the next lunar perigee or apogee event in a series. | @@ -93,12 +93,12 @@ | [nextMoonQuarter](next-moon-quarter.md)
fun [nextMoonQuarter](next-moon-quarter.md)(mq: [MoonQuarterInfo](-moon-quarter-info/index.md)): [MoonQuarterInfo](-moon-quarter-info/index.md)
Continues searching for lunar quarters from a previous search. | | [nextPlanetApsis](next-planet-apsis.md)
fun [nextPlanetApsis](next-planet-apsis.md)(body: [Body](-body/index.md), apsis: [ApsisInfo](-apsis-info/index.md)): [ApsisInfo](-apsis-info/index.md)
Finds the next planetary perihelion or aphelion event in a series. | | [nextTransit](next-transit.md)
fun [nextTransit](next-transit.md)(body: [Body](-body/index.md), prevTransitTime: [Time](-time/index.md)): [TransitInfo](-transit-info/index.md)
Searches for another transit of Mercury or Venus. | -| [observerGravity](observer-gravity.md)
fun [observerGravity](observer-gravity.md)(latitude: Double, height: Double): Double
Calculates the gravitational acceleration experienced by an observer on the Earth. | -| [pairLongitude](pair-longitude.md)
fun [pairLongitude](pair-longitude.md)(body1: [Body](-body/index.md), body2: [Body](-body/index.md), time: [Time](-time/index.md)): Double
Returns one body's ecliptic longitude with respect to another, as seen from the Earth. | -| [planetApsidesAfter](planet-apsides-after.md)
fun [planetApsidesAfter](planet-apsides-after.md)(body: [Body](-body/index.md), startTime: [Time](-time/index.md)): Sequence<[ApsisInfo](-apsis-info/index.md)>
Enumerates a series of consecutive planetary perihelia/aphelia events. | -| [planetOrbitalPeriod](planet-orbital-period.md)
fun [planetOrbitalPeriod](planet-orbital-period.md)(body: [Body](-body/index.md)): Double
Returns the average number of days it takes for a planet to orbit the Sun. | -| [radiansToDegrees](radians-to-degrees.md)
fun Double.[radiansToDegrees](radians-to-degrees.md)(): Double
Convert an angle expressed in radians to an angle expressed in degrees. | -| [refractionAngle](refraction-angle.md)
fun [refractionAngle](refraction-angle.md)(refraction: [Refraction](-refraction/index.md), altitude: Double): Double
Calculates the amount of "lift" to an altitude angle caused by atmospheric refraction. | +| [observerGravity](observer-gravity.md)
fun [observerGravity](observer-gravity.md)(latitude: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), height: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Calculates the gravitational acceleration experienced by an observer on the Earth. | +| [pairLongitude](pair-longitude.md)
fun [pairLongitude](pair-longitude.md)(body1: [Body](-body/index.md), body2: [Body](-body/index.md), time: [Time](-time/index.md)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Returns one body's ecliptic longitude with respect to another, as seen from the Earth. | +| [planetApsidesAfter](planet-apsides-after.md)
fun [planetApsidesAfter](planet-apsides-after.md)(body: [Body](-body/index.md), startTime: [Time](-time/index.md)): [Sequence](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.sequences/-sequence/index.html)<[ApsisInfo](-apsis-info/index.md)>
Enumerates a series of consecutive planetary perihelia/aphelia events. | +| [planetOrbitalPeriod](planet-orbital-period.md)
fun [planetOrbitalPeriod](planet-orbital-period.md)(body: [Body](-body/index.md)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Returns the average number of days it takes for a planet to orbit the Sun. | +| [radiansToDegrees](radians-to-degrees.md)
fun [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html).[radiansToDegrees](radians-to-degrees.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Convert an angle expressed in radians to an angle expressed in degrees. | +| [refractionAngle](refraction-angle.md)
fun [refractionAngle](refraction-angle.md)(refraction: [Refraction](-refraction/index.md), altitude: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Calculates the amount of "lift" to an altitude angle caused by atmospheric refraction. | | [rotationAxis](rotation-axis.md)
fun [rotationAxis](rotation-axis.md)(body: [Body](-body/index.md), time: [Time](-time/index.md)): [AxisInfo](-axis-info/index.md)
Calculates information about a body's rotation axis at a given time. | | [rotationEclEqd](rotation-ecl-eqd.md)
fun [rotationEclEqd](rotation-ecl-eqd.md)(time: [Time](-time/index.md)): [RotationMatrix](-rotation-matrix/index.md)
Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial of-date (EQD). | | [rotationEclEqj](rotation-ecl-eqj.md)
fun [rotationEclEqj](rotation-ecl-eqj.md)(): [RotationMatrix](-rotation-matrix/index.md)
Calculates a rotation matrix from ecliptic J2000 (ECL) to equatorial J2000 (EQJ). | @@ -114,46 +114,46 @@ | [rotationHorEcl](rotation-hor-ecl.md)
fun [rotationHorEcl](rotation-hor-ecl.md)(time: [Time](-time/index.md), observer: [Observer](-observer/index.md)): [RotationMatrix](-rotation-matrix/index.md)
Calculates a rotation matrix from horizontal (HOR) to ecliptic J2000 (ECL). | | [rotationHorEqd](rotation-hor-eqd.md)
fun [rotationHorEqd](rotation-hor-eqd.md)(time: [Time](-time/index.md), observer: [Observer](-observer/index.md)): [RotationMatrix](-rotation-matrix/index.md)
Calculates a rotation matrix from horizontal (HOR) to equatorial of-date (EQD). | | [rotationHorEqj](rotation-hor-eqj.md)
fun [rotationHorEqj](rotation-hor-eqj.md)(time: [Time](-time/index.md), observer: [Observer](-observer/index.md)): [RotationMatrix](-rotation-matrix/index.md)
Calculates a rotation matrix from horizontal (HOR) to J2000 equatorial (EQJ). This is one of the family of functions that returns a rotation matrix for converting from one orientation to another. Source: HOR = horizontal system (x=North, y=West, z=Zenith). Target: EQJ = equatorial system, using equator at the J2000 epoch. | -| [search](search.md)
fun [search](search.md)(time1: [Time](-time/index.md), time2: [Time](-time/index.md), toleranceSeconds: Double, func: [SearchContext](-search-context/index.md)): [Time](-time/index.md)?
Searches for a time at which a function's value increases through zero. | -| [searchAltitude](search-altitude.md)
fun [searchAltitude](search-altitude.md)(body: [Body](-body/index.md), observer: [Observer](-observer/index.md), direction: [Direction](-direction/index.md), startTime: [Time](-time/index.md), limitDays: Double, altitude: Double): [Time](-time/index.md)?
Finds the next time a body reaches a given altitude. | +| [search](search.md)
fun [search](search.md)(time1: [Time](-time/index.md), time2: [Time](-time/index.md), toleranceSeconds: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), func: [SearchContext](-search-context/index.md)): [Time](-time/index.md)?
Searches for a time at which a function's value increases through zero. | +| [searchAltitude](search-altitude.md)
fun [searchAltitude](search-altitude.md)(body: [Body](-body/index.md), observer: [Observer](-observer/index.md), direction: [Direction](-direction/index.md), startTime: [Time](-time/index.md), limitDays: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), altitude: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [Time](-time/index.md)?
Finds the next time a body reaches a given altitude. | | [searchGlobalSolarEclipse](search-global-solar-eclipse.md)
fun [searchGlobalSolarEclipse](search-global-solar-eclipse.md)(startTime: [Time](-time/index.md)): [GlobalSolarEclipseInfo](-global-solar-eclipse-info/index.md)
Searches for a solar eclipse visible anywhere on the Earth's surface. | -| [searchHourAngle](search-hour-angle.md)
fun [searchHourAngle](search-hour-angle.md)(body: [Body](-body/index.md), observer: [Observer](-observer/index.md), hourAngle: Double, startTime: [Time](-time/index.md), direction: Int = +1): [HourAngleInfo](-hour-angle-info/index.md)
Searches for the time when a celestial body reaches a specified hour angle as seen by an observer on the Earth. | +| [searchHourAngle](search-hour-angle.md)
fun [searchHourAngle](search-hour-angle.md)(body: [Body](-body/index.md), observer: [Observer](-observer/index.md), hourAngle: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), startTime: [Time](-time/index.md), direction: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = +1): [HourAngleInfo](-hour-angle-info/index.md)
Searches for the time when a celestial body reaches a specified hour angle as seen by an observer on the Earth. | | [searchLocalSolarEclipse](search-local-solar-eclipse.md)
fun [searchLocalSolarEclipse](search-local-solar-eclipse.md)(startTime: [Time](-time/index.md), observer: [Observer](-observer/index.md)): [LocalSolarEclipseInfo](-local-solar-eclipse-info/index.md)
Searches for a solar eclipse visible at a specific location on the Earth's surface. | | [searchLunarApsis](search-lunar-apsis.md)
fun [searchLunarApsis](search-lunar-apsis.md)(startTime: [Time](-time/index.md)): [ApsisInfo](-apsis-info/index.md)
Finds the date and time of the Moon's perigee or apogee. | | [searchLunarEclipse](search-lunar-eclipse.md)
fun [searchLunarEclipse](search-lunar-eclipse.md)(startTime: [Time](-time/index.md)): [LunarEclipseInfo](-lunar-eclipse-info/index.md)
Searches for a lunar eclipse. | | [searchMaxElongation](search-max-elongation.md)
fun [searchMaxElongation](search-max-elongation.md)(body: [Body](-body/index.md), startTime: [Time](-time/index.md)): [ElongationInfo](-elongation-info/index.md)
Finds a date and time when Mercury or Venus reaches its maximum angle from the Sun as seen from the Earth. | | [searchMoonNode](search-moon-node.md)
fun [searchMoonNode](search-moon-node.md)(startTime: [Time](-time/index.md)): [NodeEventInfo](-node-event-info/index.md)
Searches for a time when the Moon's center crosses through the ecliptic plane. | -| [searchMoonPhase](search-moon-phase.md)
fun [searchMoonPhase](search-moon-phase.md)(targetLon: Double, startTime: [Time](-time/index.md), limitDays: Double): [Time](-time/index.md)?
Searches for the time that the Moon reaches a specified phase. | +| [searchMoonPhase](search-moon-phase.md)
fun [searchMoonPhase](search-moon-phase.md)(targetLon: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), startTime: [Time](-time/index.md), limitDays: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [Time](-time/index.md)?
Searches for the time that the Moon reaches a specified phase. | | [searchMoonQuarter](search-moon-quarter.md)
fun [searchMoonQuarter](search-moon-quarter.md)(startTime: [Time](-time/index.md)): [MoonQuarterInfo](-moon-quarter-info/index.md)
Finds the first lunar quarter after the specified date and time. A lunar quarter is one of the following four lunar phase events: new moon, first quarter, full moon, third quarter. This function finds the lunar quarter that happens soonest after the specified date and time. | | [searchPeakMagnitude](search-peak-magnitude.md)
fun [searchPeakMagnitude](search-peak-magnitude.md)(body: [Body](-body/index.md), startTime: [Time](-time/index.md)): [IlluminationInfo](-illumination-info/index.md)
Searches for the date and time Venus will next appear brightest as seen from the Earth. | | [searchPlanetApsis](search-planet-apsis.md)
fun [searchPlanetApsis](search-planet-apsis.md)(body: [Body](-body/index.md), startTime: [Time](-time/index.md)): [ApsisInfo](-apsis-info/index.md)
Finds the first aphelion or perihelion for a planet after a given time. | -| [searchRelativeLongitude](search-relative-longitude.md)
fun [searchRelativeLongitude](search-relative-longitude.md)(body: [Body](-body/index.md), targetRelativeLongitude: Double, startTime: [Time](-time/index.md)): [Time](-time/index.md)
Searches for the time when the Earth and another planet are separated by a specified angle in ecliptic longitude, as seen from the Sun. | -| [searchRiseSet](search-rise-set.md)
fun [searchRiseSet](search-rise-set.md)(body: [Body](-body/index.md), observer: [Observer](-observer/index.md), direction: [Direction](-direction/index.md), startTime: [Time](-time/index.md), limitDays: Double): [Time](-time/index.md)?
Searches for the next time a celestial body rises or sets as seen by an observer on the Earth. | -| [searchSunLongitude](search-sun-longitude.md)
fun [searchSunLongitude](search-sun-longitude.md)(targetLon: Double, startTime: [Time](-time/index.md), limitDays: Double): [Time](-time/index.md)?
Searches for the time when the Sun reaches an apparent ecliptic longitude as seen from the Earth. | +| [searchRelativeLongitude](search-relative-longitude.md)
fun [searchRelativeLongitude](search-relative-longitude.md)(body: [Body](-body/index.md), targetRelativeLongitude: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), startTime: [Time](-time/index.md)): [Time](-time/index.md)
Searches for the time when the Earth and another planet are separated by a specified angle in ecliptic longitude, as seen from the Sun. | +| [searchRiseSet](search-rise-set.md)
fun [searchRiseSet](search-rise-set.md)(body: [Body](-body/index.md), observer: [Observer](-observer/index.md), direction: [Direction](-direction/index.md), startTime: [Time](-time/index.md), limitDays: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [Time](-time/index.md)?
Searches for the next time a celestial body rises or sets as seen by an observer on the Earth. | +| [searchSunLongitude](search-sun-longitude.md)
fun [searchSunLongitude](search-sun-longitude.md)(targetLon: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), startTime: [Time](-time/index.md), limitDays: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [Time](-time/index.md)?
Searches for the time when the Sun reaches an apparent ecliptic longitude as seen from the Earth. | | [searchTransit](search-transit.md)
fun [searchTransit](search-transit.md)(body: [Body](-body/index.md), startTime: [Time](-time/index.md)): [TransitInfo](-transit-info/index.md)
Searches for the first transit of Mercury or Venus after a given date. | -| [seasons](seasons.md)
fun [seasons](seasons.md)(year: Int): [SeasonsInfo](-seasons-info/index.md)
Finds both equinoxes and both solstices for a given calendar year. | -| [siderealTime](sidereal-time.md)
fun [siderealTime](sidereal-time.md)(time: [Time](-time/index.md)): Double
Calculates Greenwich Apparent Sidereal Time (GAST). | +| [seasons](seasons.md)
fun [seasons](seasons.md)(year: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [SeasonsInfo](-seasons-info/index.md)
Finds both equinoxes and both solstices for a given calendar year. | +| [siderealTime](sidereal-time.md)
fun [siderealTime](sidereal-time.md)(time: [Time](-time/index.md)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Calculates Greenwich Apparent Sidereal Time (GAST). | | [sunPosition](sun-position.md)
fun [sunPosition](sun-position.md)(time: [Time](-time/index.md)): [Ecliptic](-ecliptic/index.md)
Calculates geocentric ecliptic coordinates for the Sun. | -| [times](times.md)
operator fun Double.[times](times.md)(vec: [Vector](-vector/index.md)): [Vector](-vector/index.md)
Multiply a scalar by a vector, yielding another vector. | -| [transitsAfter](transits-after.md)
fun [transitsAfter](transits-after.md)(body: [Body](-body/index.md), startTime: [Time](-time/index.md)): Sequence<[TransitInfo](-transit-info/index.md)>
Enumerates a series of consecutive transits of Mercury or Venus. | +| [times](times.md)
operator fun [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html).[times](times.md)(vec: [Vector](-vector/index.md)): [Vector](-vector/index.md)
Multiply a scalar by a vector, yielding another vector. | +| [transitsAfter](transits-after.md)
fun [transitsAfter](transits-after.md)(body: [Body](-body/index.md), startTime: [Time](-time/index.md)): [Sequence](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.sequences/-sequence/index.html)<[TransitInfo](-transit-info/index.md)>
Enumerates a series of consecutive transits of Mercury or Venus. | ## Properties | Name | Summary | |---|---| -| [C_AUDAY](-c_-a-u-d-a-y.md)
const val [C_AUDAY](-c_-a-u-d-a-y.md): Double = 173.1446326846693
The speed of light in AU/day. | -| [CALLISTO_RADIUS_KM](-c-a-l-l-i-s-t-o_-r-a-d-i-u-s_-k-m.md)
const val [CALLISTO_RADIUS_KM](-c-a-l-l-i-s-t-o_-r-a-d-i-u-s_-k-m.md): Double = 2410.3
The mean radius of Jupiter's moon Callisto, expressed in kilometers. | -| [DEG2RAD](-d-e-g2-r-a-d.md)
const val [DEG2RAD](-d-e-g2-r-a-d.md): Double = 0.017453292519943295
The factor to convert degrees to radians = pi/180. | -| [EUROPA_RADIUS_KM](-e-u-r-o-p-a_-r-a-d-i-u-s_-k-m.md)
const val [EUROPA_RADIUS_KM](-e-u-r-o-p-a_-r-a-d-i-u-s_-k-m.md): Double = 1560.8
The mean radius of Jupiter's moon Europa, expressed in kilometers. | -| [GANYMEDE_RADIUS_KM](-g-a-n-y-m-e-d-e_-r-a-d-i-u-s_-k-m.md)
const val [GANYMEDE_RADIUS_KM](-g-a-n-y-m-e-d-e_-r-a-d-i-u-s_-k-m.md): Double = 2631.2
The mean radius of Jupiter's moon Ganymede, expressed in kilometers. | -| [HOUR2RAD](-h-o-u-r2-r-a-d.md)
const val [HOUR2RAD](-h-o-u-r2-r-a-d.md): Double = 0.26179938779914946
The factor to convert sidereal hours to radians = pi/12. | -| [IO_RADIUS_KM](-i-o_-r-a-d-i-u-s_-k-m.md)
const val [IO_RADIUS_KM](-i-o_-r-a-d-i-u-s_-k-m.md): Double = 1821.6
The mean radius of Jupiter's moon Io, expressed in kilometers. | -| [JUPITER_EQUATORIAL_RADIUS_KM](-j-u-p-i-t-e-r_-e-q-u-a-t-o-r-i-a-l_-r-a-d-i-u-s_-k-m.md)
const val [JUPITER_EQUATORIAL_RADIUS_KM](-j-u-p-i-t-e-r_-e-q-u-a-t-o-r-i-a-l_-r-a-d-i-u-s_-k-m.md): Double = 71492.0
The equatorial radius of Jupiter, expressed in kilometers. | -| [JUPITER_MEAN_RADIUS_KM](-j-u-p-i-t-e-r_-m-e-a-n_-r-a-d-i-u-s_-k-m.md)
const val [JUPITER_MEAN_RADIUS_KM](-j-u-p-i-t-e-r_-m-e-a-n_-r-a-d-i-u-s_-k-m.md): Double = 69911.0
The volumetric mean radius of Jupiter, expressed in kilometers. | -| [JUPITER_POLAR_RADIUS_KM](-j-u-p-i-t-e-r_-p-o-l-a-r_-r-a-d-i-u-s_-k-m.md)
const val [JUPITER_POLAR_RADIUS_KM](-j-u-p-i-t-e-r_-p-o-l-a-r_-r-a-d-i-u-s_-k-m.md): Double = 66854.0
The polar radius of Jupiter, expressed in kilometers. | -| [KM_PER_AU](-k-m_-p-e-r_-a-u.md)
const val [KM_PER_AU](-k-m_-p-e-r_-a-u.md): Double = 1.4959787069098932E8
The number of kilometers in one astronomical unit (AU). | -| [MILLISECONDS_PER_DAY](-m-i-l-l-i-s-e-c-o-n-d-s_-p-e-r_-d-a-y.md)
const val [MILLISECONDS_PER_DAY](-m-i-l-l-i-s-e-c-o-n-d-s_-p-e-r_-d-a-y.md): Double
The number of milliseconds in a day. | -| [MINUTES_PER_DAY](-m-i-n-u-t-e-s_-p-e-r_-d-a-y.md)
const val [MINUTES_PER_DAY](-m-i-n-u-t-e-s_-p-e-r_-d-a-y.md): Double
The number of minutes in a day. | -| [RAD2DEG](-r-a-d2-d-e-g.md)
const val [RAD2DEG](-r-a-d2-d-e-g.md): Double = 57.29577951308232
The factor to convert radians to degrees = 180/pi. | -| [RAD2HOUR](-r-a-d2-h-o-u-r.md)
const val [RAD2HOUR](-r-a-d2-h-o-u-r.md): Double = 3.819718634205488
The factor to convert radians to sidereal hours = 12/pi. | -| [SECONDS_PER_DAY](-s-e-c-o-n-d-s_-p-e-r_-d-a-y.md)
const val [SECONDS_PER_DAY](-s-e-c-o-n-d-s_-p-e-r_-d-a-y.md): Double
The number of seconds in a day. | +| [C_AUDAY](-c_-a-u-d-a-y.md)
const val [C_AUDAY](-c_-a-u-d-a-y.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) = 173.1446326846693
The speed of light in AU/day. | +| [CALLISTO_RADIUS_KM](-c-a-l-l-i-s-t-o_-r-a-d-i-u-s_-k-m.md)
const val [CALLISTO_RADIUS_KM](-c-a-l-l-i-s-t-o_-r-a-d-i-u-s_-k-m.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) = 2410.3
The mean radius of Jupiter's moon Callisto, expressed in kilometers. | +| [DEG2RAD](-d-e-g2-r-a-d.md)
const val [DEG2RAD](-d-e-g2-r-a-d.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) = 0.017453292519943295
The factor to convert degrees to radians = pi/180. | +| [EUROPA_RADIUS_KM](-e-u-r-o-p-a_-r-a-d-i-u-s_-k-m.md)
const val [EUROPA_RADIUS_KM](-e-u-r-o-p-a_-r-a-d-i-u-s_-k-m.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) = 1560.8
The mean radius of Jupiter's moon Europa, expressed in kilometers. | +| [GANYMEDE_RADIUS_KM](-g-a-n-y-m-e-d-e_-r-a-d-i-u-s_-k-m.md)
const val [GANYMEDE_RADIUS_KM](-g-a-n-y-m-e-d-e_-r-a-d-i-u-s_-k-m.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) = 2631.2
The mean radius of Jupiter's moon Ganymede, expressed in kilometers. | +| [HOUR2RAD](-h-o-u-r2-r-a-d.md)
const val [HOUR2RAD](-h-o-u-r2-r-a-d.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) = 0.26179938779914946
The factor to convert sidereal hours to radians = pi/12. | +| [IO_RADIUS_KM](-i-o_-r-a-d-i-u-s_-k-m.md)
const val [IO_RADIUS_KM](-i-o_-r-a-d-i-u-s_-k-m.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) = 1821.6
The mean radius of Jupiter's moon Io, expressed in kilometers. | +| [JUPITER_EQUATORIAL_RADIUS_KM](-j-u-p-i-t-e-r_-e-q-u-a-t-o-r-i-a-l_-r-a-d-i-u-s_-k-m.md)
const val [JUPITER_EQUATORIAL_RADIUS_KM](-j-u-p-i-t-e-r_-e-q-u-a-t-o-r-i-a-l_-r-a-d-i-u-s_-k-m.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) = 71492.0
The equatorial radius of Jupiter, expressed in kilometers. | +| [JUPITER_MEAN_RADIUS_KM](-j-u-p-i-t-e-r_-m-e-a-n_-r-a-d-i-u-s_-k-m.md)
const val [JUPITER_MEAN_RADIUS_KM](-j-u-p-i-t-e-r_-m-e-a-n_-r-a-d-i-u-s_-k-m.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) = 69911.0
The volumetric mean radius of Jupiter, expressed in kilometers. | +| [JUPITER_POLAR_RADIUS_KM](-j-u-p-i-t-e-r_-p-o-l-a-r_-r-a-d-i-u-s_-k-m.md)
const val [JUPITER_POLAR_RADIUS_KM](-j-u-p-i-t-e-r_-p-o-l-a-r_-r-a-d-i-u-s_-k-m.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) = 66854.0
The polar radius of Jupiter, expressed in kilometers. | +| [KM_PER_AU](-k-m_-p-e-r_-a-u.md)
const val [KM_PER_AU](-k-m_-p-e-r_-a-u.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) = 1.4959787069098932E8
The number of kilometers in one astronomical unit (AU). | +| [MILLISECONDS_PER_DAY](-m-i-l-l-i-s-e-c-o-n-d-s_-p-e-r_-d-a-y.md)
const val [MILLISECONDS_PER_DAY](-m-i-l-l-i-s-e-c-o-n-d-s_-p-e-r_-d-a-y.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
The number of milliseconds in a day. | +| [MINUTES_PER_DAY](-m-i-n-u-t-e-s_-p-e-r_-d-a-y.md)
const val [MINUTES_PER_DAY](-m-i-n-u-t-e-s_-p-e-r_-d-a-y.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
The number of minutes in a day. | +| [RAD2DEG](-r-a-d2-d-e-g.md)
const val [RAD2DEG](-r-a-d2-d-e-g.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) = 57.29577951308232
The factor to convert radians to degrees = 180/pi. | +| [RAD2HOUR](-r-a-d2-h-o-u-r.md)
const val [RAD2HOUR](-r-a-d2-h-o-u-r.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) = 3.819718634205488
The factor to convert radians to sidereal hours = 12/pi. | +| [SECONDS_PER_DAY](-s-e-c-o-n-d-s_-p-e-r_-d-a-y.md)
const val [SECONDS_PER_DAY](-s-e-c-o-n-d-s_-p-e-r_-d-a-y.md): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
The number of seconds in a day. | diff --git a/source/kotlin/doc/inverse-refraction-angle.md b/source/kotlin/doc/inverse-refraction-angle.md index e7a259fa..a9a7579c 100644 --- a/source/kotlin/doc/inverse-refraction-angle.md +++ b/source/kotlin/doc/inverse-refraction-angle.md @@ -2,7 +2,7 @@ # inverseRefractionAngle -fun [inverseRefractionAngle](inverse-refraction-angle.md)(refraction: [Refraction](-refraction/index.md), bentAltitude: Double): Double +fun [inverseRefractionAngle](inverse-refraction-angle.md)(refraction: [Refraction](-refraction/index.md), bentAltitude: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) Calculates the inverse of an atmospheric refraction angle. diff --git a/source/kotlin/doc/lagrange-point-fast.md b/source/kotlin/doc/lagrange-point-fast.md index 35bd4bef..61700393 100644 --- a/source/kotlin/doc/lagrange-point-fast.md +++ b/source/kotlin/doc/lagrange-point-fast.md @@ -2,7 +2,7 @@ # lagrangePointFast -fun [lagrangePointFast](lagrange-point-fast.md)(point: Int, majorState: [StateVector](-state-vector/index.md), majorMass: Double, minorState: [StateVector](-state-vector/index.md), minorMass: Double): [StateVector](-state-vector/index.md) +fun [lagrangePointFast](lagrange-point-fast.md)(point: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), majorState: [StateVector](-state-vector/index.md), majorMass: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), minorState: [StateVector](-state-vector/index.md), minorMass: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [StateVector](-state-vector/index.md) Calculates one of the 5 Lagrange points from body masses and state vectors. diff --git a/source/kotlin/doc/lagrange-point.md b/source/kotlin/doc/lagrange-point.md index c628cade..64230139 100644 --- a/source/kotlin/doc/lagrange-point.md +++ b/source/kotlin/doc/lagrange-point.md @@ -2,7 +2,7 @@ # lagrangePoint -fun [lagrangePoint](lagrange-point.md)(point: Int, time: [Time](-time/index.md), majorBody: [Body](-body/index.md), minorBody: [Body](-body/index.md)): [StateVector](-state-vector/index.md) +fun [lagrangePoint](lagrange-point.md)(point: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), time: [Time](-time/index.md), majorBody: [Body](-body/index.md), minorBody: [Body](-body/index.md)): [StateVector](-state-vector/index.md) Calculates one of the 5 Lagrange points for a pair of co-orbiting bodies. diff --git a/source/kotlin/doc/local-solar-eclipses-after.md b/source/kotlin/doc/local-solar-eclipses-after.md index adcac63c..d2e02b1c 100644 --- a/source/kotlin/doc/local-solar-eclipses-after.md +++ b/source/kotlin/doc/local-solar-eclipses-after.md @@ -2,7 +2,7 @@ # localSolarEclipsesAfter -fun [localSolarEclipsesAfter](local-solar-eclipses-after.md)(startTime: [Time](-time/index.md), observer: [Observer](-observer/index.md)): Sequence<[LocalSolarEclipseInfo](-local-solar-eclipse-info/index.md)> +fun [localSolarEclipsesAfter](local-solar-eclipses-after.md)(startTime: [Time](-time/index.md), observer: [Observer](-observer/index.md)): [Sequence](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.sequences/-sequence/index.html)<[LocalSolarEclipseInfo](-local-solar-eclipse-info/index.md)> Enumerates a series of consecutive local solar eclipses that occur after a given time. diff --git a/source/kotlin/doc/lunar-apsides-after.md b/source/kotlin/doc/lunar-apsides-after.md index f15b7cea..19cf6387 100644 --- a/source/kotlin/doc/lunar-apsides-after.md +++ b/source/kotlin/doc/lunar-apsides-after.md @@ -2,7 +2,7 @@ # lunarApsidesAfter -fun [lunarApsidesAfter](lunar-apsides-after.md)(startTime: [Time](-time/index.md)): Sequence<[ApsisInfo](-apsis-info/index.md)> +fun [lunarApsidesAfter](lunar-apsides-after.md)(startTime: [Time](-time/index.md)): [Sequence](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.sequences/-sequence/index.html)<[ApsisInfo](-apsis-info/index.md)> Enumerates a series of consecutive lunar apsides that occur after a given time. diff --git a/source/kotlin/doc/lunar-eclipses-after.md b/source/kotlin/doc/lunar-eclipses-after.md index ba18ae12..9cc3fad2 100644 --- a/source/kotlin/doc/lunar-eclipses-after.md +++ b/source/kotlin/doc/lunar-eclipses-after.md @@ -2,7 +2,7 @@ # lunarEclipsesAfter -fun [lunarEclipsesAfter](lunar-eclipses-after.md)(startTime: [Time](-time/index.md)): Sequence<[LunarEclipseInfo](-lunar-eclipse-info/index.md)> +fun [lunarEclipsesAfter](lunar-eclipses-after.md)(startTime: [Time](-time/index.md)): [Sequence](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.sequences/-sequence/index.html)<[LunarEclipseInfo](-lunar-eclipse-info/index.md)> Enumerates a series of consecutive lunar eclipses that occur after a given time. diff --git a/source/kotlin/doc/mass-product.md b/source/kotlin/doc/mass-product.md index a6ca6d1e..52116202 100644 --- a/source/kotlin/doc/mass-product.md +++ b/source/kotlin/doc/mass-product.md @@ -2,7 +2,7 @@ # massProduct -fun [massProduct](mass-product.md)(body: [Body](-body/index.md)): Double +fun [massProduct](mass-product.md)(body: [Body](-body/index.md)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) Returns the product of mass and universal gravitational constant of a Solar System body. diff --git a/source/kotlin/doc/moon-nodes-after.md b/source/kotlin/doc/moon-nodes-after.md index 02e1cee4..eb21d1b4 100644 --- a/source/kotlin/doc/moon-nodes-after.md +++ b/source/kotlin/doc/moon-nodes-after.md @@ -2,7 +2,7 @@ # moonNodesAfter -fun [moonNodesAfter](moon-nodes-after.md)(startTime: [Time](-time/index.md)): Sequence<[NodeEventInfo](-node-event-info/index.md)> +fun [moonNodesAfter](moon-nodes-after.md)(startTime: [Time](-time/index.md)): [Sequence](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.sequences/-sequence/index.html)<[NodeEventInfo](-node-event-info/index.md)> Enumerates a series of consecutive ascending/descending nodes of the Moon. diff --git a/source/kotlin/doc/moon-phase.md b/source/kotlin/doc/moon-phase.md index ded50686..3ab1d597 100644 --- a/source/kotlin/doc/moon-phase.md +++ b/source/kotlin/doc/moon-phase.md @@ -2,7 +2,7 @@ # moonPhase -fun [moonPhase](moon-phase.md)(time: [Time](-time/index.md)): Double +fun [moonPhase](moon-phase.md)(time: [Time](-time/index.md)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) Returns the Moon's phase as an angle from 0 to 360 degrees. diff --git a/source/kotlin/doc/moon-quarters-after.md b/source/kotlin/doc/moon-quarters-after.md index b7554697..cb147faf 100644 --- a/source/kotlin/doc/moon-quarters-after.md +++ b/source/kotlin/doc/moon-quarters-after.md @@ -2,7 +2,7 @@ # moonQuartersAfter -fun [moonQuartersAfter](moon-quarters-after.md)(startTime: [Time](-time/index.md)): Sequence<[MoonQuarterInfo](-moon-quarter-info/index.md)> +fun [moonQuartersAfter](moon-quarters-after.md)(startTime: [Time](-time/index.md)): [Sequence](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.sequences/-sequence/index.html)<[MoonQuarterInfo](-moon-quarter-info/index.md)> Enumerates a series of consecutive moon quarter phase events. diff --git a/source/kotlin/doc/observer-gravity.md b/source/kotlin/doc/observer-gravity.md index f0af5c3a..aa2c5185 100644 --- a/source/kotlin/doc/observer-gravity.md +++ b/source/kotlin/doc/observer-gravity.md @@ -2,7 +2,7 @@ # observerGravity -fun [observerGravity](observer-gravity.md)(latitude: Double, height: Double): Double +fun [observerGravity](observer-gravity.md)(latitude: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), height: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) Calculates the gravitational acceleration experienced by an observer on the Earth. diff --git a/source/kotlin/doc/pair-longitude.md b/source/kotlin/doc/pair-longitude.md index e3e11fe5..f7b57edf 100644 --- a/source/kotlin/doc/pair-longitude.md +++ b/source/kotlin/doc/pair-longitude.md @@ -2,7 +2,7 @@ # pairLongitude -fun [pairLongitude](pair-longitude.md)(body1: [Body](-body/index.md), body2: [Body](-body/index.md), time: [Time](-time/index.md)): Double +fun [pairLongitude](pair-longitude.md)(body1: [Body](-body/index.md), body2: [Body](-body/index.md), time: [Time](-time/index.md)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) Returns one body's ecliptic longitude with respect to another, as seen from the Earth. diff --git a/source/kotlin/doc/planet-apsides-after.md b/source/kotlin/doc/planet-apsides-after.md index f70ab910..19b81748 100644 --- a/source/kotlin/doc/planet-apsides-after.md +++ b/source/kotlin/doc/planet-apsides-after.md @@ -2,7 +2,7 @@ # planetApsidesAfter -fun [planetApsidesAfter](planet-apsides-after.md)(body: [Body](-body/index.md), startTime: [Time](-time/index.md)): Sequence<[ApsisInfo](-apsis-info/index.md)> +fun [planetApsidesAfter](planet-apsides-after.md)(body: [Body](-body/index.md), startTime: [Time](-time/index.md)): [Sequence](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.sequences/-sequence/index.html)<[ApsisInfo](-apsis-info/index.md)> Enumerates a series of consecutive planetary perihelia/aphelia events. diff --git a/source/kotlin/doc/planet-orbital-period.md b/source/kotlin/doc/planet-orbital-period.md index a09c9441..6fa8960b 100644 --- a/source/kotlin/doc/planet-orbital-period.md +++ b/source/kotlin/doc/planet-orbital-period.md @@ -2,7 +2,7 @@ # planetOrbitalPeriod -fun [planetOrbitalPeriod](planet-orbital-period.md)(body: [Body](-body/index.md)): Double +fun [planetOrbitalPeriod](planet-orbital-period.md)(body: [Body](-body/index.md)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) Returns the average number of days it takes for a planet to orbit the Sun. diff --git a/source/kotlin/doc/radians-to-degrees.md b/source/kotlin/doc/radians-to-degrees.md index 10598aa2..cc8fecb1 100644 --- a/source/kotlin/doc/radians-to-degrees.md +++ b/source/kotlin/doc/radians-to-degrees.md @@ -2,6 +2,6 @@ # radiansToDegrees -fun Double.[radiansToDegrees](radians-to-degrees.md)(): Double +fun [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html).[radiansToDegrees](radians-to-degrees.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) Convert an angle expressed in radians to an angle expressed in degrees. diff --git a/source/kotlin/doc/refraction-angle.md b/source/kotlin/doc/refraction-angle.md index 54e34a22..430cb4ca 100644 --- a/source/kotlin/doc/refraction-angle.md +++ b/source/kotlin/doc/refraction-angle.md @@ -2,7 +2,7 @@ # refractionAngle -fun [refractionAngle](refraction-angle.md)(refraction: [Refraction](-refraction/index.md), altitude: Double): Double +fun [refractionAngle](refraction-angle.md)(refraction: [Refraction](-refraction/index.md), altitude: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) Calculates the amount of "lift" to an altitude angle caused by atmospheric refraction. diff --git a/source/kotlin/doc/search-altitude.md b/source/kotlin/doc/search-altitude.md index dc000bf8..6e68b80e 100644 --- a/source/kotlin/doc/search-altitude.md +++ b/source/kotlin/doc/search-altitude.md @@ -2,7 +2,7 @@ # searchAltitude -fun [searchAltitude](search-altitude.md)(body: [Body](-body/index.md), observer: [Observer](-observer/index.md), direction: [Direction](-direction/index.md), startTime: [Time](-time/index.md), limitDays: Double, altitude: Double): [Time](-time/index.md)? +fun [searchAltitude](search-altitude.md)(body: [Body](-body/index.md), observer: [Observer](-observer/index.md), direction: [Direction](-direction/index.md), startTime: [Time](-time/index.md), limitDays: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), altitude: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [Time](-time/index.md)? Finds the next time a body reaches a given altitude. diff --git a/source/kotlin/doc/search-hour-angle.md b/source/kotlin/doc/search-hour-angle.md index 087e46e5..457129f3 100644 --- a/source/kotlin/doc/search-hour-angle.md +++ b/source/kotlin/doc/search-hour-angle.md @@ -2,7 +2,7 @@ # searchHourAngle -fun [searchHourAngle](search-hour-angle.md)(body: [Body](-body/index.md), observer: [Observer](-observer/index.md), hourAngle: Double, startTime: [Time](-time/index.md), direction: Int = +1): [HourAngleInfo](-hour-angle-info/index.md) +fun [searchHourAngle](search-hour-angle.md)(body: [Body](-body/index.md), observer: [Observer](-observer/index.md), hourAngle: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), startTime: [Time](-time/index.md), direction: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = +1): [HourAngleInfo](-hour-angle-info/index.md) Searches for the time when a celestial body reaches a specified hour angle as seen by an observer on the Earth. diff --git a/source/kotlin/doc/search-moon-phase.md b/source/kotlin/doc/search-moon-phase.md index 5e5371ba..e04a9870 100644 --- a/source/kotlin/doc/search-moon-phase.md +++ b/source/kotlin/doc/search-moon-phase.md @@ -2,7 +2,7 @@ # searchMoonPhase -fun [searchMoonPhase](search-moon-phase.md)(targetLon: Double, startTime: [Time](-time/index.md), limitDays: Double): [Time](-time/index.md)? +fun [searchMoonPhase](search-moon-phase.md)(targetLon: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), startTime: [Time](-time/index.md), limitDays: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [Time](-time/index.md)? Searches for the time that the Moon reaches a specified phase. diff --git a/source/kotlin/doc/search-relative-longitude.md b/source/kotlin/doc/search-relative-longitude.md index 16382a58..dfb95ab2 100644 --- a/source/kotlin/doc/search-relative-longitude.md +++ b/source/kotlin/doc/search-relative-longitude.md @@ -2,7 +2,7 @@ # searchRelativeLongitude -fun [searchRelativeLongitude](search-relative-longitude.md)(body: [Body](-body/index.md), targetRelativeLongitude: Double, startTime: [Time](-time/index.md)): [Time](-time/index.md) +fun [searchRelativeLongitude](search-relative-longitude.md)(body: [Body](-body/index.md), targetRelativeLongitude: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), startTime: [Time](-time/index.md)): [Time](-time/index.md) Searches for the time when the Earth and another planet are separated by a specified angle in ecliptic longitude, as seen from the Sun. diff --git a/source/kotlin/doc/search-rise-set.md b/source/kotlin/doc/search-rise-set.md index e3c7f005..1c25a6ac 100644 --- a/source/kotlin/doc/search-rise-set.md +++ b/source/kotlin/doc/search-rise-set.md @@ -2,7 +2,7 @@ # searchRiseSet -fun [searchRiseSet](search-rise-set.md)(body: [Body](-body/index.md), observer: [Observer](-observer/index.md), direction: [Direction](-direction/index.md), startTime: [Time](-time/index.md), limitDays: Double): [Time](-time/index.md)? +fun [searchRiseSet](search-rise-set.md)(body: [Body](-body/index.md), observer: [Observer](-observer/index.md), direction: [Direction](-direction/index.md), startTime: [Time](-time/index.md), limitDays: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [Time](-time/index.md)? Searches for the next time a celestial body rises or sets as seen by an observer on the Earth. diff --git a/source/kotlin/doc/search-sun-longitude.md b/source/kotlin/doc/search-sun-longitude.md index bc28bff9..6f791991 100644 --- a/source/kotlin/doc/search-sun-longitude.md +++ b/source/kotlin/doc/search-sun-longitude.md @@ -2,7 +2,7 @@ # searchSunLongitude -fun [searchSunLongitude](search-sun-longitude.md)(targetLon: Double, startTime: [Time](-time/index.md), limitDays: Double): [Time](-time/index.md)? +fun [searchSunLongitude](search-sun-longitude.md)(targetLon: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), startTime: [Time](-time/index.md), limitDays: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [Time](-time/index.md)? Searches for the time when the Sun reaches an apparent ecliptic longitude as seen from the Earth. diff --git a/source/kotlin/doc/search.md b/source/kotlin/doc/search.md index dbdb5d8c..7b024777 100644 --- a/source/kotlin/doc/search.md +++ b/source/kotlin/doc/search.md @@ -2,7 +2,7 @@ # search -fun [search](search.md)(time1: [Time](-time/index.md), time2: [Time](-time/index.md), toleranceSeconds: Double, func: [SearchContext](-search-context/index.md)): [Time](-time/index.md)? +fun [search](search.md)(time1: [Time](-time/index.md), time2: [Time](-time/index.md), toleranceSeconds: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), func: [SearchContext](-search-context/index.md)): [Time](-time/index.md)? Searches for a time at which a function's value increases through zero. diff --git a/source/kotlin/doc/seasons.md b/source/kotlin/doc/seasons.md index 43490ea5..649fe7e9 100644 --- a/source/kotlin/doc/seasons.md +++ b/source/kotlin/doc/seasons.md @@ -2,7 +2,7 @@ # seasons -fun [seasons](seasons.md)(year: Int): [SeasonsInfo](-seasons-info/index.md) +fun [seasons](seasons.md)(year: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [SeasonsInfo](-seasons-info/index.md) Finds both equinoxes and both solstices for a given calendar year. diff --git a/source/kotlin/doc/sidereal-time.md b/source/kotlin/doc/sidereal-time.md index 87cc50b3..eab0a507 100644 --- a/source/kotlin/doc/sidereal-time.md +++ b/source/kotlin/doc/sidereal-time.md @@ -2,7 +2,7 @@ # siderealTime -fun [siderealTime](sidereal-time.md)(time: [Time](-time/index.md)): Double +fun [siderealTime](sidereal-time.md)(time: [Time](-time/index.md)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) Calculates Greenwich Apparent Sidereal Time (GAST). diff --git a/source/kotlin/doc/times.md b/source/kotlin/doc/times.md index 46051783..cb0ec120 100644 --- a/source/kotlin/doc/times.md +++ b/source/kotlin/doc/times.md @@ -2,6 +2,6 @@ # times -operator fun Double.[times](times.md)(vec: [Vector](-vector/index.md)): [Vector](-vector/index.md) +operator fun [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html).[times](times.md)(vec: [Vector](-vector/index.md)): [Vector](-vector/index.md) Multiply a scalar by a vector, yielding another vector. diff --git a/source/kotlin/doc/transits-after.md b/source/kotlin/doc/transits-after.md index cd3f96f1..9e7f0c6f 100644 --- a/source/kotlin/doc/transits-after.md +++ b/source/kotlin/doc/transits-after.md @@ -2,7 +2,7 @@ # transitsAfter -fun [transitsAfter](transits-after.md)(body: [Body](-body/index.md), startTime: [Time](-time/index.md)): Sequence<[TransitInfo](-transit-info/index.md)> +fun [transitsAfter](transits-after.md)(body: [Body](-body/index.md), startTime: [Time](-time/index.md)): [Sequence](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.sequences/-sequence/index.html)<[TransitInfo](-transit-info/index.md)> Enumerates a series of consecutive transits of Mercury or Venus. diff --git a/source/python/setup.py b/source/python/setup.py index 0bfef7d7..7b2399d9 100644 --- a/source/python/setup.py +++ b/source/python/setup.py @@ -6,7 +6,7 @@ def _LoadFile(filename): setup( name='astronomy-engine', - version='2.1.10', + version='2.1.11', description='Astronomy calculation for Sun, Moon, and planets.', long_description=_LoadFile('README.md'), long_description_content_type='text/markdown',