s2-tools/dist/proj4/common.d.ts

A collection of geospatial tools primarily designed for WGS84, Web Mercator, and S2.

/**
 * Returns the arc hyperbolic cosine of x.
 * @param x - input
 * @returns - acosh(x)
 */
export declare function acosh(x: number): number;
/**
 * Returns an adjusted latitude
 * @param x - input
 * @returns - the adjusted latitude
 */
export declare function adjustLat(x: number): number;
/**
 * Returns an adjusted longitude
 * @param x - input
 * @returns - the adjusted longitude
 */
export declare function adjustLon(x: number): number;
/**
 * Returns an adjusted zone relative to the input zone and longitude
 * @param zone - the input zone
 * @param lon - the input longitude
 * @returns - the adjusted zone
 */
export declare function adjustZone(zone: number | undefined, lon: number): number;
/**
 * Returns the arc hyperbolic sine of x.
 * @param x - input
 * @returns - asinh(x)
 */
export declare function asinh(x: number): number;
/**
 * Returns the arc hyperbolic tangent of x.
 * @param x - input
 * @returns - asinhy(x)
 */
export declare function asinhy(x: number): number;
/**
 * Returns the absolute value of the arc sine of x.
 * @param x - input
 * @returns - asinz(x)
 */
export declare function asinz(x: number): number;
/**
 * Returns the complex form of coefficients
 * @param pp - array of coefficients
 * @param arg_r - input
 * @param arg_i - input
 * @returns the complex result as a 2D array
 */
export declare function clensCmplx(pp: number[], arg_r: number, arg_i: number): [number, number];
/**
 * Returns the complex form of coefficients
 * @param pp - array of coefficients
 * @param arg_r - input
 * @returns the resultant compex number
 */
export declare function clens(pp: number[], arg_r: number): number;
/**
 * Returns the hyperbolic cosine of x.
 * @param x - input
 * @returns - cosh(x)
 */
export declare function cosh(x: number): number;
/**
 * Returns eOfn(x)
 * @param x - input
 * @returns - eOfn(x)
 */
export declare function e0fn(x: number): number;
/**
 * Returns e1fn(x)
 * @param x - input
 * @returns - e1fn(x)
 */
export declare function e1fn(x: number): number;
/**
 * Returns e2fn(x)
 * @param x - input
 * @returns - e2fn(x)
 */
export declare function e2fn(x: number): number;
/**
 * Returns e3fn(x)
 * @param x - input
 * @returns - e3fn(x)
 */
export declare function e3fn(x: number): number;
/**
 * Convenience function to compute fL(x, L)
 * @param x - input
 * @param L - exponent
 * @returns - fL(x, L)
 */
export declare function fL(x: number, L: number): number;
/**
 * Convenience function to compute gatg(pp, B)
 * @param pp - array of coefficients
 * @param B - input
 * @returns - gatg(pp, B)
 */
export declare function gatg(pp: number[], B: number): number;
/**
 * Returns gN(a, e, sinphi)
 * @param a - input
 * @param e - input
 * @param sinphi - sin of latitude
 * @returns - gN(a, e, sinphi)
 */
export declare function gN(a: number, e: number, sinphi: number): number;
/**
 * Returns the hypotenuse of x and y
 * @param x - input
 * @param y - input
 * @returns - hypot(x, y)
 */
export declare function hypot(x: number, y: number): number;
/**
 * Convenience function to compute iMLfn(ml, e0, e1, e2, e3)
 * @param ml - input
 * @param e0 - input
 * @param e1 - input
 * @param e2 - input
 * @param e3 - input
 * @returns - iMLfn(ml, e0, e1, e2, e3)
 */
export declare function imlfn(ml: number, e0: number, e1: number, e2: number, e3: number): number;
/**
 * Inverse of iLfn
 * @param eccent - eccentricity
 * @param ts - input
 * @returns - invlatiso(eccent, ts)
 */
