Class PerpendicularVector

Creates a vector perpendicular to the given vector.

See

Perpendicular Vector Procedure Documentation

Hierarchy

Procedures.Procedure<{
    direction: "positive" | "negative";
    vector: Interfaces.BareReadonlyVector;
}, {
    perpendicularVector: Interfaces.BareVector;
}>
- PerpendicularVector

Index

Constructors

Accessors

Methods

evaluate perform

Constructors

constructor

new PerpendicularVector(): PerpendicularVector
Returns PerpendicularVector
Overrides Procedure.constructor
- Defined in src/procedures/derived/perpendicularVector.ts:9

Accessors

name

get name(): string
Name of the procedure.

Returns string
Inherited from Procedure.name
- Defined in src/procedures/procedure.ts:21

Methods

evaluate

evaluate(input): {
perpendicularVector: Interfaces.BareVector;
}
Performs the evaluation. Should be a pure function.
Parameters
- input: {
  direction: "positive" | "negative";
  vector: Interfaces.BareReadonlyVector;
  }
  
  The input data.
  - direction: "positive" | "negative"
  - vector: Interfaces.BareReadonlyVector
Returns {
perpendicularVector: Interfaces.BareVector;
}
The output data.
- perpendicularVector: Interfaces.BareVector
Inherited from Procedure.evaluate
- Defined in src/procedures/procedure.ts:34

perform

perform(input): {
perpendicularVector: Interfaces.BareVector;
}
Performs the procedure.
Parameters
- input: {
  direction: "positive" | "negative";
  vector: Interfaces.BareReadonlyVector;
  }
  - direction: "positive" | "negative"
  - vector: Interfaces.BareReadonlyVector
Returns {
perpendicularVector: Interfaces.BareVector;
}
- perpendicularVector: Interfaces.BareVector
Inherited from Procedure.perform
- Defined in src/procedures/procedure.ts:28

Generated using TypeDoc