Class VectorNormalization

A procedure for vector normalization. Normalizes a vector to a given length.

Hierarchy

Procedures.Procedure<{
    length: number;
    vector: Interfaces.BareReadonlyVector;
}, {
    resultVector: Interfaces.BareVector;
}>
- VectorNormalization

Index

Constructors

Accessors

Methods

evaluate perform

Constructors

constructor

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

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

perform

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

Generated using TypeDoc