@trakit/objects 0.0.5 → 0.0.7

package/API/Geography/Interfaces.d.ts

@@ -1,150 +0,0 @@
-import { datetime, nothing } from '../Types';
-/**
- * A coordinate on the Earth.
- */
-export interface ILatLng {
-    /**
-     * Latitude.
-     */
-    lat: number;
-    /**
-     * Longitude.
-     */
-    lng: number;
-}
-/**
- * Returns true if the given pin conforms to the {@link ILatLng} interface.
- * @param pin
- * @returns
- */
-export declare function ILatLng_instanceOf(pin: any): pin is ILatLng;
-/**
- *
- * @param dot
- * @returns
- */
-export declare function ILatLng_clone(dot: ILatLng): ILatLng;
-/**
- * GPS position information.
- */
-export interface IPosition extends ILatLng {
-    /**
-     * Speed
-     */
-    speed: number | nothing;
-    /**
-     * Direction of travel
-     */
-    bearing: number | nothing;
-    /**
-     * Distance in meters from the sea level
-     */
-    altitude: number | nothing;
-    /**
-     * Threshold in meters for the accuracy of a position
-     */
-    accuracy: number | nothing;
-    /**
-     * The Date/Time of the GPS reading
-     */
-    dts: datetime;
-    /**
-     * A description of the current road-segment
-     */
-    address: string | nothing;
-    /**
-     * A better description of the current road-segment
-     */
-    streetAddress: IStreetAddress | nothing;
-    /**
-     * The posted speed limit for the road segment
-     */
-    speedLimit: number | nothing;
-}
-/**
- * Returns true if the given pin conforms to the {@link IPosition} interface.
- * @param pin
- * @returns
- */
-export declare function IPosition_instanceOf(pin: any): pin is IPosition;
-/**
- * A road segment description.
- */
-export interface IStreetAddress {
-    /**
-     * House number.
-     */
-    number: string | null;
-    /**
-     * Full street name.
-     */
-    street: string | null;
-    /**
-     * City name.
-     */
-    city: string | null;
-    /**
-     * Region name.
-     */
-    region: string | null;
-    /**
-     * Province or state code.
-     * Codes should be a value from ISO 3166-2.
-     */
-    province: string;
-    /**
-     * Country code.
-     * Codes should be a value from ISO 3166-1 alpha-2.
-     */
-    country: string;
-    /**
-     * Postal or zip code.
-     */
-    postal: string | null;
-    /**
-     * Indicates that there is a toll for the current road segment.
-     */
-    isToll: boolean | null;
-}
-/**
- * Returns true if the given pin conforms to the {@link IStreetAddress} interface.
- * @param address
- * @returns
- */
-export declare function IStreetAddress_instanceOf(address: any): address is IStreetAddress;
-/**
- * A rectangular boundary on a flat surface.
- */
-export interface ILatLngBounds {
-    /**
-     * Northern latitude
-     */
-    north: number;
-    /**
-     * Eastern longitude
-     */
-    east: number;
-    /**
-     * Southern latitude
-     */
-    south: number;
-    /**
-     * Western longitude
-     */
-    west: number;
-}
-/**
- * Returns true if the given box conforms to the {@link ILatLngBounds} interface.
- * @param box
- */
-export declare function ILatLngBounds_instanceOf(box: any): box is ILatLngBounds;
-/**
- *
- * @param box
- * @returns
- */
-export declare function ILatLngBounds_clone(box: ILatLngBounds): ILatLngBounds;
-/**
- * The types used to extend a {@link LatLngBounds}'s edges.
- */
-export type LatLngBoundsExpansion = ILatLng | ILatLngBounds | LatLngBoundsExpansion[];

package/API/Geography/LatLng.d.ts

