Class Vector

Hierarchy

Vector
- Vertex

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Vector(elements: VectorOrList): Vector

- Defined in src/vector.ts:73
Parameters
- elements: VectorOrList
Returns Vector

Properties

elements

elements: ReadonlyArray<number>

Static i

i: Vector = new Vector([1, 0, 0])

Static j

j: Vector = new Vector([0, 1, 0])

Static k

k: Vector = new Vector([0, 0, 1])

Methods

add

add(value: VectorOrList | number): Vector

- Defined in src/vector.ts:304
Parameters
- value: VectorOrList | number
Returns Vector

angleFrom

angleFrom(vector: VectorOrList): number

- Defined in src/vector.ts:210
Parameters
- vector: VectorOrList
Returns number

augment

augment(elements: VectorOrList): Vector

- Defined in src/vector.ts:381
Parameters
- elements: VectorOrList
Returns Vector

chomp

chomp(n: number): Vector

- Defined in src/vector.ts:355
Parameters
- n: number
Returns Vector

cols

cols(): number

- Defined in src/vector.ts:132
Returns number

cross

cross(vector: VectorOrList): Vector

- Defined in src/vector.ts:427
Parameters
- vector: VectorOrList
Returns Vector

dimensions

dimensions(): object

- Defined in src/vector.ts:111
Returns object

the "rows" will always equal zero
- cols: number
- rows: number

distanceFrom

distanceFrom(obj: Geometry): number

- Defined in src/vector.ts:534
Parameters
- obj: Geometry
Returns number

dot

dot(vector: VectorOrList): number

- Defined in src/vector.ts:405
Parameters
- vector: VectorOrList
Returns number

e

e(i: number): null | number

- Defined in src/vector.ts:102
Parameters
- i: number
Returns null | number

each

each(fn: function): void

- Defined in src/vector.ts:181
Parameters
- fn: function
  - - (value: number, index: number): void
    - Parameters
      - value: number
      - index: number
      Returns void
Returns void

eql

eql(other: unknown, precision?: number): boolean

- Defined in src/vector.ts:141
Parameters
- other: unknown
- Default value precision: number = Sylvester.approxPrecision
Returns boolean

indexOf

indexOf(x: number): number

- Defined in src/vector.ts:482
Parameters
- x: number
Returns number

isAntiparallelTo

isAntiparallelTo(vector: VectorOrList, epsilon?: number): boolean

- Defined in src/vector.ts:264
Parameters
- vector: VectorOrList
- Default value epsilon: number = Sylvester.precision
Returns boolean

isParallelTo

isParallelTo(obj: Geometry, epsilon?: number): boolean

- Defined in src/vector.ts:249
Parameters
- obj: Geometry
- Default value epsilon: number = Sylvester.precision
Returns boolean

isPerpendicularTo

isPerpendicularTo(obj: Geometry, epsilon?: number): boolean

- Defined in src/vector.ts:274
Parameters
- obj: Geometry
- Default value epsilon: number = Sylvester.precision
Returns boolean

liesIn

liesIn(plane: Plane): boolean

- Defined in src/vector.ts:562
Parameters
- plane: Plane
Returns boolean

liesOn

liesOn(line: Line): boolean

- Defined in src/vector.ts:554
Parameters
- line: Line
Returns boolean

log

log(base?: number): Vector

- Defined in src/vector.ts:624
Parameters
- Default value base: number = Math.E
Returns Vector

magnitude

magnitude(): number

- Defined in src/vector.ts:88
Returns number

map

map(fn: function): Vector

- Defined in src/vector.ts:168
Parameters
- fn: function
  - - (value: number, index: number): number
    - Parameters
      - value: number
      - index: number
      Returns number
Returns Vector

max

max(): number

- Defined in src/vector.ts:447
Returns number

maxIndex

maxIndex(): number

- Defined in src/vector.ts:463
Returns number

Will be -1 if the vector is empty

multiply

multiply(value: VectorOrList | number): Vector

- Defined in src/vector.ts:327
Parameters
- value: VectorOrList | number
Returns Vector

product

product(): number

- Defined in src/vector.ts:389
Returns number

reflectionIn

reflectionIn(obj: VectorOrList | Line | Plane): Vector

- Defined in src/vector.ts:602
Parameters
- obj: VectorOrList | Line | Plane
Returns Vector

rotate2D

rotate2D(t: number | Matrix, obj: VectorOrList): Vector

- Defined in src/vector.ts:571
Parameters
- t: number | Matrix
- obj: VectorOrList
Returns Vector

rotate3D

rotate3D(t: number | Matrix, obj: Line): Vector

- Defined in src/vector.ts:584
Parameters
- t: number | Matrix
- obj: Line
Returns Vector

round

round(): Vector

- Defined in src/vector.ts:503
Returns Vector

rows

rows(): number

- Defined in src/vector.ts:123
Returns number

always 1

snapTo

snapTo(target: number, epsilon?: number): Vector

- Defined in src/vector.ts:526
Parameters
- target: number
- Default value epsilon: number = Sylvester.precision
Returns Vector

subtract

subtract(value: VectorOrList | number): Vector

- Defined in src/vector.ts:315
Parameters
- value: VectorOrList | number
Returns Vector

sum

sum(): number

- Defined in src/vector.ts:343
Returns number

to3D

to3D(): Vector

- Defined in src/vector.ts:633
Returns Vector

toDiagonalMatrix

toDiagonalMatrix(): Matrix

- Defined in src/vector.ts:495
Returns Matrix

toDimension

toDimension(n: number): Vector

- Defined in src/vector.ts:641
Parameters
- n: number
Returns Vector

toJSON

toJSON(): ReadonlyArray<number>

- Defined in src/vector.ts:666
Returns ReadonlyArray<number>

toString

toString(): string

- Defined in src/vector.ts:659
Returns string

toUnitVector

toUnitVector(): Vector

- Defined in src/vector.ts:193
Returns Vector

top

top(n: number): Vector

- Defined in src/vector.ts:368
Parameters
- n: number
Returns Vector

transpose

transpose(): Matrix

- Defined in src/vector.ts:511
Returns Matrix

x

x(value: VectorOrList | number): Vector

- Defined in src/vector.ts:335
Parameters
- value: VectorOrList | number
Returns Vector

Static Fill

Fill(size: number, value: number): Vector

- Defined in src/vector.ts:684
Parameters
- size: number
- value: number
Returns Vector

Static One

One(n: number): Vector

- Defined in src/vector.ts:702
Parameters
- n: number
Returns Vector

Static Random

Random(size: number): Vector

- Defined in src/vector.ts:673
Parameters
- size: number
Returns Vector

Static Zero

Zero(n: number): Vector

- Defined in src/vector.ts:695
Parameters
- n: number
Returns Vector

Static Private toElements

toElements(vectorOrElements: VectorOrList, requireDimension: undefined | number): ReadonlyArray<number>

- Defined in src/vector.ts:34
Parameters
- vectorOrElements: VectorOrList
- Optional requireDimension: undefined | number
Returns ReadonlyArray<number>

Generated using TypeDoc