tsmathlib/src/math/vector.ts

Typescript Version Math/Physics/CG Library

/*
 * @Author: Xu.Wang
 * @Date: 2020-03-31 17:30:28
 * @Last Modified by: Xu.Wang
 * @Last Modified time: 2020-04-07 18:32:57
 */

import { absMax, absMin } from './math_utils'
import { VectorData } from './interface'
import { TS_EPSILON } from './math_constants'

/**
 * Vector
 *  T-D vector data
 *  T:type,default setting is number
 *  D:dimension
 */
export class Vector {
  _elements: Array<number>
  _dimension: number

  // constructs vector with parameters or zero
  constructor(dimension: number, params?: Array<number>) {
    this._dimension = dimension
    let _i = 0
    if (params === undefined) {
      // init n dimension vector data,setting all 0
      this._elements = new Array<number>(dimension)
      for (_i = 0; _i < dimension; _i++) {
        this._elements[_i] = 0
      }
    } else {
      this._elements = new Array<number>(dimension)
      for (_i = 0; _i < params.length; _i++) {
        this._elements[_i] = params[_i]
      }
    }
  }

  set(params: Vector | undefined) {
    if (params !== undefined) {
      if (params.size() !== this.size()) {
        console.log('dimension is not correct!')
        return false
      }
      for (let _i = 0; _i < params.size(); _i++) {
        this._elements[_i] = params.data()[_i]
      }

      return true
    }
    return false
  }

  private _fill(n: number) {
    let values = new Array<number>(this._dimension)
    values.fill(n)
    return new Vector(this._dimension, values)
  }

  ones() {
    return this._fill(1)
  }

  zeros() {
    return this._fill(0)
  }

  setZero() {
    this._elements.fill(0)
  }

  setOne() {
    this._elements.fill(1)
  }

  setValues(n: number) {
    this._elements.fill(n)
  }

  data() {
    return this._elements
  }

  at(idx: number) {
    if (idx < 0 || idx >= this.size()) {
      console.log('index is not correct!')
      return -1
    }
    return this._elements[idx]
  }

  dot(others: Vector | undefined) {
    if (others === undefined) {
      console.log('others is not correct!')
      return -1
    }
    if (others.size() !== this.size()) {
      console.log('dimension is not correct!')
      return -1
    }

    let ret = 0
    for (let _i = 0; _i < this.size(); _i++) {
      ret += this._elements[_i] * others.data()[_i]
    }
    return ret
  }

  lengthSquared() {
    return this.dot(this)
  }

  length() {
    return Math.sqrt(this.lengthSquared())
  }

  /**
   * Normalizes current vector
   */
  normalize() {
    this.idiv(this.length())
  }

  /**
   * Normalized vector
   * @returns normalized vector
   */
  normalized(): Vector {
    return this.div(this.length())
  }

  sum() {
    let ret = 0
    for (let _i = 0; _i < this._dimension; _i++) {
      ret += this._elements[_i]
    }
    return ret
  }

  size() {
    return this._dimension
  }

  avg() {
    return this.sum() / this.size()
  }

  min() {
    let minVal = this._elements[0]

    for (let _i = 1; _i < this._dimension; _i++) {
      minVal = Math.min(minVal, this._elements[_i])
    }
    return minVal
  }

  max() {
    let maxVal = this._elements[0]
    for (let _i = 1; _i < this._dimension; _i++) {
      maxVal = Math.max(maxVal, this._elements[_i])
    }
    return maxVal
  }

  absmax() {
    let absMaxVal = this._elements[0]
    for (let _i = 1; _i < this._dimension; _i++) {
      absMaxVal = absMax(absMaxVal, this._elements[_i])
    }
    return absMaxVal
  }

  absmin() {
    let absMinVal = this._elements[0]
    for (let _i = 1; _i < this._dimension; _i++) {
      absMinVal = absMin(absMinVal, this._elements[_i])
    }
    return absMinVal
  }

  distanceSquaredTo(others: Vector) {
    if (others.size() !== this.size()) {
      console.log('dimension is not correct!')
      return -1
    }

    let ret = 0
    for (let _i = 0; _i < this.size(); _i++) {
      let diff = this._elements[_i] - others.data()[_i]
      ret += diff * diff
    }

    return ret
  }

  distanceTo(others: Vector) {
    return Math.sqrt(this.distanceSquaredTo(others))
  }

  isEqual(others: Vector) {
    if (this.size() !== others.size()) return false

    for (let _i = 0; _i < this.size(); _i++) {
      if (this.at(_i) !== others.at(_i)) return false
    }

    return true
  }

  isSimilar(others: Vector | undefined, epsilon: number = TS_EPSILON) {
    if (others === undefined) return false
    if (this.size() !== others.size()) return false

    for (let _i = 0; _i < this.size(); _i++) {
      if (Math.abs(this.at(_i) - others.at(_i)) > epsilon) return false
    }

    return true
  }

