Vector | space3

Brief

Vector represents a vector in a normed vector space. It might be numerical vectors, matrices, or something more complicated.

Main Features

Copy and Clone copy, clone, assign, ...
Manipulators floor, fill, abs, ...
Algebra add, sub, inv, mul, prod, ...
Linear, cubic and Bezier's Interpolation lerp, herp, ...
Equality, zeros and distance methods equal2, mag, dist1, ...
Provide immutable operations by cloning addc, subc, ...

Example

let u = Vector3.ex.mul(5.5), v = u.clone();
u.floor(); // u = (5, 0, 0)
u.lerp(v, 0.5) // u = (5.25, 0, 0);
u.comb(2, v) // u = (16.25, 0, 0);

Getting Started

Algebra and interpolation

Perform additions, scalar multiplication, linear interpolation and many other common operations. Take a look at the glossary of operations to have an exhaustive list.

Example

u.add(v).sub(w).comb(lambda, w);
a.prod(b).inv();

Theses operations are the core of space3 framework. Almost all classes of the framework provide or use theses.

if you need a little refresh on algebra, I recommend you to watch the great algebra curse on 3Blue1Brown channel.

The operations are defined in the reference by mentioning two vectors u and v. it's admitted that :

u refers to this in the code
v refers to the parameter vector in the code
The result is stored in this
If the method is suffixed by c, the result is a newly created Vector

Comparison and zeros

In order to avoid float precision errors and allow you to choose the most pertinent comparison, a Vector provides three different ways to compare to another one :

Using the norm 1, manhattan distance
Using the norm 2, dot product distance
Using exact comparison coordinates by coordinates.

The first two comparison are based on the following definition of norms :

Norm

Given a norm the distance between two vector is defined by :

Distance

Example

let ex = Vector3.ex, ey = Vector3.ey, zeros = Vector3.zeros;
ex.equal2(ey) // false
ex.equal1(ey) // false
ex.exact(ex) // true
ex.zero1() // false
zeros.nil() // true
zeros.add(ex.mul(0.5 * Number.EPSILON)).nil() // false

Note mag, mag2 accessors uses the norm 2

If you don't know which comparison to use, I recommend you dist, equal2 and zero2 to compare objects by default.

Hierarchy

Encoder
- Vector
  - Matrix

Implemented by

Indexable

[index: number]: number

Brief

Vector represents a vector in a normed vector space. It might be numerical vectors, matrices, or something more complicated.

Main Features

Copy and Clone copy, clone, assign, ...
Manipulators floor, fill, abs, ...
Algebra add, sub, inv, mul, prod, ...
Linear, cubic and Bezier's Interpolation lerp, herp, ...
Equality, zeros and distance methods equal2, mag, dist1, ...
Provide immutable operations by cloning addc, subc, ...

Example

let u = Vector3.ex.mul(5.5), v = u.clone();
u.floor(); // u = (5, 0, 0)
u.lerp(v, 0.5) // u = (5.25, 0, 0);
u.comb(2, v) // u = (16.25, 0, 0);

Getting Started

Algebra and interpolation

Perform additions, scalar multiplication, linear interpolation and many other common operations. Take a look at the glossary of operations to have an exhaustive list.

Example

u.add(v).sub(w).comb(lambda, w);
a.prod(b).inv();

Theses operations are the core of space3 framework. Almost all classes of the framework provide or use theses.

if you need a little refresh on algebra, I recommend you to watch the great algebra curse on 3Blue1Brown channel.

The operations are defined in the reference by mentioning two vectors u and v. it's admitted that :

u refers to this in the code
v refers to the parameter vector in the code
The result is stored in this
If the method is suffixed by c, the result is a newly created Vector

Comparison and zeros

In order to avoid float precision errors and allow you to choose the most pertinent comparison, a Vector provides three different ways to compare to another one :

Using the norm 1, manhattan distance
Using the norm 2, dot product distance
Using exact comparison coordinates by coordinates.