@@ -1,86 +0,0 @@
-import { Point } from '../Geometry/Point';
-import { JsonObject } from '../Types';
-import { ILatLng } from './Interfaces';
-import { LatLngBounds } from './LatLngBounds';
-/**
- * A coordinate on the Earth.
- */
-export declare class LatLng implements ILatLng {
-    /**
-     * Let's consider the zero-zero coordinates to be invalid.
-     */
-    static readonly INVALID: LatLng;
-    /**
-     *
-     * @param json
-     */
-    static fromJSON(json: ILatLng | JsonObject): LatLng;
-    /**
-     *
-     * @param latlng
-     * @param delimiter
-     * @returns
-     */
-    static fromString(latlng: string, delimiter?: string): LatLng;
-    /**
-     * Latitude
-     */
-    readonly lat: number;
-    /**
-     * Longitude
-     */
-    readonly lng: number;
-    constructor(lat: number, lng: number);
-    /**
-     * Returns a string representation of this {@link LatLng}.
-     * @param delimiter	The boundary is delimited by a comma (,) by default, but you can override with your own value.
-     * @returns A string in the format of "lat,lng".
-     */
-    toString(delimiter?: string): string;
-    /**
-     * Creates a literal of this {@link LatLng}.
-     * Used internally by {@link JSON.stringify}.
-     */
-    toJSON(): ILatLng;
-    /**
-     * Compares this LatLng to another to see if they are equivalent.
-     * @param other		The other LatLng to compare
-     * @param tolerance	Distance tolerance before considering two nearly identical coordinates to be equal.
-     */
-    isEqual(other: ILatLng, tolerance?: number): boolean;
-    /**
-     * Returns true if this coordinate is not NaN and not zero-zero.
-     */
-    isValid(): boolean;
-    /**
-     * Calculates the distance across the surface of the globe to another coordinate
-     * @param pin
-     */
-    distanceTo(pin: ILatLng): number;
-    /**
-     * Calculates the starting bearing across the surface of the globe from the current coordinate to the given coordinate
-     * @param pin
-     */
-    bearingTo(pin: ILatLng): number;
-    /**
-     * Returns a new coordinate at the given distance and bearing from this coordinate
-     * @param meters
-     * @param bearing
-     */
-    toTranslated(meters: number, bearing: number): LatLng;
-    /**
-     * Returns a new LatLng at the half-way point between this and the given LatLng.
-     * @param pin	The other coordinate.
-     * @throws {Error}	Either latitude or longitude is NaN
-     */
-    toBetween(pin: ILatLng): LatLng;
-    /**
-     * Creates a Point based on the given magnifier.
-     */
-    toRadians(magnifier?: number): Point;
-    /**
-     * Creates a square LatLngBounds centred around this LatLng.
-     * @param radius	The closest distance (in meters) from this coordinate to the edges of the new LatLngBounds.
-     */
-    toBounds(radius: number): LatLngBounds;
-}

package/API/Geography/LatLngBounds.d.ts

