Class Vector

Hierarchy

Vector

Implements

VectorType

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Vector(elements?: number[]): Vector

- Defined in src/anigraph/amath/Vector.ts:24
Parameters
- Optional elements: number[]
Returns Vector

Properties

elements

elements: number[] = []

Static N_DIMENSIONS

N_DIMENSIONS: number = -1

Accessors

nDimensions

get nDimensions(): number

- Defined in src/anigraph/amath/Vector.ts:44
Returns number

serializationLabel

get serializationLabel(): any

- Defined in src/anigraph/amath/Vector.ts:274
Returns any

x

get x(): number
set x(val: number): void

- Defined in src/anigraph/amath/Vector.ts:38
Returns number
- Defined in src/anigraph/amath/Vector.ts:39
Parameters
- val: number
Returns void

y

get y(): number
set y(val: number): void

- Defined in src/anigraph/amath/Vector.ts:40
Returns number
- Defined in src/anigraph/amath/Vector.ts:41
Parameters
- val: number
Returns void

Methods

L2

L2(): number

- Defined in src/anigraph/amath/Vector.ts:58
Returns number

_setToDefault

_setToDefault(): void

- Defined in src/anigraph/amath/Vector.ts:48
Returns void

addVector

addVector(other: VectorType): void

- Defined in src/anigraph/amath/Vector.ts:224
Adds the other vector's elements to this vector's elements

Parameters
- other: VectorType
Returns void

clone

clone(): Vector

- Defined in src/anigraph/amath/Vector.ts:98
Clones the vector

Returns Vector

dot

dot(other: VectorType): number

- Defined in src/anigraph/amath/Vector.ts:84
Returns the dot product of two vectors. Vectors must have equal length.

Parameters
- other: VectorType
Returns number

fmax

fmax(): number

- Defined in src/anigraph/amath/Vector.ts:246
Returns number

forEach

forEach(fn: (e: number, i: number) => any, context: any): void

- Defined in src/anigraph/amath/Vector.ts:127
Parameters
- fn: (e: number, i: number) => any
  
  function to be executed on each element
  - - (e: number, i: number): any
    - Parameters
      - e: number
      - i: number
      Returns any
- context: any
  
  context for execution
Returns void

getMapped

getMapped(fn: (e: number, i: number) => number, context?: any): Vector

- Defined in src/anigraph/amath/Vector.ts:112
Returns a VectorType with each of its elements replaced by fn(e) where e is the corresponding element of this vector

Parameters
- fn: (e: number, i: number) => number
  
  function to be run on each element. e is the element value, and i is its index. Should return a new element.
  - - (e: number, i: number): number
    - Parameters
      - e: number
      - i: number
      Returns number
- Optional context: any
  
  the context for the function call. In other words, what is to be used as the 'this' variable when running the call.
Returns Vector
- Vectgor of the results from running fn on each element of this.elements

getNormalized

getNormalized(): Vector

- Defined in src/anigraph/amath/Vector.ts:169
Returns Vector

getRounded

getRounded(): Vector

- Defined in src/anigraph/amath/Vector.ts:259
Returns Vector

inspect

inspect(): string

- Defined in src/anigraph/amath/Vector.ts:265
Returns string

isEqualTo

isEqualTo(other: VectorType, tolerance?: number): boolean

- Defined in src/anigraph/amath/Vector.ts:66
Return true if this.elements are within precision equal to other.elements

Parameters
- other: VectorType
- Optional tolerance: number
Returns boolean

minus

minus(other: VectorType): Vector

- Defined in src/anigraph/amath/Vector.ts:199
Return a new vector that is the difference of this vector and other

Parameters
- other: VectorType
Returns Vector

normalize

normalize(): void

- Defined in src/anigraph/amath/Vector.ts:157
Normalizes the vector. If the vector already has length 0, then it does nothing.

Returns void

plus

plus(other: VectorType): Vector

- Defined in src/anigraph/amath/Vector.ts:189
Return a new vector that is the sum of this vector and other

Parameters
- other: VectorType
Returns Vector

setElements

setElements(els: number[]): Vector

- Defined in src/anigraph/amath/Vector.ts:269
Parameters
- els: number[]
Returns Vector

sstring

sstring(): string

- Defined in src/anigraph/amath/Vector.ts:279
Returns string

subtractVector

subtractVector(other: VectorType): void

- Defined in src/anigraph/amath/Vector.ts:237
Subtracts the other vector's elements from this vector's elements

Parameters
- other: VectorType
Returns void

times

times(k: number): Vector

- Defined in src/anigraph/amath/Vector.ts:214
Returns this vector multiplied by the scalar k

Parameters
- k: number
Returns Vector

timesElementWise

timesElementWise(v: Vector): Vector

- Defined in src/anigraph/amath/Vector.ts:204
Parameters
- v: Vector
Returns Vector

toJSON

toJSON(): {}

- Defined in src/anigraph/amath/Vector.ts:322
Returns {}
- [name: string]: any

Static Ones

Ones(n?: number): Vector

- Defined in src/anigraph/amath/Vector.ts:145
Parameters
- n: number = 1
Returns Vector

Static Random

Random(n?: number): Vector

- Defined in src/anigraph/amath/Vector.ts:134
Parameters
- n: number = 1
Returns Vector

Static Zeros

Zeros(n?: number): Vector

- Defined in src/anigraph/amath/Vector.ts:139
Parameters
- n: number = 1
Returns Vector

Static flatten

flatten(...vecs: (number | any[] | ExtendsVector)[]): number[]

- Defined in src/anigraph/amath/Vector.ts:296
Parameters
- Rest ...vecs: (number | any[] | ExtendsVector)[]
Returns number[]

Generated using TypeDoc