The first two comparison are based on the following definition of norms :

Norm

Given a norm the distance between two vector is defined by :

Distance

Example

let ex = Vector3.ex, ey = Vector3.ey, zeros = Vector3.zeros;
ex.equal2(ey) // false
ex.equal1(ey) // false
ex.exact(ex) // true
ex.zero1() // false
zeros.nil() // true
zeros.add(ex.mul(0.5 * Number.EPSILON)).nil() // false

Note mag, mag2 accessors uses the norm 2

If you don't know which comparison to use, I recommend you dist, equal2 and zero2 to compare objects by default.

Index

Properties

Methods

Properties

BYTES_PER_ELEMENT

BYTES_PER_ELEMENT: number

The size in bytes of each element in the array.

__@toStringTag

__@toStringTag: "Float64Array"

buffer

buffer: ArrayBufferLike

The ArrayBuffer instance referenced by the array.

byteLength

byteLength: number

The length in bytes of the array.

byteOffset

byteOffset: number

The offset in bytes of the array.

dim

dim: number

dimension of the vector

length

length: number

The length of the array.

mag

mag: number

magnitude of the vector ||u||

mag2

mag2: number

squared magnitude of the vector u . u

Methods

__@iterator

__@iterator(): IterableIterator<number>

Inherited from Float64Array.[Symbol.iterator]
- Defined in /home/travis/build/samiBendou/space3/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:468
Returns IterableIterator<number>

abs

abs(): this

- Defined in int/Vector.ts:128
Math.abs of the components

Returns this

absc

absc(): Vector

- Defined in int/Vector.ts:130
Returns Vector

add

add(vector: Vector): this

- Defined in int/Vector.ts:148
usual addition between two vectors u + v

Parameters
- vector: Vector
Returns this

addc

addc(vector: Vector): Vector

- Defined in int/Vector.ts:150
Parameters
- vector: Vector
Returns Vector

array

array(): number[]

Inherited from Encoder.array
- Defined in int/Encoder.ts:18
native Javascript array containing object's content

Returns number[]

assign

assign(...coordinates: number[]): this

- Defined in int/Vector.ts:90
assigns components to a vector

Parameters
- Rest ...coordinates: number[]
Returns this

berp

berp(target: Vector, vector1: Vector, vector2: Vector, s: number): this

- Defined in int/Vector.ts:207
brief

Bezier's interpolation between two vectors

details

s must be between 0 and 1. Starting vector is this.

Parameters
- target: Vector
  
  destination of interpolation
- vector1: Vector
  
  control point number 1
- vector2: Vector
  
  control point number 2
- s: number
  
  parameter of the interpolation.
Returns this

berpc

berpc(target: Vector, vector1: Vector, vector2: Vector, s: number): Vector

- Defined in int/Vector.ts:209
Parameters
- target: Vector
- vector1: Vector
- vector2: Vector
- s: number
Returns Vector

ceil

ceil(): this

- Defined in int/Vector.ts:113
Math.ceil of the components

Returns this

ceilc

ceilc(): Vector

- Defined in int/Vector.ts:115
Returns Vector

clone

clone(): Vector

- Defined in int/Vector.ts:96
clone this vector

Returns Vector

comb

comb(s: number, vector: Vector): this

- Defined in int/Vector.ts:173
linear combination of a scalar and a vector u + s * v

Parameters
- s: number
- vector: Vector
Returns this

combc

combc(s: number, vector: Vector): Vector

- Defined in int/Vector.ts:175
Parameters
- s: number
- vector: Vector
Returns Vector

copy

copy(vector: Vector): this

- Defined in int/Vector.ts:93
copies a source vector into this component by component

Parameters
- vector: Vector
Returns this

copyWithin

copyWithin(target: number, start: number, end?: number): this

