Interface MutableGeometricElement<I, M, S, V, MAGNITUDE, SCALING, UNIT>

This interface is provided to ensure consistency. It is not part of the documented API.

Type parameters

I
M
S
V
MAGNITUDE
SCALING
UNIT

Hierarchy

GeometricNumber<I, M, S, V, MAGNITUDE, SCALING, UNIT>
MutableLinearElement<I, M, S, V, MAGNITUDE, SCALING>
MutableRingElement<M>
- MutableGeometricElement

Index

Methods

Methods

add

add(rhs: I, α?: number): M

Inherited from LinearNumber.add

Overrides LinearNumber.add
- Defined in src/davinci-units/math/LinearNumber.ts:15
Parameters
- rhs: I
- Optional α: number
Returns M

addScalar

addScalar(α: UNIT): M

Inherited from GeometricNumber.addScalar
- Defined in src/davinci-units/math/GeometricNumber.ts:18
Addition of a scalar.

Parameters
- α: UNIT
Returns M

adj

adj(): M

Inherited from GeometricNumber.adj
- Defined in src/davinci-units/math/GeometricNumber.ts:23
conjugate multiplied by norm (similar to inv)

Returns M

angle

angle(): M

Inherited from GeometricNumber.angle
- Defined in src/davinci-units/math/GeometricNumber.ts:30
Assumes a spinor as the multivector. angle(M) = log(M).grade(2) In other words, throw away the scalar part of the result which is the scaling.

Returns M

approx

approx(n: number): M

Inherited from MutableLinearElement.approx
- Defined in src/davinci-units/math/MutableLinearElement.ts:12
Discards coordinates which are significantly smaller than the maximum coordinate.

Parameters
- n: number
Returns M

clone

clone(): M

Inherited from MutableLinearElement.clone
- Defined in src/davinci-units/math/MutableLinearElement.ts:17
Computes a copy of this element.

Returns M

conj

conj(): M

Inherited from GeometricNumber.conj
- Defined in src/davinci-units/math/GeometricNumber.ts:35
Conjugate

Returns M

copy

copy(source: I): M

Inherited from MutableLinearElement.copy
- Defined in src/davinci-units/math/MutableLinearElement.ts:22
Copies the source coordinates onto this element.

Parameters
- source: I
Returns M

copyScalar

copyScalar(α: number): M

- Defined in src/davinci-units/math/MutableGeometricElement.ts:24
Sets this multivector to the value of the scalar, α.

Parameters
- α: number
Returns M

copySpinor

copySpinor(spinor: S): M

- Defined in src/davinci-units/math/MutableGeometricElement.ts:29
Sets this multivector to the value of the spinor.

Parameters
- spinor: S
Returns M

copyVector

copyVector(vector: V): M

- Defined in src/davinci-units/math/MutableGeometricElement.ts:34
Sets this multivector to the value of the vector.

Parameters
- vector: V
Returns M

div

div(rhs: I): M

Inherited from GeometricNumber.div
- Defined in src/davinci-units/math/GeometricNumber.ts:45
divide really only applies to division algebras, may not be defined.

Parameters
- rhs: I
Returns M

div2

div2(a: I, b: I): M

- Defined in src/davinci-units/math/MutableGeometricElement.ts:44
Sets this multivector to a / b. This may not be defined.

Parameters
- a: I
- b: I
Returns M

divByScalar

divByScalar(α: SCALING): M

Inherited from LinearNumber.divByScalar

Overrides LinearNumber.divByScalar
- Defined in src/davinci-units/math/LinearNumber.ts:16
Parameters
- α: SCALING
Returns M

exp

exp(): M

Inherited from GeometricNumber.exp
- Defined in src/davinci-units/math/GeometricNumber.ts:50
Exponential

Returns M

ext

ext(rhs: I): M

Inherited from GeometricNumber.ext
- Defined in src/davinci-units/math/GeometricNumber.ts:55
Exterior or Outer Product.

Parameters
- rhs: I
Returns M

ext2

ext2(a: I, b: I): M