@@ -1,146 +0,0 @@
-import { ISerializable } from '../Interfaces/ISerializable';
-import { JsonObject } from '../Types';
-import { ILatLng, ILatLngBounds, LatLngBoundsExpansion } from './Interfaces';
-import { LatLng } from './LatLng';
-/**
- * A boundary on the globe
- */
-export declare class LatLngBounds implements ILatLngBounds, ISerializable {
-    /**
-     *
-     * @param json
-     */
-    static fromJSON(json: ILatLngBounds | JsonObject): LatLngBounds;
-    /**
-     * Northern latitude
-     */
-    north: number;
-    /**
-     * Eastern longitude
-     */
-    east: number;
-    /**
-     * Southern latitude
-     */
-    south: number;
-    /**
-     * Western longitude
-     */
-    west: number;
-    constructor(...args: LatLngBoundsExpansion[]);
-    /**
-     * Returns a string representation of this {@link LatLng}.
-     * @param delimiter	The boundary is delimited by a comma (,) by default, but you can override with your own value.
-     * @returns A string in the format of "lat,lng".
-     */
-    toString(delimiter?: string): string;
-    /**
-     * Creates a literal of this {@link LatLngBounds}.
-     * Used internally by {@link JSON.stringify}.
-     */
-    toJSON(): {
-        north: number;
-        east: number;
-        south: number;
-        west: number;
-    };
-    /**
-     * Compares this LatLng to another to see if they are equivalent.
-     * @param other		The other LatLng to compare
-     * @param tolerance	Distance tolerance before considering two nearly identical coordinates to be equal.
-     */
-    isEqual(other: ILatLngBounds, tolerance?: number): boolean;
-    /**
-     *
-     */
-    isValid(): boolean;
-    /**
-     *
-     */
-    isEmpty(): boolean;
-    /**
-     * Checks if a {@link LatLng} is contained within this boundary.
-     * @param pin	The point to check
-     */
-    contains(pin: ILatLng): boolean;
-    /**
-     * Checks if a {@link LatLngBounds} is contained within this boundary.
-     * @expose
-     * @this {LatLngBounds}
-     * @param bounds	The other boundary to check
-     */
-    encloses(bounds: ILatLngBounds): boolean;
-    /**
-     * Checks if a {@link LatLngBounds} overlaps this boundary.
-     * Also returns true if either boundary's {@link LatLngBounds#encloses} returns true.
-     * @param other	The other boundary to check
-     */
-    overlaps(other: ILatLngBounds): boolean;
-    /**
-     *
-     * @param object
-     */
-    private __expander;
-    /**
-     * Extends the boundary to envelop the given point(s) but does not automatically
-     *		validate. This comes in efficient when doing many operations on a single
-     *		PointBounds
-     */
-    expand(latlngs: LatLngBoundsExpansion): this;
-    /**
-     * Extends the boundary to envelop the given point(s) and automatically validates
-     */
-    extend(latlngs: LatLngBoundsExpansion): this;
-    /**
-     *
-     */
-    getCentre(): LatLng;
-    /**
-     *
-     */
-    getNorthEast(): LatLng;
-    /**
-     *
-     */
-    getNorthWest(): LatLng;
-    /**
-     *
-     */
-    getSouthEast(): LatLng;
-    /**
-     *
-     */
-    getSouthWest(): LatLng;
-    /**
-     * The mid-point coordinate between the north east and north west corners.
-     */
-    getNorthMiddle(): LatLng;
-    /**
-     * The mid-point coordinate between the south east and south west corners.
-     */
-    getSouthMiddle(): LatLng;
-    /**
-     * The mid-point coordinate between the north east and north west corners.
-     */
-    getEastMiddle(): LatLng;
-    /**
-     * The mid-point coordinate between the south east and south west corners.
-     */
-    getWestMiddle(): LatLng;
-    /**
-     * The distance in meters between the north-east corner and the south-west corner.
-     */
-    getDiagonalDistance(): number;
-    /**
-     * The distance in meters between the north-most border and the south-most border.
-     */
-    getLatitudinalDistance(): number;
-    /**
-     * The distance in meters between the east-most and the west-most points along the border closest to the equator.
-     */
-    getLongitudinalDistance(): number;
-    /**
-     *
-     */
-    validate(): this;
-}

package/API/Geography/Position.d.ts