Inherited from Float64Array.copyWithin
- Defined in /home/travis/build/samiBendou/space3/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:3854
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: number
  
  If not specified, length of the this object is used as its default value.
Returns this

der

der(ds: number, vector: Vector): this

- Defined in int/Vector.ts:212
derivative between the two vectors with given step (u - v) / ds

Parameters
- ds: number
- vector: Vector
Returns this

derc

derc(ds: number, vector: Vector): Vector

- Defined in int/Vector.ts:214
Parameters
- ds: number
- vector: Vector
Returns Vector

dist

dist(vector: Vector): number

- Defined in int/Vector.ts:235
distance distance between two vectors d2(u, v)

Parameters
- vector: Vector
Returns number

dist1

dist1(vector: Vector): number

- Defined in int/Vector.ts:238
distance between two vectors given by norm 1 d1(u, v)

Parameters
- vector: Vector
Returns number

dist2

dist2(vector: Vector): number

- Defined in int/Vector.ts:241
squared distance between two vectors given by norm 2 d2(u, v)**2

Parameters
- vector: Vector
Returns number

div

div(s: number): this

- Defined in int/Vector.ts:168
usual scalar division of the vector u / s

Parameters
- s: number
Returns this

divc

divc(s: number): Vector

- Defined in int/Vector.ts:170
Parameters
- s: number
Returns Vector

dot

dot(vector: Vector): number

- Defined in int/Vector.ts:232
usual dot product of two vector u . v

Parameters
- vector: Vector
Returns number

entries

entries(): IterableIterator<[number, number]>

Inherited from Float64Array.entries
- Defined in /home/travis/build/samiBendou/space3/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:472
Returns an array of key, value pairs for every entry in the array

Returns IterableIterator<[number, number]>

equal1

equal1(vector: Vector): boolean

- Defined in int/Vector.ts:247
true if the distance 1 between vectors is 0

Parameters
- vector: Vector
Returns boolean

equal2

equal2(vector: Vector): boolean

- Defined in int/Vector.ts:250
true if the distance 2 between vectors is 0

Parameters
- vector: Vector
Returns boolean

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Float64Array.every
- Defined in /home/travis/build/samiBendou/space3/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:3864
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: number, index: number, array: Float64Array): boolean
    - Parameters
      - value: number
      - index: number
      - array: Float64Array
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

exact

exact(vector: Vector): boolean

- Defined in int/Vector.ts:244
true if the vectors have exactly the same coordinates

Parameters
- vector: Vector
Returns boolean

fill

fill(s: number): this

Overrides Float64Array.fill
- Defined in int/Vector.ts:143
fills this vector with a single scalar value s

Parameters
- s: number
Returns this

fillc

fillc(s: number): Vector

- Defined in int/Vector.ts:145
Parameters
- s: number
Returns Vector

filter

filter(callbackfn: function, thisArg?: any): Float64Array

Inherited from Float64Array.filter
- Defined in /home/travis/build/samiBendou/space3/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:3883
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: number, index: number, array: Float64Array): any
    - Parameters
      - value: number
      - index: number
      - array: Float64Array
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns Float64Array

find

find(predicate: function, thisArg?: any): number | undefined

Inherited from Float64Array.find
- Defined in /home/travis/build/samiBendou/space3/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:3894
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (value: number, index: number, obj: Float64Array): boolean
    - Parameters
      - value: number
      - index: number
      - obj: Float64Array
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Float64Array.findIndex
- Defined in /home/travis/build/samiBendou/space3/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:3905
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: number, index: number, obj: Float64Array): boolean
    - Parameters
      - value: number
      - index: number
      - obj: Float64Array
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

floor

floor(): this

- Defined in int/Vector.ts:108
Math.floor of the components

Returns this

floorc

floorc(): Vector

- Defined in int/Vector.ts:110
Returns Vector

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Float64Array.forEach
- Defined in /home/travis/build/samiBendou/space3/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:3914
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: number, index: number, array: Float64Array): void
    - Parameters
      - value: number
      - index: number
      - array: Float64Array
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

