Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Vector6

Brief

Vector3 represents 6D vectors as a set of six numerical components. It implements Vector interface.

Getting started

Vector6 objects are made of an array of three cartesian coordinates in an arbitrary basis [x, y, z, vx, vy, vz]. They can be considered the following column vector :

Vector6 shape

The Vector6 class is a generalization of Vector3 class but it does not provide geometrical features such as rotations.

They can be considered as the concatenation of two parts :

  • The upper one (x, y, z)
  • The lower one (vx, vy, vz)

Note This representation is particularly useful when dealing with second order differential equations.

Example

let u = Vector6(1, 2, 3, 4, 5, 6);
let v = u.upper; // Vector3(1, 2, 3)
u.lower = v; // u = (1, 2, 3, 1, 2, 3)

2019 samiBendou © All Rights Reserved

Hierarchy

  • Float64Array
    • Vector6

Implements

Indexable

[index: number]: number

Brief

Vector3 represents 6D vectors as a set of six numerical components. It implements Vector interface.

Getting started

Vector6 objects are made of an array of three cartesian coordinates in an arbitrary basis [x, y, z, vx, vy, vz]. They can be considered the following column vector :

Vector6 shape

The Vector6 class is a generalization of Vector3 class but it does not provide geometrical features such as rotations.

They can be considered as the concatenation of two parts :

  • The upper one (x, y, z)
  • The lower one (vx, vy, vz)

Note This representation is particularly useful when dealing with second order differential equations.

Example

let u = Vector6(1, 2, 3, 4, 5, 6);
let v = u.upper; // Vector3(1, 2, 3)
u.lower = v; // u = (1, 2, 3, 1, 2, 3)

2019 samiBendou © All Rights Reserved

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new Vector6(x?: number, y?: number, z?: number, vx?: number, vy?: number, vz?: number): Vector6

  • constructs a vector with coordinates

    Parameters

    • Optional x: number
    • Optional y: number
    • Optional z: number
    • Optional vx: number
    • Optional vy: number
    • Optional vz: number

    Returns Vector6

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: Readonly<number> = 6

length

length: number

The length of the array.

Static Float64Array

Float64Array: Float64ArrayConstructor

Accessors

lower

  • get lower(): [number, number, number]
  • set lower(newUpper: [number, number, number]): void

  • lower part of the vector composed by the three last components

    Returns [number, number, number]

  • lower part of the vector composed by the three last components

    Parameters

    • newUpper: [number, number, number]

    Returns void

mag

  • get mag(): number

mag2

  • get mag2(): number

  • squared norm of the vector

    Returns number

upper

  • get upper(): [number, number, number]
  • set upper(newUpper: [number, number, number]): void

  • upper part of the vector composed by the three first components

    Returns [number, number, number]

  • upper part of the vector composed by the three first components

    Parameters

    • newUpper: [number, number, number]

    Returns void

Static ones

Static zeros

Methods

__@iterator

  • __@iterator(): IterableIterator<number>

  • Returns IterableIterator<number>

abs

  • abs(): this

absc

add

addc

array

  • array(): number[]

assign

  • assign(x: number, y: number, z: number, vx: number, vy: number, vz: number): this

  • Parameters

    • x: number
    • y: number
    • z: number
    • vx: number
    • vy: number
    • vz: number

    Returns this

berp

berpc

ceil

  • ceil(): this

ceilc

clone

comb

  • comb(s: number, u: Vector): this

combc

copy

copyWithin

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

  • 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, u: Vector): this

derc

dist

dist1

dist2

div

  • div(s: number): this

divc

dot

entries

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

  • Returns an array of key, value pairs for every entry in the array

    Returns IterableIterator<[number, number]>

equal1

equal2

every

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

  • 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

fill

  • fill(s: number): this

fillc

filter

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

  • 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

  • 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

  • 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

floorc

forEach

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

  • 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

herpc

includes

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

  • 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

  • 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

invc

join

  • join(separator?: string): string

  • 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>

  • Returns an list of keys in the array

    Returns IterableIterator<number>

lastIndexOf

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

  • 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(u: Vector, s: number): this

lerpc

map

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

  • 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

maxc

min

minc

mul

  • mul(s: number): this

mulc

neg

  • neg(): this

negc

nil

  • nil(): boolean

norm

  • norm(): this

normc

prod

prodc

random

  • random(): this

reduce

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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

reset1

  • reset1(): this

reverse

  • reverse(): Float64Array

  • Reverses the elements in an Array.

    Returns Float64Array

round

  • round(): this

roundc

set

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

  • 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

  • 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

  • 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

  • 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

sub

subarray

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

  • 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

toLocaleString

  • toLocaleString(): string

  • Converts a number to a string by using the current locale.

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

trunc

  • trunc(decimals: number): this

truncc

  • truncc(decimals: number): Vector6

values

  • values(): IterableIterator<number>

  • Returns an list of values in the array

    Returns IterableIterator<number>

zero1

  • zero1(): boolean

zero2

  • zero2(): boolean

Static array

  • vector from coordinates of array in the form [x, y, z, vx, vy, vz, ...]

    Parameters

    • arr: number[]

    Returns Vector6

Static e

  • brief

    canonical basis vector

    details

    vector filled with 1 at the k-th index and 0 elsewhere.

    Parameters

    • k: number

      order of the vector in basis

    Returns Vector6

Static en

  • brief

    canonical basis vector

    details

    vector filled with -1 at the k-th index and 0 elsewhere.

    Parameters

    • k: number

      order of the vector in basis

    Returns Vector6

Static random

Static scalar

Generated using TypeDoc