@@ -1,74 +0,0 @@
-import { datetime, JsonObject, nothing } from '../Types';
-import { IPosition, IStreetAddress } from './Interfaces';
-import { LatLng } from './LatLng';
-import { StreetAddress } from './StreetAddress';
-/**
- * GPS position information
- */
-export declare class Position extends LatLng implements IPosition {
-    /**
-     *
-     * @param json
-     * @returns
-     */
-    static fromJSON(json: IPosition | JsonObject): Position;
-    /**
-     * Speed
-     */
-    readonly speed: number;
-    /**
-     * Direction of travel
-     */
-    readonly bearing: number;
-    /**
-     * Distance in meters from the sea level
-     */
-    readonly altitude: number;
-    /**
-     * Threshold in meters for the accuracy of a position
-     */
-    readonly accuracy: number;
-    /**
-     * The Date/Time of the GPS reading
-     */
-    readonly date: Date;
-    /**
-     * The Date/Time of the GPS reading
-     */
-    get dts(): string;
-    /**
-     * A better description of the current road-segment
-     */
-    readonly streetAddress: StreetAddress | null;
-    /**
-     * The posted speed limit for the road segment
-     */
-    readonly speedLimit: number | nothing;
-    /**
-     * Provider Identifier
-     */
-    readonly origin: string;
-    /**
-     * The road segment description
-     */
-    readonly address: string;
-    constructor(lat?: number | nothing, lng?: number | nothing, speed?: number | nothing, bearing?: number | nothing, accuracy?: number | nothing, dts?: Date | number | datetime | nothing, address?: string | nothing, limit?: number | nothing, altitude?: number | nothing, street?: IStreetAddress | JsonObject | nothing);
-    /**
-     * Returns a text representation of this position.
-     * Returned strings cannot be converted back into {@link Position}
-     * objects, so don't use this for deserialization.
-     * @param delimiter
-     */
-    toString(delimiter?: string): string;
-    /**
-     * Creates a literal of this {@link Position}.
-     * Used internally by {@link JSON.stringify}.
-     */
-    toJSON(): IPosition;
-    /**
-     *
-     * @param position
-     * @returns
-     */
-    isEqual(position: Position | IPosition): boolean;
-}

package/API/Geography/StreetAddress.d.ts

@@ -1,59 +0,0 @@
-import { ISerializable } from "../Interfaces/ISerializable";
-import { JsonObject, nothing } from "../Types";
-import { IStreetAddress } from "./Interfaces";
-/**
- * A road segment description
-*/
-export declare class StreetAddress implements IStreetAddress, ISerializable {
-    /**
-     *
-     * @param street
-     */
-    static fromJSON(json: IStreetAddress | JsonObject): StreetAddress;
-    /**
-     * House number.
-     */
-    number: string;
-    /**
-     * Full street name.
-     */
-    street: string;
-    /**
-     * City name.
-     */
-    city: string;
-    /**
-     * Region name.
-     */
-    region: string;
-    /**
-     * Province or state code.
-     * Codes should be a value from ISO 3166-2.
-     */
-    province: string;
-    /**
-     * Country code.
-     * Codes should be a value from ISO 3166-1 alpha-2.
-     */
-    country: string;
-    /**
-     * Postal or zip code.
-     */
-    postal: string;
-    /**
-     * Indicates that there is a toll for the current road segment.
-     */
-    isToll: boolean;
-    constructor(number?: string | nothing, street?: string | nothing, city?: string | nothing, region?: string | nothing, province?: string | nothing, country?: string | nothing, postal?: string | nothing, isToll?: boolean | nothing);
-    /**
-     * Returns a text representation of this address.
-     * Returned strings cannot be converted back into {@link StreetAddress}
-     * objects, so don't use this for deserialization.
-     */
-    toString(): string;
-    /**
-     * Creates a literal of this {@link StreetAddress}.
-     * Used internally by {@link JSON.stringify}.
-     */
-    toJSON(): IStreetAddress;
-}

package/API/Geometry/Functions.d.ts

