Class Vec<Length>

This is the super class. A generically lengthened vector that takes in a type argument for the length.

Type Parameters

Length extends number

Hierarchy

Vec

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Vec<Length>(points: TPoints<Length>, length: Length): Vec<Length>

- Defined in main.ts:17
Type Parameters
- Length extends number
Parameters
- points: TPoints<Length>
- length: Length
Returns Vec<Length>

Properties

length

length: Length

points

points: TPoints<Length>

Accessors

_unit

get _unit(): TPoints<Length>

- Defined in main.ts:157
Returns TPoints<Length>

size

get size(): number

- Defined in main.ts:146
Gives the magnitude of the vector

Returns number

sum

get sum(): number

- Defined in main.ts:153
Gives the values of the vector summed up

Returns number

unit

get unit(): Vec<Length>

- Defined in main.ts:166
Returns a unit vector of the current vector

Returns Vec<Length>

Methods

Protected _add

_add(rhs: Vec<Length>): TPoints<Length>

- Defined in main.ts:35
throws
MismatchedSizeError

Parameters
- rhs: Vec<Length>
Returns TPoints<Length>

Protected _div

_div(rhs: Vec<Length>): TPoints<Length>

- Defined in main.ts:104
throws
MismatchedSizeError

Parameters
- rhs: Vec<Length>
Returns TPoints<Length>

Protected _mul

_mul(rhs: Vec<Length>): TPoints<Length>

- Defined in main.ts:81
throws
MismatchedSizeError

Parameters
- rhs: Vec<Length>
Returns TPoints<Length>

Protected _pow

_pow(power: number): TPoints<Length>

- Defined in main.ts:112
Parameters
- power: number
Returns TPoints<Length>

Protected _sub

_sub(rhs: Vec<Length>): TPoints<Length>

- Defined in main.ts:58
throws
MismatchedSizeError

Parameters
- rhs: Vec<Length>
Returns TPoints<Length>

add

add(rhs: Vec<Length>): Vec<Length>

- Defined in main.ts:48
Adds two vectors together

throws
MismatchedSizeError

Parameters
- rhs: Vec<Length>
Returns Vec<Length>

Protected div

div(rhs: Vec<Length>): Vec<Length>

- Defined in main.ts:130
Divides each value of two vectors together

throws
MismatchedSizeError

Parameters
- rhs: Vec<Length>
Returns Vec<Length>

dot

dot(rhs: Vec<Length>): number

- Defined in main.ts:139
Gives the dot product of two vectors

throws
MismatchedSizeError

Parameters
- rhs: Vec<Length>
Returns number

mul

mul(rhs: Vec<Length>): Vec<Length>

- Defined in main.ts:94
Multiples each value of two vectors together

throws
MismatchedSizeError

Parameters
- rhs: Vec<Length>
Returns Vec<Length>

pow

pow(power: number): Vec<Length>

- Defined in main.ts:120
Raises each element to the power given

Parameters
- power: number
Returns Vec<Length>

sub

sub(rhs: Vec<Length>): Vec<Length>

- Defined in main.ts:71
Subtracts two vectors togethers

throws
MismatchedSizeError

Parameters
- rhs: Vec<Length>
Returns Vec<Length>

Static fromScalar

fromScalar<Length>(value: number, length: Length): Vec<Length>

- Defined in main.ts:25
This function creates a vector where each element is the same value

Type Parameters
- Length extends number
Parameters
- value: number
  
  The value for each element to be
- length: Length
  
  The length of the vector
Returns Vec<Length>

Generated using TypeDoc