  add(params?: any) {
    let _i = 0
    if (typeof params === 'object') {
      let v = params
      if (v.size() !== this.size()) return new Vector(1, [-1])

      let newV = new Vector(this.size(), this.data())
      for (_i = 0; _i < newV.size(); _i++) {
        newV.data()[_i] += v.data()[_i]
      }

      return newV
    } else if (typeof params === 'number') {
      let s = params
      let newV = new Vector(this.size(), this.data())
      for (_i = 0; _i < newV.size(); _i++) {
        newV.data()[_i] += s
      }

      return newV
    }

    return new Vector(1, [-1])
  }

  sub(params?: any) {
    let _i = 0
    if (typeof params === 'object') {
      let v = params
      if (v.size() !== this.size()) return new Vector(1, [-1])

      let newV = new Vector(this.size(), this.data())
      for (_i = 0; _i < newV.size(); _i++) {
        newV.data()[_i] -= v.data()[_i]
      }

      return newV
    } else if (typeof params === 'number') {
      let s = params
      let newV = new Vector(this.size(), this.data())
      for (_i = 0; _i < newV.size(); _i++) {
        newV.data()[_i] -= s
      }

      return newV
    }

    return new Vector(1, [-1])
  }

  mul(params?: any) {
    let _i = 0
    if (typeof params === 'object') {
      let v = params
      if (v.size() !== this.size()) return new Vector(1, [-1])

      let newV = new Vector(this.size(), this.data())
      for (_i = 0; _i < newV.size(); _i++) {
        newV.data()[_i] *= v.data()[_i]
      }

      return newV
    } else if (typeof params === 'number') {
      let s = params
      let newV = new Vector(this.size(), this.data())
      for (_i = 0; _i < newV.size(); _i++) {
        newV.data()[_i] *= s
      }

      return newV
    }

    return new Vector(1, [-1])
  }

  div(params?: any) {
    let _i = 0
    if (typeof params === 'object') {
      let v = params
      if (v.size() !== this.size()) return new Vector(1, [-1])

      let newV = new Vector(this.size(), this.data())
      for (_i = 0; _i < newV.size(); _i++) {
        newV.data()[_i] /= v.data()[_i]
      }

      return newV
    } else if (typeof params === 'number') {
      let s = params
      if (s === 0) return new Vector(1, [-1])
      let newV = new Vector(this.size(), this.data())
      for (_i = 0; _i < newV.size(); _i++) {
        newV.data()[_i] /= s
      }

      return newV
    }

    return new Vector(1, [-1])
  }

  idiv(params?: any) {
    this.set(this.div(params))
  }

  iadd(params?: any) {
    this.set(this.add(params))
  }

  isub(params?: any) {
    this.set(this.sub(params))
  }

  imul(params?: any) {
    this.set(this.mul(params))
  }

  rsub(params?: any) {
    let _i = 0
    if (typeof params === 'object') {
      let v = params
      if (v.size() !== this.size()) return new Vector(1, [-1])

      let newV = new Vector(this.size(), v.data())
      for (_i = 0; _i < newV.size(); _i++) {
        newV.data()[_i] -= this.data()[_i]
      }

      return newV
    } else if (typeof params === 'number') {
      let s = params
      let newV = new Vector(this.size(), this.data())
      for (_i = 0; _i < newV.size(); _i++) {
        newV.data()[_i] = s - newV.data()[_i]
      }

      return newV
    }

    return new Vector(1, [-1])
  }

  rdiv(params?: any) {
    let _i = 0
    if (typeof params === 'object') {
      let v = params
      if (v.size() !== this.size()) return new Vector(1, [-1])

      let newV = new Vector(v.size(), v.data())
      for (_i = 0; _i < newV.size(); _i++) {
        newV.data()[_i] /= this.data()[_i]
      }

      return newV
    } else if (typeof params === 'number') {
      let s = params
      if (s === 0) return new Vector(1, [-1])
      let newV = new Vector(this.size(), this.data())
      for (_i = 0; _i < newV.size(); _i++) {
        newV.data()[_i] = s / newV.data()[_i]
      }

      return newV
    }
    return new Vector(1, [-1])
  }

  setAt(idx: number, val: number) {
    if (idx < 0 || idx >= this.size()) {
      return undefined
    }

    this._elements[idx] = val
    return true
  }

  /**
   * proj_u(v) = <u,v>/<v,v> u
   * @param u
   * @param v
   */
  static proj(u: Vector, v: Vector) {
    return u.mul(v.dot(u) / u.dot(u))
  }

  forEachData(data: VectorData) {
    for (let _i = 0; _i < this.size(); _i++) {
      data(this.at(_i))
    }
  }

  printVector() {
    let printStr = '[ '
    this.forEachData((d: number) => {
      printStr += d.toString() + ' '
    })
    printStr += ']'
    console.log(printStr)
  }
}