- Defined in src/davinci-units/math/MutableGeometricElement.ts:74
Sets this multivector to the exterior product of the multivectors.

Parameters
- a: I
- b: I
Returns M

grade

grade(grade: number): M

Inherited from GeometricNumber.grade
- Defined in src/davinci-units/math/GeometricNumber.ts:60
extraction of grade.

Parameters
- grade: number
Returns M

inv

inv(): M

Inherited from GeometricNumber.inv
- Defined in src/davinci-units/math/GeometricNumber.ts:65
Inverse (may not exist).

Returns M

isOne

isOne(): boolean

Inherited from GeometricNumber.isOne
- Defined in src/davinci-units/math/GeometricNumber.ts:70
Returns boolean

isScalar

isScalar(): boolean

Inherited from GeometricNumber.isScalar
- Defined in src/davinci-units/math/GeometricNumber.ts:75
Returns boolean

isZero

isZero(): boolean

Inherited from GeometricNumber.isZero
- Defined in src/davinci-units/math/GeometricNumber.ts:80
Returns boolean

lco

lco(rhs: I): M

Inherited from GeometricNumber.lco
- Defined in src/davinci-units/math/GeometricNumber.ts:40
Left contraction

Parameters
- rhs: I
Returns M

lco2

lco2(a: I, b: I): M

- Defined in src/davinci-units/math/MutableGeometricElement.ts:14
Sets this multivector to the left contraction of the multivectors.

Parameters
- a: I
- b: I
Returns M

lerp

lerp(target: I, α: number): M

Inherited from LinearNumber.lerp

Overrides LinearNumber.lerp
- Defined in src/davinci-units/math/LinearNumber.ts:17
Parameters
- target: I
- α: number
Returns M

log

log(): M

Inherited from GeometricNumber.log
- Defined in src/davinci-units/math/GeometricNumber.ts:85
Natural logarithm.

Returns M

magnitude

magnitude(): MAGNITUDE

Inherited from GeometricNumber.magnitude
- Defined in src/davinci-units/math/GeometricNumber.ts:90
Computes the square root of the squared norm.

Returns MAGNITUDE

mul

mul(rhs: I): M

Inherited from GeometricNumber.mul
- Defined in src/davinci-units/math/GeometricNumber.ts:95
Multiplication.

Parameters
- rhs: I
Returns M

mul2

mul2(a: I, b: I): M

- Defined in src/davinci-units/math/MutableGeometricElement.ts:49
Sets this multivector to the geometric product of the multivectors.

Parameters
- a: I
- b: I
Returns M

neg

neg(): M

Inherited from LinearNumber.neg

Overrides LinearNumber.neg
- Defined in src/davinci-units/math/LinearNumber.ts:19
Returns M

norm

norm(): M

Inherited from GeometricNumber.norm
- Defined in src/davinci-units/math/GeometricNumber.ts:100
norm, ||x|| = sqrt(scp(x, rev(x)))

Returns M

normalize

normalize(): M

- Defined in src/davinci-units/math/MutableGeometricElement.ts:39
Sets this multivector to this / norm(this)

Returns M

one

one(): M

Inherited from MutableRingElement.one
- Defined in src/davinci-units/math/MutableRingElement.ts:2
Returns M

quad

quad(): M

Inherited from GeometricNumber.quad
- Defined in src/davinci-units/math/GeometricNumber.ts:105
squared norm, scp(x, rev(x))

Returns M

rco

rco(rhs: I): M

Inherited from GeometricNumber.rco
- Defined in src/davinci-units/math/GeometricNumber.ts:110
Right contraction

Parameters
- rhs: I
Returns M

rco2

rco2(a: I, b: I): M

- Defined in src/davinci-units/math/MutableGeometricElement.ts:19
Sets this multivector to the right contraction of the multivectors.

Parameters
- a: I
- b: I
Returns M

reflect

reflect(n: V): M

Inherited from LinearNumber.reflect

Overrides LinearNumber.reflect
- Defined in src/davinci-units/math/LinearNumber.ts:20
Parameters
- n: V
Returns M

