Class VectorSubtraction

A procedure for vector subtraction. Subtracts negative vectors from positive vectors per component.

Hierarchy

Procedures.Procedure<{
    negative: Interfaces.BareReadonlyVector[];
    positive: Interfaces.BareReadonlyVector[];
}, {
    differenceVector: Interfaces.BareVector;
}>
- VectorSubtraction

Index

Constructors

Accessors

Methods

evaluate perform

Constructors

constructor

new VectorSubtraction(): VectorSubtraction
Returns VectorSubtraction
Overrides Procedure.constructor
- Defined in src/procedures/foundational/vectorOperations.ts:30

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): {
differenceVector: Interfaces.BareVector;
}
Performs the evaluation. Should be a pure function.
Parameters
- input: {
  negative: Interfaces.BareReadonlyVector[];
  positive: Interfaces.BareReadonlyVector[];
  }
  
  The input data.
  - negative: Interfaces.BareReadonlyVector[]
  - positive: Interfaces.BareReadonlyVector[]
Returns {
differenceVector: Interfaces.BareVector;
}
The output data.
- differenceVector: Interfaces.BareVector
Inherited from Procedure.evaluate
- Defined in src/procedures/procedure.ts:34

perform

perform(input): {
differenceVector: Interfaces.BareVector;
}
Performs the procedure.
Parameters
- input: {
  negative: Interfaces.BareReadonlyVector[];
  positive: Interfaces.BareReadonlyVector[];
  }
  - negative: Interfaces.BareReadonlyVector[]
  - positive: Interfaces.BareReadonlyVector[]
Returns {
differenceVector: Interfaces.BareVector;
}
- differenceVector: Interfaces.BareVector
Inherited from Procedure.perform
- Defined in src/procedures/procedure.ts:28

Generated using TypeDoc