export declare function invlatiso(eccent: number, ts: number): number;
/**
 * Convienience function to compute iqsfnz(eccent, q)
 * @param eccent - eccentricity
 * @param q - input
 * @returns - iqsfnz(eccent, q)
 */
export declare function iqsfnz(eccent: number, q: number): number;
/**
 * Convenience function to compute latiso(eccent, phi, sinphi)
 * @param eccent - eccentricity
 * @param phi - latitude
 * @param sinphi - sin of latitude
 * @returns - latiso(eccent, phi, sinphi)
 */
export declare function latiso(eccent: number, phi: number, sinphi: number): number;
/**
 * Convenience function to compute log1py(x)
 * @param x - input
 * @returns - log1py(x)
 */
export declare function log1py(x: number): number;
/**
 * Convienience function to compute mlfn
 * @param e0 - input
 * @param e1 - input
 * @param e2 - input
 * @param e3 - input
 * @param phi - latitude
 * @returns - mlfn(e0, e1, e2, e3, phi)
 */
export declare function mlfn(e0: number, e1: number, e2: number, e3: number, phi: number): number;
/**
 * Convienience function to compute msfnz(eccent, sinphi, cosphi)
 * @param eccent - eccentricity
 * @param sinphi - sin of latitude
 * @param cosphi - cos of latitude
 * @returns - msfnz(eccent, sinphi, cosphi)
 */
export declare function msfnz(eccent: number, sinphi: number, cosphi: number): number;
/**
 * Convenience function to compute phi2z(eccent, ts)
 * @param eccent - eccentricity
 * @param ts - input
 * @returns - phi2z(eccent, ts)
 */
export declare function phi2z(eccent: number, ts: number): number;
/** The 5 elements of the eccentricity vector. */
export type En = [number, number, number, number, number];
/**
 * Convenience function to compute enfn(es)
 * @param es - eccentricity
 * @returns - enfn(es)
 */
export declare function pjEnfn(es: number): En;
/**
 * Convenience function for pjInvMlfn(arg, es, en)
 * @param arg - latitude
 * @param es - eccentricity
 * @param en - input
 * @returns - pjInvMlfn(arg, es, en)
 */
export declare function pjInvMlfn(arg: number, es: number, en: En): number;
/**
 * Convenience function for pjMlfn(phi, sphi, cphi, en)
 * @param phi - latitude
 * @param sphi - sin of latitude
 * @param cphi - cos of latitude
 * @param en - input
 * @returns - pjMlfn(phi, sphi, cphi, en)
 */
export declare function pjMlfn(phi: number, sphi: number, cphi: number, en: En): number;
/**
 * Convenience function for qsfnz(eccent, sinphi)
 * @param eccent - eccentricity
 * @param sinphi - sin of latitude
 * @returns - qsfnz(eccent, sinphi)
 */
export declare function qsfnz(eccent: number, sinphi: number): number;
/**
 * Returns the sign of x
 * @param x - The value to get the sign of
 * @returns - 1 if x is positive, -1 if x is negative
 */
export declare function sign(x: number): 1 | -1;
/**
 * Returns the hyperbolic sine of x.
 * @param x - The value to calculate the hyperbolic sine of
 * @returns - sinh(x)
 */
export declare function sinh(x: number): number;
/**
 * Returns the ratio of the exponential of two numbers
 * @param esinp - The ratio
 * @param exp - The exponent
 * @returns - srat(esinp, exp)
 */
export declare function srat(esinp: number, exp: number): number;
/**
 * Returns the hyperbolic tangent of x.
 * @param x - The value to calculate the hyperbolic tangent of
 * @returns - tanh(x)
 */
export declare function tanh(x: number): number;
/**
 * Apply the spherical formulae to obtain the conformal latitude
 * @param eccent - eccentricity
 * @param phi - latitude
 * @param sinphi - Math.sin(latitude)
 * @returns - conformal latitude
 */
export declare function tsfnz(eccent: number, phi: number, sinphi: number): number;
//# sourceMappingURL=common.d.ts.map