herp

herp(target: Vector, vector1: Vector, vector2: Vector, s: number): this

- Defined in int/Vector.ts:195
brief

Hermite's interpolation between two vectors

details

s must be between 0 and 1. Starting vector is this.

Parameters
- target: Vector
  
  destination of interpolation
- vector1: Vector
  
  control point number 1
- vector2: Vector
  
  control point number 2
- s: number
  
  parameter of the interpolation.
Returns this

herpc

herpc(target: Vector, vector1: Vector, vector2: Vector, s: number): Vector

- Defined in int/Vector.ts:197
Parameters
- target: Vector
- vector1: Vector
- vector2: Vector
- s: number
Returns Vector

includes

includes(searchElement: number, fromIndex?: number): boolean

Inherited from Float64Array.includes
- Defined in /home/travis/build/samiBendou/space3/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:117
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: number
  
  The element to search for.
- Optional fromIndex: number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: number, fromIndex?: number): number

Inherited from Float64Array.indexOf
- Defined in /home/travis/build/samiBendou/space3/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:3922
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: number
  
  The value to locate in the array.
- Optional fromIndex: number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

inv

inv(): this

- Defined in int/Vector.ts:222
multiplicative inverse of a vector u ** -1

Returns this

invc

invc(): Vector

- Defined in int/Vector.ts:224
Returns Vector

join

join(separator?: string): string

Inherited from Float64Array.join
- Defined in /home/travis/build/samiBendou/space3/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:3929
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Float64Array.keys
- Defined in /home/travis/build/samiBendou/space3/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:476
Returns an list of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: number, fromIndex?: number): number

Inherited from Float64Array.lastIndexOf
- Defined in /home/travis/build/samiBendou/space3/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:3937
Returns the index of the last occurrence of a value in an array.

Parameters
- searchElement: number
  
  The value to locate in the array.
- Optional fromIndex: number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

lerp

lerp(target: Vector, s: number): this

- Defined in int/Vector.ts:183
brief

linear interpolation between two vectors u + (v - u) * s

details

s must be between 0 and 1.

Parameters
- target: Vector
  
  destination of interpolation
- s: number
  
  parameter of the interpolation.
Returns this

lerpc

lerpc(target: Vector, s: number): Vector

- Defined in int/Vector.ts:185
Parameters
- target: Vector
- s: number
Returns Vector

map

map(callbackfn: function, thisArg?: any): Float64Array

Inherited from Float64Array.map
- Defined in /home/travis/build/samiBendou/space3/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:3952
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: number, index: number, array: Float64Array): number
    - Parameters
      - value: number
      - index: number
      - array: Float64Array
      Returns number
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns Float64Array

max

max(vector: Vector): this

- Defined in int/Vector.ts:138
Math.max between the components of the two vectors

Parameters
- vector: Vector
Returns this

maxc

maxc(vector: Vector): Vector

- Defined in int/Vector.ts:140
Parameters
- vector: Vector
Returns Vector

min

min(vector: Vector): this

- Defined in int/Vector.ts:133
Math.min between the components of the two vectors

Parameters
- vector: Vector
Returns this

minc

minc(vector: Vector): Vector

- Defined in int/Vector.ts:135
Parameters
- vector: Vector
Returns Vector

mul

mul(s: number): this

- Defined in int/Vector.ts:163
usual scalar multiplication of the vector s * u

Parameters
- s: number
Returns this

mulc

mulc(s: number): Vector

- Defined in int/Vector.ts:165
Parameters
- s: number
Returns Vector

neg

neg(): this

- Defined in int/Vector.ts:158
usual opposite of the vector -u

Returns this

negc

negc(): Vector

- Defined in int/Vector.ts:160
Returns Vector

nil

nil(): boolean

- Defined in int/Vector.ts:253
true if the vector has only exacts 0 as coordinates