rev

rev(): M

Inherited from GeometricNumber.rev
- Defined in src/davinci-units/math/GeometricNumber.ts:115
Reverse

Returns M

rotate

rotate(rotor: S): M

Inherited from LinearNumber.rotate

Overrides LinearNumber.rotate
- Defined in src/davinci-units/math/LinearNumber.ts:21
Parameters
- rotor: S
Returns M

rotorFromDirections

rotorFromDirections(a: V, b: V): M

- Defined in src/davinci-units/math/MutableGeometricElement.ts:54
Sets this multivector to a unitary spinor (a rotor), even if the vectors are not unitary.

Parameters
- a: V
- b: V
Returns M

rotorFromGeneratorAngle

rotorFromGeneratorAngle(B: S, θ: number): M

- Defined in src/davinci-units/math/MutableGeometricElement.ts:59
Sets this multivector to a unitary spinor (a rotor).

Parameters
- B: S
- θ: number
Returns M

scale

scale(α: SCALING): M

Inherited from LinearNumber.scale

Overrides LinearNumber.scale
- Defined in src/davinci-units/math/LinearNumber.ts:18
Parameters
- α: SCALING
Returns M

scp

scp(rhs: I): M

Inherited from GeometricNumber.scp
- Defined in src/davinci-units/math/GeometricNumber.ts:125
Scalar Product

Parameters
- rhs: I
Returns M

scp2

scp2(a: I, b: I): M

- Defined in src/davinci-units/math/MutableGeometricElement.ts:64
Sets this multivector to the scalar product of the multivectors.

Parameters
- a: I
- b: I
Returns M

slerp

slerp(target: I, α: number): M

Inherited from LinearNumber.slerp

Overrides LinearNumber.slerp
- Defined in src/davinci-units/math/LinearNumber.ts:22
Parameters
- target: I
- α: number
Returns M

squaredNorm

squaredNorm(): MAGNITUDE

Inherited from GeometricNumber.squaredNorm
- Defined in src/davinci-units/math/GeometricNumber.ts:120
squared norm, scp(x, rev(x))

Returns MAGNITUDE

stress

stress(σ: V): M

Inherited from LinearNumber.stress

Overrides LinearNumber.stress
- Defined in src/davinci-units/math/LinearNumber.ts:23
Parameters
- σ: V
Returns M

sub

sub(rhs: I, α?: number): M

Inherited from LinearNumber.sub

Overrides LinearNumber.sub
- Defined in src/davinci-units/math/LinearNumber.ts:24
Parameters
- rhs: I
- Optional α: number
Returns M

toExponential

toExponential(fractionDigits?: number): string

Inherited from LinearNumber.toExponential

Overrides LinearNumber.toExponential
- Defined in src/davinci-units/math/LinearNumber.ts:25
Parameters
- Optional fractionDigits: number
Returns string

toFixed

toFixed(fractionDigits?: number): string

Inherited from LinearNumber.toFixed

Overrides LinearNumber.toFixed
- Defined in src/davinci-units/math/LinearNumber.ts:26
Parameters
- Optional fractionDigits: number
Returns string

toPrecision

toPrecision(precision?: number): string

Inherited from LinearNumber.toPrecision

Overrides LinearNumber.toPrecision
- Defined in src/davinci-units/math/LinearNumber.ts:27
Parameters
- Optional precision: number
Returns string

toString

toString(radix?: number): string

Inherited from LinearNumber.toString

Overrides LinearNumber.toString
- Defined in src/davinci-units/math/LinearNumber.ts:28
Parameters
- Optional radix: number
Returns string

versor

versor(a: V, b: V): M

- Defined in src/davinci-units/math/MutableGeometricElement.ts:69
Sets this multivector to the geometric product of the vectors.

Parameters
- a: V
- b: V
Returns M

zero

zero(): M

Inherited from MutableLinearElement.zero

Overrides MutableRingElement.zero
- Defined in src/davinci-units/math/MutableLinearElement.ts:27
Sets this element to the identity element for addition, 0.

Returns M