Module "gvec"

Const gvec

• gvec(buf: Vec, size: number, offset?: number, stride?: number): IVector<any>

• Wrapper for strided, arbitrary length vectors.

  remarks

  Wraps given buffer in ES6 Proxy with custom property getters/setters and implements the following interfaces:

  • Iterable (ES6)
  • {@link @thi.ng/api#ICopy}
  • {@link @thi.ng/api#IEmpty}
  • {@link @thi.ng/api#IEqualsDelta}
  • IVector
  • Object.toString()

  Read/write access for the following properties:

  • array indices in the [0 .. size) interval
  • offset - start index
  • stride - component stride
  • buf - backing buffer (readonly)
  • length - vector size

  Array index access uses bounds checking against the [0 .. size) interval, but, for performance reasons, not against the actual wrapped buffer.

  Note: ES6 proxies are ~10x slower than standard array accesses. If several computations are to be performed on such vectors it will be much more efficient to first copy them to compact arrays and then copy result back if needed.

  example

  // 3D vector w/ stride length of 4
  a = gvec([1,0,0,0,2,0,0,0,3,0,0,0], 3, 0, 4);
  a[0] // 1
  a[1] // 2
  a[2] // 3
  
  a.stride
  // 4
  
  [...a]
  // [1, 2, 3]
  
  a.toString()
  // "[1,2,3]"
  
  add([], a, a)
  // [2, 4, 6]
  
  copy(a)
  // [1, 2, 3]
  
  a.copyView()
  // Proxy [ [ 1, 0, 2, 0, 3, 0 ], ... }
  
  eqDelta(a, [1, 2, 3])
  // true

  Parameters

  • buf: Vec

    backing buffer

  • size: number

    vector size / num components

  • Default value offset: number = 0

    start index

  • Default value stride: number = 1

    component stride

  Returns IVector<any>