Class VectorDotProduct

A procedure for vector dot product. Calculates the dot product of two vectors.

Hierarchy

Procedures.Procedure<{
    vector1: Interfaces.BareReadonlyVector;
    vector2: Interfaces.BareReadonlyVector;
}, {
    product: number;
}>
- VectorDotProduct

Index

Constructors

Accessors

Methods

evaluate perform

Constructors

constructor

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

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

perform

perform(input): {
product: number;
}
Performs the procedure.
Parameters
- input: {
  vector1: Interfaces.BareReadonlyVector;
  vector2: Interfaces.BareReadonlyVector;
  }
  - vector1: Interfaces.BareReadonlyVector
  - vector2: Interfaces.BareReadonlyVector
Returns {
product: number;
}
- product: number
Inherited from Procedure.perform
- Defined in src/procedures/procedure.ts:28

Generated using TypeDoc