@antv/g6/lib/utils/vector.js

A Graph Visualization Framework in JavaScript

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.add = add;
exports.subtract = subtract;
exports.multiply = multiply;
exports.divide = divide;
exports.dot = dot;
exports.cross = cross;
exports.scale = scale;
exports.distance = distance;
exports.manhattanDistance = manhattanDistance;
exports.normalize = normalize;
exports.angle = angle;
exports.exactEquals = exactEquals;
exports.perpendicular = perpendicular;
exports.mod = mod;
exports.toVector2 = toVector2;
exports.toVector3 = toVector3;
exports.rad = rad;
const is_1 = require("./is");
const VECTOR_ZERO = [0, 0, 0];
/**
 * <zh/> 两个向量求和
 *
 * <en/> Adds two vectors
 * @param a - <zh/> 第一个向量 | <en/> The first vector
 * @param b - <zh/> 第二个向量 | <en/> The second vector
 * @returns <zh/> 两个向量的和 | <en/> The sum of the two vectors
 */
function add(a, b) {
    return a.map((v, i) => v + b[i]);
}
/**
 * <zh/> 两个向量求差
 *
 * <en/> Subtracts two vectors
 * @param a - <zh/> 第一个向量 | <en/> The first vector
 * @param b - <zh/> 第二个向量 | <en/> The second vector
 * @returns <zh/> 两个向量的差 | <en/> The difference of the two vectors
 */
function subtract(a, b) {
    return a.map((v, i) => v - b[i]);
}
/**
 * <zh/> 两个向量求积或者向量和标量求积
 *
 * <en/> Multiplies two vectors or a vector and a scalar
 * @param a - <zh/> 向量 | <en/> The vector
 * @param b - <zh/> 向量或者标量 | <en/> The vector or scalar
 * @returns <zh/> 两个向量的积或者向量和标量的积 | <en/> The product of the two vectors or the product of the vector and scalar
 */
function multiply(a, b) {
    if (typeof b === 'number')
        return a.map((v) => v * b);
    return a.map((v, i) => v * b[i]);
}
/**
 * <zh/> 两个向量求商或者向量和标量求商
 *
 * <en/> Divides two vectors or a vector and a scalar
 * @param a - <zh/> 向量 | <en/> The vector
 * @param b - <zh/> 向量或者标量 | <en/> The vector or scalar
 * @returns <zh/> 两个向量的商或者向量和标量的商 | <en/> The quotient of the two vectors or the quotient of the vector and scalar
 */
function divide(a, b) {
    if (typeof b === 'number')
        return a.map((v) => v / b);
    return a.map((v, i) => v / b[i]);
}
/**
 * <zh/> 两个向量求点积
 *
 * <en/> Calculates the dot product of two vectors
 * @param a - <zh/> 第一个向量 | <en/> The first vector
 * @param b - <zh/> 第二个向量 | <en/> The second vector
 * @returns <zh/> 两个向量的点积 | <en/> The dot product of the two vectors
 */
function dot(a, b) {
    return a.reduce((sum, v, i) => sum + v * b[i], 0);
}
/**
 * <zh/> 两个二维向量求叉积
 *
 * <en/> Calculates the cross product of two vectors in three-dimensional Euclidean space
 * @param a - <zh/> 第一个向量 | <en/> The first vector
 * @param b - <zh/> 第二个向量 | <en/> The second vector
 * @returns <zh/> 两个向量的叉积 | <en/> The cross product of the two vectors
 */
function cross(a, b) {
    const a2 = toVector3(a);
    const b2 = toVector3(b);
    return [a2[1] * b2[2] - a2[2] * b2[1], a2[2] * b2[0] - a2[0] * b2[2], a2[0] * b2[1] - a2[1] * b2[0]];
}
/**
 * <zh/> 向量缩放
 *
 * <en/> Scales a vector by a scalar number
 * @param a  - <zh/> 向量 | <en/> The vector to scale
 * @param s - <zh/> 缩放系数 | <en/> Scale factor
 * @returns <zh/> 缩放后的向量 | <en/> The scaled vector
 */
function scale(a, s) {
    return a.map((v) => v * s);
}
/**
 * <zh/> 计算两个向量间的欧几里得距离
 *
 * <en/> Calculates the Euclidean distance between two vectors
 * @param a - <zh/> 第一个向量 | <en/> The first vector
 * @param b - <zh/> 第二个向量 | <en/> The second vector
 * @returns <zh/> 两个向量间的距离 | <en/> The distance between the two vectors
 */