Returns boolean

norm

norm(): this

- Defined in int/Vector.ts:227
normalizes a vector u / ||u||

Returns this

normc

normc(): Vector

- Defined in int/Vector.ts:229
Returns Vector

prod

prod(vector: Vector): this

- Defined in int/Vector.ts:217
product between two vectors u * v

Parameters
- vector: Vector
Returns this

prodc

prodc(vector: Vector): Vector

- Defined in int/Vector.ts:219
Parameters
- vector: Vector
Returns Vector

random

random(): this

- Defined in int/Vector.ts:105
Math.random components by components

Returns this

reduce

reduce(callbackfn: function): number
reduce(callbackfn: function, initialValue: number): number
reduce<U>(callbackfn: function, initialValue: U): U

Inherited from Float64Array.reduce
- Defined in /home/travis/build/samiBendou/space3/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:3964
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: number, currentValue: number, currentIndex: number, array: Float64Array): number
    - Parameters
      - previousValue: number
      - currentValue: number
      - currentIndex: number
      - array: Float64Array
      Returns number
Returns number
Inherited from Float64Array.reduce
- Defined in /home/travis/build/samiBendou/space3/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:3965
Parameters
- callbackfn: function
  - - (previousValue: number, currentValue: number, currentIndex: number, array: Float64Array): number
    - Parameters
      - previousValue: number
      - currentValue: number
      - currentIndex: number
      - array: Float64Array
      Returns number
- initialValue: number
Returns number
Inherited from Float64Array.reduce
- Defined in /home/travis/build/samiBendou/space3/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:3977
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: number, currentIndex: number, array: Float64Array): U
    - Parameters
      - previousValue: U
      - currentValue: number
      - currentIndex: number
      - array: Float64Array
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): number
reduceRight(callbackfn: function, initialValue: number): number
reduceRight<U>(callbackfn: function, initialValue: U): U

Inherited from Float64Array.reduceRight
- Defined in /home/travis/build/samiBendou/space3/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:3989
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: number, currentValue: number, currentIndex: number, array: Float64Array): number
    - Parameters
      - previousValue: number
      - currentValue: number
      - currentIndex: number
      - array: Float64Array
      Returns number
Returns number
Inherited from Float64Array.reduceRight
- Defined in /home/travis/build/samiBendou/space3/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:3990
Parameters
- callbackfn: function
  - - (previousValue: number, currentValue: number, currentIndex: number, array: Float64Array): number
    - Parameters
      - previousValue: number
      - currentValue: number
      - currentIndex: number
      - array: Float64Array
      Returns number
- initialValue: number
Returns number
Inherited from Float64Array.reduceRight
- Defined in /home/travis/build/samiBendou/space3/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:4002
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: number, currentIndex: number, array: Float64Array): U
    - Parameters
      - previousValue: U
      - currentValue: number
      - currentIndex: number
      - array: Float64Array
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reset0

reset0(): this

- Defined in int/Vector.ts:99
reset to an additive neutral element 0

Returns this

reset1

reset1(): this

- Defined in int/Vector.ts:102
reset to a multiplicative neutral element 1

Returns this

reverse

reverse(): Float64Array

Inherited from Float64Array.reverse
- Defined in /home/travis/build/samiBendou/space3/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:4007
Reverses the elements in an Array.

Returns Float64Array

round

round(): this

- Defined in int/Vector.ts:118
Math.round of the components

Returns this

roundc

roundc(): Vector

- Defined in int/Vector.ts:120
Returns Vector

set

set(array: ArrayLike<number>, offset?: number): void

Inherited from Float64Array.set
- Defined in /home/travis/build/samiBendou/space3/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:4014
Sets a value or an array of values.

Parameters
- array: ArrayLike<number>
  
  A typed or untyped array of values to set.
- Optional offset: number
  
  The index in the current array at which the values are to be written.
Returns void

slice

slice(start?: number, end?: number): Float64Array

