Class Vector2D

Represtens a mathematical Vector on a Plane. The Vector must have only two components.

Hierarchy

Vector
- Vector2D
  - Complex

Index

Constructors

constructor

Properties

components

Accessors

x
y

Methods

Constructors

constructor

new Vector2D(...components: (number | number[] | readonly number[])[]): Vector2D

Overrides Vector.constructor
- Defined in 2D.ts:10
Constructor.

Parameters
- Rest ...components: (number | number[] | readonly number[])[]
Returns Vector2D

Properties

components

components: number[]

Contains all the components of the Vector.

Accessors

x

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

- Defined in 2D.ts:20
Returns number
- Defined in 2D.ts:28
Parameters
- value: number
Returns void

y

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

- Defined in 2D.ts:24
Returns number
- Defined in 2D.ts:32
Parameters
- value: number
Returns void

Methods

add

add(v: Vector, inPlace?: boolean): Vector

Inherited from Vector.add
- Defined in Vector.ts:135
Sums all entries of this Vector with those of the passed one.

remarks
This method creates new components and returns an Array with them. If inPlace is set as true, the method modifies this array.

Parameters
- v: Vector
  
  The Vector with the addends.
- inPlace: boolean = false
  
  Set as true to save the results in this Vector.
Returns Vector
A Vector containing the results.

clone

clone(): Vector

Inherited from Vector.clone
- Defined in Vector.ts:54
Clone this Vector.

Returns Vector
A copy of this Vector.

combine

combine(v: Vector): Vector

Inherited from Vector.combine
- Defined in Vector.ts:92
Create a new Vector with all entries from this Vector and the passed one.

Parameters
- v: Vector
  
  Vector to be combined.
Returns Vector
The new Vector.

cross

cross(v: Vector2D): number

- Defined in 2D.ts:41
Returns the cross products between two vectors.

Parameters
- v: Vector2D
  
  A Vector2D
Returns number
The scalar number result of the cross product.

dot

dot(v: Vector): number

Inherited from Vector.dot
- Defined in Vector.ts:190
Returns the dot product of two Vectors.

Parameters
- v: Vector
  
  A Vector.
Returns number
The dot product.

equals

equals(v: Vector): boolean

Inherited from Vector.equals
- Defined in Vector.ts:214
Returns true if the Vectors are equal.

remarks
This method takes in consideration the safe number precision of doubles.

beta
experimental
Parameters
- v: Vector
  
  A Vector.
Returns boolean
A boolean.

isNormal

isNormal(v: Vector): boolean

Inherited from Vector.isNormal
- Defined in Vector.ts:264
Return true if the Vectors are normal (a.k.a. perpendicular) to each other.

Parameters
- v: Vector
  
  A Vector.
Returns boolean
A boolean.

norm

norm(l?: number): number

Inherited from Vector.norm
- Defined in Vector.ts:239
Return the required norm. By default return the length of the Vector.

remarks
If l = 1, return the l1-norm (a.k.a. the Manhattan norm). If l = 2, return the l2-norm (a.k.a. the Euclidian norm). If you have no idea what these are you probably just want the default value for the distance between two points.

Parameters
- l: number = 2
  
  The type of norm.
Returns number
The value of the required norm.

normalize

normalize(inPlace?: boolean): Vector

Inherited from Vector.normalize
- Defined in Vector.ts:255
Scales this Vector so that its lenght is equal to one.

Parameters
- inPlace: boolean = false
  
  Set as true to save the results in this Vector.
Returns Vector
The normalized Vector.

opposite

opposite(inPlace?: boolean): Vector

Inherited from Vector.opposite
- Defined in Vector.ts:114
Sets all entries with opposite sign of this Vector's.

remarks
This method creates new components and returns an Array with them. If inPlace is set as true, the method modifies this array.

Parameters
- inPlace: boolean = false
  
  Set as true to save the results in this Vector.
Returns Vector
A Vector that has all entries opposite to this' ones.

scalar

scalar(n: number, inPlace?: boolean): Vector

Inherited from Vector.scalar
- Defined in Vector.ts:175
Scalar multiplication, scales this Vector by the given number.

Parameters
- n: number
  
  Scalar number
- inPlace: boolean = false
  
  Set as true to save the results in this Vector.
Returns Vector
A scaled Vector.

set

set(id: number, value: number): void

Inherited from Vector.set
- Defined in Vector.ts:25
Sets a single entry of the vector to a new value.

Parameters
- id: number
- value: number
Returns void

setComponents

setComponents(newcomps: number[]): void

Inherited from Vector.setComponents
- Defined in Vector.ts:20
Reset the components.

Parameters
- newcomps: number[]
Returns void

size

size(): number

Inherited from Vector.size
- Defined in Vector.ts:99
Returns number
The number of entries in this Vector.

sub

sub(v: Vector, inPlace?: boolean): Vector

Inherited from Vector.sub
- Defined in Vector.ts:164
Subtracts all entries of this Vector with those of the passed one.

remarks
This method creates new components and returns an Array with them. If inPlace is set as true, the method modifies this array.

Parameters
- v: Vector
  
  The Vector with the minuends.
- inPlace: boolean = false
  
  Set as true to save the results in this Vector.
Returns Vector
A Vector containing the differences.

toArray

toArray(): number[]

Inherited from Vector.toArray
- Defined in Vector.ts:62
Create an Array containing the components.

Returns number[]
An Array containing the components.

toObject

toObject(): object

Overrides Vector.toObject
- Defined in 2D.ts:55
Returns object

toPolar

toPolar(): PolarVector2D

- Defined in 2D.ts:51
Returns PolarVector2D

toString

toString(): string

Inherited from Vector.toString
- Defined in Vector.ts:72
Create a string describing the Vector.

beta
experimental
Returns string
A string describing the vector.

Static fromPolar

fromPolar(v: PolarVector2D): Vector2D

- Defined in 2D.ts:45
Parameters
- v: PolarVector2D
Returns Vector2D

Static ones

ones(n: number): Vector

Inherited from Vector.ones
- Defined in Vector.ts:45
Create a new vector of size n with all entries set as zero.

Parameters
- n: number
  
  Size of the new vector of ones.
Returns Vector
The new Vector created.

Static zeros

zeros(n: number): Vector

Inherited from Vector.zeros
- Defined in Vector.ts:35
Create a new vector of size n with all entries set as zero.

Parameters
- n: number
  
  Size of the new vector of zeros.
Returns Vector
The new Vector created.

Generated using TypeDoc