function distance(a, b) {
    return Math.sqrt(a.reduce((sum, v, i) => sum + Math.pow((v - b[i] || 0), 2), 0));
}
/**
 * <zh/> 计算两个向量间的曼哈顿距离
 *
 * <en/> Calculates the Manhattan distance between two vectors
 * @param a - <zh/> 第一个向量 | <en/> The first vector
 * @param b - <zh/> 第二个向量 | <en/> The second vector
 * @returns <zh/> 两个向量间的距离 | <en/> The distance between the two vectors
 */
function manhattanDistance(a, b) {
    return a.reduce((sum, v, i) => sum + Math.abs(v - b[i]), 0);
}
/**
 * <zh/> 标准化向量（使长度为 1）
 *
 * <en/> Normalizes a vector (making its length 1)
 * @param a - <zh/> 要标准化的向量 | <en/> The vector to normalize
 * @returns <zh/> 标准化后的向量 | <en/> The normalized vector
 */
function normalize(a) {
    const length = a.reduce((sum, v) => sum + Math.pow(v, 2), 0);
    return a.map((v) => v / Math.sqrt(length));
}
/**
 * <zh/> 计算两个向量间的夹角，输出为锐角余弦值
 *
 * <en/> Get the angle between two vectors
 * @param a - <zh/> 第一个向量 | <en/> The first vector
 * @param b - <zh/> 第二个向量 | <en/> The second vector
 * @param clockwise - <zh/> 是否顺时针 | <en/> Whether to calculate the angle in a clockwise direction
 * @returns  <zh/> 弧度值 | <en/> The angle in radians
 */
function angle(a, b, clockwise = false) {
    const determinant = a[0] * b[1] - a[1] * b[0];
    let angle = Math.acos(multiply(a, b).reduce((sum, v) => sum + v, 0) /
        (distance(a, VECTOR_ZERO) * distance(b, VECTOR_ZERO)));
    // If clockwise is true and determinant is negative, adjust the angle
    if (clockwise && determinant < 0) {
        angle = 2 * Math.PI - angle;
    }
    return angle;
}
/**
 * <zh/> 判断两个向量是否完全相等（使用 === 比较）
 *
 * <en/> Returns whether or not the vectors exactly have the same elements in the same position (when compared with ===)
 * @param a - <zh/> 第一个向量 | <en/> The first vector
 * @param b - <zh/> 第二个向量 | <en/> The second vector
 * @returns  - <zh/> 是否相等 | <en/> Whether or not the vectors are equal
 */
function exactEquals(a, b) {
    return a.every((v, i) => v === b[i]);
}
/**
 * <zh/> 计算向量的垂直向量
 *
 * <en/> Calculates the perpendicular vector to a given vector
 * @param a - <zh/> 原始向量 | <en/> The original vector
 * @param clockwise - <zh/> 是否顺时针 | <en/> Whether to calculate the perpendicular vector in a clockwise direction
 * @returns <zh/> 原始向量的垂直向量 | <en/> The perpendicular vector to the original vector
 */
function perpendicular(a, clockwise = true) {
    return clockwise ? [-a[1], a[0]] : [a[1], -a[0]];
}
/**
 * <zh/> 计算向量的模
 *
 * <en/> Calculates the modulus of a vector
 * @param a - <zh/> 原始向量 | <en/> The original vector
 * @param b - <zh/> 模 | <en/> The modulus
 * @returns - <zh/> 向量的模 | <en/> The modulus of the vector
 */
function mod(a, b) {
    return a.map((v) => v % b);
}
/**
 * <zh/> 向量强制转换为二维向量
 *
 * <en/> Force vector to be two-dimensional
 * @param a - <zh/> 原始向量 | <en/> The original vector
 * @returns <zh/> 二维向量 | <en/> Two-dimensional vector
 */
function toVector2(a) {
    return [a[0], a[1]];
}
/**
 * <zh/> 向量强制转换为三维向量
 *
 * <en/> Force vector to be three-dimensional
 * @param a - <zh/> 原始向量 | <en/> The original vector
 * @returns  - <zh/> 三维向量 | <en/> Three-dimensional vector
 */
function toVector3(a) {
    return (0, is_1.isVector2)(a) ? [a[0], a[1], 0] : a;
}
/**
 * <zh/> 计算向量与 x 轴正方向的夹角（弧度制）
 *
 * <en/> The angle between the vector and the positive direction of the x-axis (radians)
 * @param a - <zh/> 向量 | <en/> The vector
 * @returns <zh/> 弧度值 | <en/> The angle in radians
 */
function rad(a) {
    const [x, y] = a;
    if (!x && !y)
        return 0;
    return Math.atan2(y, x);
}
//# sourceMappingURL=vector.js.map