@@ -1,114 +0,0 @@
-import { IPoint, IRadial, IRectangle } from './Interfaces';
-/**
- * Calculates the starting angle (in degrees) between two Points using the top as zero.  Does not return negative values.
- * @param starting	Starting coordinate
- * @param ending	Other coordinate
- * @returns A number between 0 and 360.
- */
-export declare function POINT_ANGLE(starting: IPoint, ending: IPoint): number;
-/**
- * Calculates the distance between two points using Pythagorean theorem.
- * @param starting	Starting coordinate
- * @param ending	Other coordinate
- */
-export declare function POINT_DISTANCE(starting: IPoint, ending: IPoint): number;
-/**
- * Sorts points by left-most, then by top-most.
- */
-export declare function POINT_SORT(a: IPoint, b: IPoint): number;
-/**
- * Calculates the vector which can be used to find the point based on the given direction and distance
- * @param distance
- * @param degrees
- */
-export declare function POINT_VECTOR(distance: number, degrees: number): IPoint;
-/**
- * Calculates the total length of the given path
- * @param path	The array of points representing a path
- * */
-export declare function PATH_LENGTH(path: IPoint[]): number;
-/**
- * Calculates the orthogonal height of a triangle. The orthogonal height is
- * calculated by drawing a line between the firstPoint and lastPoint, then
- * getting the length of a line drawn up from the line to the midPoint at a 90
- * degree angle.
- * @param first		Left-most coordinate of the triangle
- * @param mid		Top-most coordinate of the triangle
- * @param last		Right-most coordinate of the triangle
- */
-export declare function PATH_ORTHOGONAL(first: IPoint, mid: IPoint, last: IPoint): number;
-/**
- * Performs a Douglas-Peucker path reduction based on the given tolerance.
- * @param path	The array of points representing a path
- * @param tolerance		Orthogonal height threshold for candidate points.  Default is 0.
- * */
-export declare function PATH_PEUCKER(path: IPoint[], tolerance?: number): IPoint[];
-/**
- * Calculates the total area occupied by the given path.  Treats non-closed paths as closed paths.
- * @param path	The array of points representing a path
- * */
-export declare function POLY_AREA(path: IPoint[]): number;
-/**
- * A utility export function to determine if a given point is inside the given polygon path.
- * @param poly	The array of points represents the path of the polygon.
- * @param dot	The coordinate of the point to be checked.
- * */
-export declare function POLY_CONTAINS(poly: IPoint[], dot: IPoint): boolean;
-/**
- * Performs a Douglas-Peucker path reduction on a polygon for the given tolerance.
- * The start/end points are variable and the end point is trimmed from the result.
- * @param path	The array of points representing a path
- * @param tolerance		Orthogonal height threshold for candidate points.  Default is 0.
- * */
-export declare function POLY_PEUCKER(path: IPoint[], tolerance?: number): IPoint[];
-/**
- * Wraps the given points into a polygonal path.  The given points do not need to be a path.  The returned path is not closed.
- * @param points	The array of points on which to create the non-closed path
- * @returns Non-closed path.
- */
-export declare function POLY_WRAPPER(points: IPoint[]): IPoint[];
-/**
- * Calculates the area of a circle based on the given radius.
- * @param radius
- * */
-export declare function RADIAL_AREA(radius: number): number;
-/**
- * Solves the Minimum Enclosing Circle problem using Badoiu Clarkson's algorithm.
- * @param points	The array of points on which to create the Radial
- * @param iterations	The higher the iterations the slower and more accurate the Radial. Default is 10,000.
- * */
-export declare function RADIAL_BADOIU_CLARKSON(points: IPoint[], iterations?: number): IRadial;
-/**
- * Calculates the circumference of a circle based on the given radius.
- * @param radius
- * */
-export declare function RADIAL_CIRCUMFERENCE(radius: number): number;
-/**
- * Creates an {@link IRectangle} which contains the given list of {@link IPoint}s.
- * @param dots
- */
-export declare function RECTANGLE_FROM_POINTS(dots: IPoint[]): IRectangle;
-/**
- * Returns true if the given {@link Radial} overlaps the given {@link Rectangle}.
- * @param circle
- * @param rect
- * */
-export declare function RADIAL_OVERLAP_RECTANGLE(circle: IRadial, rect: IRectangle): boolean;
-/**
- *
- * @param rect
- */
-export declare function RECTANGLE_CENTRE(rect: IRectangle): IPoint;
-/**
- * Determines if the given {@link IPoint} is contained by the given {@link Rectangle}.
- * @param rect
- * @param dot
- * @returns
- */
-export declare function RECTANGLE_CONTAINS_POINT(rect: IRectangle, dot: IPoint): boolean;
-/**
- *
- * @param rect
- * @param clip
- */
-export declare function RECTANGLE_TO_RADIAL(rect: IRectangle, clip: boolean): IRadial;