Inherited from Float64Array.slice
- Defined in /home/travis/build/samiBendou/space3/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:4021
Returns a section of an array.

Parameters
- Optional start: number
  
  The beginning of the specified portion of the array.
- Optional end: number
  
  The end of the specified portion of the array.
Returns Float64Array

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Float64Array.some
- Defined in /home/travis/build/samiBendou/space3/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:4031
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: number, index: number, array: Float64Array): boolean
    - Parameters
      - value: number
      - index: number
      - array: Float64Array
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: function): this

Inherited from Float64Array.sort
- Defined in /home/travis/build/samiBendou/space3/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:4038
Sorts an array.

Parameters
- Optional compareFn: function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
  - - (a: number, b: number): number
    - Parameters
      - a: number
      - b: number
      Returns number
Returns this

string

string(): string

Inherited from Encoder.string
- Defined in int/Encoder.ts:21
string containing a summary of object's content

Returns string

sub

sub(vector: Vector): this

- Defined in int/Vector.ts:153
usual subtraction between two vectors u - v

Parameters
- vector: Vector
Returns this

subarray

subarray(begin: number, end?: number): Float64Array

Inherited from Float64Array.subarray
- Defined in /home/travis/build/samiBendou/space3/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:4046
Gets a new Float64Array view of the ArrayBuffer store for this array, referencing the elements at begin, inclusive, up to end, exclusive.

Parameters
- begin: number
  
  The index of the beginning of the array.
- Optional end: number
  
  The index of the end of the array.
Returns Float64Array

subc

subc(vector: Vector): Vector

- Defined in int/Vector.ts:155
Parameters
- vector: Vector
Returns Vector

toLocaleString

toLocaleString(): string

Inherited from Float64Array.toLocaleString
- Defined in /home/travis/build/samiBendou/space3/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:4051
Converts a number to a string by using the current locale.

Returns string

toString

toString(): string

Inherited from Float64Array.toString
- Defined in /home/travis/build/samiBendou/space3/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:4056
Returns a string representation of an array.

Returns string

trunc

trunc(decimals: number): this

- Defined in int/Vector.ts:123
truncation of the components given a number of decimals to keep

Parameters
- decimals: number
Returns this

truncc

truncc(decimals: number): Vector

- Defined in int/Vector.ts:125
Parameters
- decimals: number
Returns Vector

values

values(): IterableIterator<number>

Inherited from Float64Array.values
- Defined in /home/travis/build/samiBendou/space3/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:480
Returns an list of values in the array

Returns IterableIterator<number>

zero1

zero1(): boolean

- Defined in int/Vector.ts:256
true if the vector has a 0 norm 1

Returns boolean

zero2

zero2(): boolean

- Defined in int/Vector.ts:259
true if the vector has a 0 norm 2

Returns boolean

Brief

Main Features

Example

Getting Started

Algebra and interpolation

Example

Comparison and zeros

Example

Hierarchy

Implemented by

Indexable

Brief

Main Features

Example

Getting Started

Algebra and interpolation

Example

Comparison and zeros

Example

Index

Properties

Methods

Properties

BYTES_PER_ELEMENT

__@toStringTag

buffer

byteLength

byteOffset

dim

length

mag

mag2

Methods

__@iterator

Returns IterableIterator<number>

abs

Returns this

absc

Returns Vector

add

Parameters

vector: Vector

Returns this

addc

Parameters

vector: Vector

Returns Vector

array

Returns number[]

assign

Parameters

Rest ...coordinates: number[]

Returns this

berp

Parameters

target: Vector

vector1: Vector

vector2: Vector

s: number

Returns this

berpc

Parameters

target: Vector

vector1: Vector

vector2: Vector

s: number

Returns Vector

ceil

Returns this

ceilc

Returns Vector

clone

Returns Vector

comb

Parameters

s: number

vector: Vector

Returns this

combc

Parameters