Methods that override must have "override" keyword

schweikl · schweikl · commit 7a9c54a85217 · 2022-07-22T13:47:55.000+02:00
diff --git a/tsconfig.json b/tsconfig.json
@@ -8,6 +8,7 @@
         "noUnusedLocals": false,                /* Report errors on unused locals. */
         "forceConsistentCasingInFileNames": true,
         "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
+        "noImplicitOverride": true,            /* Error to override a method without specifying the `override` keyword */
         "esModuleInterop": true,
         "allowJs": true
     },
diff --git a/whisker-main/src/whisker/integerlist/BiasedVariableLengthConstrainedChromosomeMutation.ts b/whisker-main/src/whisker/integerlist/BiasedVariableLengthConstrainedChromosomeMutation.ts
@@ -28,7 +28,7 @@ export class BiasedVariableLengthConstrainedChromosomeMutation extends VariableL
         super(min, max, length, reservedCodons, gaussianMutationPower);
     }
 
-    protected _getMutationProbability(idx: number, numberOfCodons: number): number {
+    protected override _getMutationProbability(idx: number, numberOfCodons: number): number {
         Preconditions.checkArgument(idx < numberOfCodons);
         return 2 * (idx + 1) / (numberOfCodons * (numberOfCodons + 1));
     }
diff --git a/whisker-main/src/whisker/model/components/Condition.ts b/whisker-main/src/whisker/model/components/Condition.ts
@@ -52,7 +52,7 @@ export class Condition extends Check {
     /**
      * Get a compact representation for this condition for edge tracing.
      */
-    toString() {
+    override toString(): string {
         let result = (this._negated ? "!" : "") + this.name + "(";
 
         if (this.args.length == 1) {
diff --git a/whisker-main/src/whisker/model/components/Effect.ts b/whisker-main/src/whisker/model/components/Effect.ts
@@ -60,7 +60,7 @@ export class Effect extends Check {
     /**
      * Get a readable output for an failed effect trace.
      */
-    toString() {
+    override toString(): string {
         let result = (this.negated ? "!" : "") + this.name + "(";
 
         if (this.args.length == 1) {
diff --git a/whisker-main/src/whisker/model/components/ModelEdge.ts b/whisker-main/src/whisker/model/components/ModelEdge.ts
@@ -201,7 +201,7 @@ export class ProgramModelEdge extends ModelEdge {
         super(id, label, graphID, from, to, forceTestAfter, forceTestAt);
     }
 
-    reset(): void {
+    override reset(): void {
         super.reset();
         this.failedEffects = [];
     }
@@ -217,14 +217,14 @@ export class ProgramModelEdge extends ModelEdge {
     /**
      * Register the check listener and test driver on the conditions and effects.
      */
-    registerComponents(cu: CheckUtility, testDriver: TestDriver, caseSensitive: boolean): void {
+    override registerComponents(cu: CheckUtility, testDriver: TestDriver, caseSensitive: boolean): void {
         super.registerComponents(cu, testDriver, caseSensitive);
         this.effects.forEach(effect => {
             effect.registerComponents(testDriver, cu, caseSensitive, this.graphID);
         });
     }
 
-    simplifyForSave() {
+    override simplifyForSave() {
         let effects = [];
         this.effects.forEach(effect => {
             effects.push(effect.simplifyForSave());
@@ -239,7 +239,7 @@ export class ProgramModelEdge extends ModelEdge {
      * Check the conditions and effects for checks that are depending on the check listeners and the fired events.
      * Effects are checked for Function:true Checks.
      */
-    checkConditionsOnEvent(t: TestDriver, cu: CheckUtility, stepsSinceLastTransition: number, stepsSinceEnd: number,
+    override checkConditionsOnEvent(t: TestDriver, cu: CheckUtility, stepsSinceLastTransition: number, stepsSinceEnd: number,
                            eventStrings: string[]): Condition[] {
         if (this.failedForcedTest) {
             return this.conditions;
@@ -335,14 +335,14 @@ export class UserModelEdge extends ModelEdge {
     /**
      *  Register the check listener and test driver on the conditions and input effects.
      */
-    registerComponents(checkListener: CheckUtility, testDriver: TestDriver, caseSensitive: boolean): void {
+    override registerComponents(checkListener: CheckUtility, testDriver: TestDriver, caseSensitive: boolean): void {
         super.registerComponents(checkListener, testDriver, caseSensitive);
         this.inputEffects.forEach(effect => {
             effect.registerComponents(testDriver, caseSensitive);
         });
     }
 
-    simplifyForSave() {
+    override simplifyForSave() {
         let inputEffects = [];
         this.inputEffects.forEach(effect => {
             inputEffects.push(effect.simplifyForSave());
diff --git a/whisker-main/src/whisker/search/ListChromosome.ts b/whisker-main/src/whisker/search/ListChromosome.ts
@@ -50,7 +50,7 @@ export abstract class ListChromosome<T> extends Chromosome {
         this._genes = genes;
     }
 
-    public toString = () : string => {
+    public override toString = () : string => {
         let result = "";
         for(const gene of this.getGenes()) {
             result += gene + ":";
@@ -64,5 +64,5 @@ export abstract class ListChromosome<T> extends Chromosome {
      * TODO: This is a bit of a hack because of polymorphism. There must be a nicer way?
      * @param newGenes
      */
-    abstract cloneWith(newGenes: T[]);
+    abstract override cloneWith(newGenes: T[]);
 }
diff --git a/whisker-main/src/whisker/search/algorithms/MIO.ts b/whisker-main/src/whisker/search/algorithms/MIO.ts
@@ -43,7 +43,7 @@ export class MIO<C extends Chromosome> extends SearchAlgorithmDefault<C> {
     /**
      * Defines SearchParameters set within the config file.
      */
-    protected _properties: MIOProperties<C>;
+    protected override _properties: MIOProperties<C>;
 
     /**
      * Function determining how good a chromosome performs with respect to a target statement.
@@ -317,7 +317,7 @@ open independent goals: ${this._uncoveredIndependentFitnessFunctions.size}`);
      *
      * @param chromosome The candidate chromosome for the archive.
      */
-    protected updateArchive(chromosome: C): void {
+    protected override updateArchive(chromosome: C): void {
         this.updateCoveredArchive(chromosome);
         this.updateUncoveredArchive(chromosome);
     }
diff --git a/whisker-main/src/whisker/search/algorithms/MOSA.ts b/whisker-main/src/whisker/search/algorithms/MOSA.ts
@@ -41,7 +41,7 @@ export class MOSA<C extends Chromosome> extends SearchAlgorithmDefault<C> {
     /**
      * Defines SearchParameters set within the config file.
      */
-    protected _properties: GeneticAlgorithmProperties<C>;
+    protected override _properties: GeneticAlgorithmProperties<C>;
 
     /**
      * Defines the selection operator used by this MOSA instance.
@@ -411,7 +411,7 @@ export class MOSA<C extends Chromosome> extends SearchAlgorithmDefault<C> {
      *  - createdTestsToReachFullCoverage
      *  - timeToReachFullCoverage
      */
-    protected updateStatistics(): void {
+    protected override updateStatistics(): void {
         StatisticsCollector.getInstance().bestTestSuiteSize = this._bestIndividuals.length;
         if (this._archive.size == this._fitnessFunctions.size && !this._fullCoverageReached) {
             this._fullCoverageReached = true;
diff --git a/whisker-main/src/whisker/search/algorithms/NEAT.ts b/whisker-main/src/whisker/search/algorithms/NEAT.ts
@@ -71,7 +71,7 @@ export class NEAT extends SearchAlgorithmDefault<NeatChromosome> {
      *
      * @param candidateChromosome The candidate chromosome to update the archive with.
      */
-    protected updateArchive(candidateChromosome: NeatChromosome): void {
+    protected override updateArchive(candidateChromosome: NeatChromosome): void {
 
         // We save the first chromosome which managed to cover a block instead of the best performing network since
         // otherwise the dynamic test suite later fails to cover the easiest blocks, e.g simple GameOver state.
diff --git a/whisker-main/src/whisker/search/algorithms/RandomSearch.ts b/whisker-main/src/whisker/search/algorithms/RandomSearch.ts
@@ -91,7 +91,7 @@ export class RandomSearch<C extends Chromosome> extends SearchAlgorithmDefault<C
      *  - createdTestsToReachFullCoverage
      *  - timeToReachFullCoverage
      */
-    protected updateStatistics(): void {
+    protected override updateStatistics(): void {
         StatisticsCollector.getInstance().bestTestSuiteSize = this._bestIndividuals.length;
         StatisticsCollector.getInstance().incrementIterationCount();
         if (this._archive.size == this._fitnessFunctions.size && !this._fullCoverageReached) {
diff --git a/whisker-main/src/whisker/search/algorithms/SimpleGA.ts b/whisker-main/src/whisker/search/algorithms/SimpleGA.ts
@@ -35,7 +35,7 @@ export class SimpleGA<C extends Chromosome> extends SearchAlgorithmDefault<C> {
     /**
      * Defines SearchParameters set within the config file.
      */
-    protected _properties: GeneticAlgorithmProperties<C>;
+    protected override _properties: GeneticAlgorithmProperties<C>;
 
     /**
      * Defines the selection operator used by this SimpleGA instance.
diff --git a/whisker-main/src/whisker/testcase/StaticScratchEventExtractor.ts b/whisker-main/src/whisker/testcase/StaticScratchEventExtractor.ts
@@ -75,7 +75,7 @@ export class StaticScratchEventExtractor extends ScratchEventExtractor {
      * @param block the given block from which events might get extracted.
      * @returns List<ScratchEvent> containing all extracted events.
      */
-    protected _extractEventsFromBlock(target, block: ScratchBlocks): ScratchEvent[] {
+    protected override _extractEventsFromBlock(target, block: ScratchBlocks): ScratchEvent[] {
         const eventList: ScratchEvent[] = [];
         if (typeof block.opcode === 'undefined') {
             return eventList;
diff --git a/whisker-main/src/whisker/testcase/TestChromosome.ts b/whisker-main/src/whisker/testcase/TestChromosome.ts
@@ -61,7 +61,7 @@ export class TestChromosome extends IntegerListChromosome {
      * @param executeCodons if true the saved codons will be exectued instead of the execution code originating from
      * a previous test execution.
      */
-    async evaluate(executeCodons:boolean): Promise<void> {
+    override async evaluate(executeCodons:boolean): Promise<void> {
         const executor = new TestExecutor(Container.vmWrapper, Container.config.getEventExtractor(),
             Container.config.getEventSelector());
         if(executeCodons) {
@@ -73,7 +73,7 @@ export class TestChromosome extends IntegerListChromosome {
         assert(this.trace != null);
     }
 
-    getFitness(fitnessFunction: FitnessFunction<this>): number {
+    override getFitness(fitnessFunction: FitnessFunction<this>): number {
         if (this._fitnessCache.has(fitnessFunction)) {
             return this._fitnessCache.get(fitnessFunction);
         } else {
@@ -115,15 +115,15 @@ export class TestChromosome extends IntegerListChromosome {
         this._lastImprovedTrace = value;
     }
 
-    clone(): TestChromosome {
+    override clone(): TestChromosome {
         const clone = new TestChromosome(this.getGenes(), this.getMutationOperator(), this.getCrossoverOperator());
         clone.trace = this._trace;
         clone.lastImprovedCodon = this.lastImprovedCodon;
         clone.lastImprovedTrace = this.lastImprovedTrace;
         return clone;
     }
 
-    cloneWith(newGenes: number[]): TestChromosome {
+    override cloneWith(newGenes: number[]): TestChromosome {
         return new TestChromosome(newGenes, this.getMutationOperator(), this.getCrossoverOperator());
     }
 
@@ -132,7 +132,7 @@ export class TestChromosome extends IntegerListChromosome {
         return this._trace.events.length;
     }
 
-    public toString = (): string => {
+    public override toString = (): string => {
         assert(this._trace != null);
         let text = "";
         for (const {event} of this._trace.events) {
diff --git a/whisker-main/src/whisker/testcase/VariableLengthTestChromosomeGenerator.ts b/whisker-main/src/whisker/testcase/VariableLengthTestChromosomeGenerator.ts
@@ -45,7 +45,7 @@ export class VariableLengthTestChromosomeGenerator extends TestChromosomeGenerat
      * codon space.
      * @returns number representing the length of the codon sequence that should be generated.
      */
-    protected getLength(): number {
+    protected override getLength(): number {
         const length = Randomness.getInstance().nextInt(this._minInitialLength, this._maxInitialLength);
         return length * this._properties.reservedCodons;
     }
diff --git a/whisker-main/src/whisker/testgenerator/NeuroevolutionTestGenerator.ts b/whisker-main/src/whisker/testgenerator/NeuroevolutionTestGenerator.ts
@@ -32,7 +32,7 @@ export class NeuroevolutionTestGenerator extends TestGenerator {
      * Builds the specified Neuroevolution search algorithm (specified in config file)
      * @param initializeFitnessFunction flag determining if search algorithm fitness functions should be initialised.
      */
-    protected buildSearchAlgorithm(initializeFitnessFunction: boolean): SearchAlgorithm<any> {
+    protected override buildSearchAlgorithm(initializeFitnessFunction: boolean): SearchAlgorithm<any> {
         const builder = new SearchAlgorithmBuilder(this._config.getAlgorithm())
             .addProperties(this._config.neuroevolutionProperties as unknown as SearchAlgorithmProperties<any>);
 
diff --git a/whisker-main/src/whisker/whiskerNet/NetworkComponents/BiasNode.ts b/whisker-main/src/whisker/whiskerNet/NetworkComponents/BiasNode.ts
@@ -43,7 +43,7 @@ export class BiasNode extends NodeGene {
         return 1;
     }
 
-    public reset(): void {
+    public override reset(): void {
         this.nodeValue = 1;
         this.activationValue = 1;
         this.lastActivationValue = 1;
diff --git a/whisker-main/src/whisker/whiskerNet/NetworkFitness/NoveltyTargetNetworkFitness.ts b/whisker-main/src/whisker/whiskerNet/NetworkFitness/NoveltyTargetNetworkFitness.ts
@@ -14,7 +14,7 @@ export class NoveltyTargetNetworkFitness extends NoveltyFitness {
     /**
      * Contains all behaviours seen so far.
      */
-    protected _behaviourArchive: ScratchPosition[] = [];
+    protected override _behaviourArchive: ScratchPosition[] = [];
 
     /**
      * Constructs a new NoveltyTargetNetworkFitness object, whose behaviour is determined by the final position
diff --git a/whisker-main/src/whisker/whiskerNet/NetworkGenerators/NeatChromosomeGeneratorSparse.ts b/whisker-main/src/whisker/whiskerNet/NetworkGenerators/NeatChromosomeGeneratorSparse.ts
@@ -40,7 +40,7 @@ export class NeatChromosomeGeneratorSparse extends NeatChromosomeGeneratorFullyC
      * @param outputNodes all outputNodes of the generated network.
      * @returns ConnectionGene[] the generated network connections.
      */
-    createConnections(inputNodes: NodeGene[][], outputNodes: NodeGene[]):ConnectionGene[] {
+    override createConnections(inputNodes: NodeGene[][], outputNodes: NodeGene[]):ConnectionGene[] {
         const connections: ConnectionGene[] = [];
         // Loop at least once and until we reach the maximum connection size or randomness tells us to Stop!
         do {
diff --git a/whisker-main/src/whisker/whiskerNet/Networks/NeatChromosome.ts b/whisker-main/src/whisker/whiskerNet/Networks/NeatChromosome.ts
@@ -110,7 +110,7 @@ export class NeatChromosome extends NetworkChromosome {
      * Adds additional input Nodes if we have encountered a new Sprite during the playthrough.
      * @param sprites a map which maps each sprite to its input feature vector.
      */
-    protected updateInputNodes(sprites: Map<string, Map<string, number>>): void {
+    protected override updateInputNodes(sprites: Map<string, Map<string, number>>): void {
         let updated = false;
         sprites.forEach((spriteFeatures, spriteKey) => {
 
@@ -162,7 +162,7 @@ export class NeatChromosome extends NetworkChromosome {
      * Connects an input node to the network by creating a connection between the input node and all output nodes.
      * @param iNode the input node to connect.
      */
-    protected connectInputNode(iNode: NodeGene): void {
+    protected override connectInputNode(iNode: NodeGene): void {
         for (const oNode of this.outputNodes) {
             const newConnection = new ConnectionGene(iNode, oNode, this._random.nextDoubleMinMax(-1, 1),
                 true, 0, false);
@@ -176,7 +176,7 @@ export class NeatChromosome extends NetworkChromosome {
      * Connects an output node to the network by creating a connection between the output node and all input nodes.
      * @param oNode the output node to connect.
      */
-    protected connectOutputNode(oNode: NodeGene): void {
+    protected override connectOutputNode(oNode: NodeGene): void {
         for (const iNodes of this.inputNodes.values()) {
             for (const iNode of iNodes.values()) {
                 const newConnection = new ConnectionGene(iNode, oNode, this._random.nextDoubleMinMax(-1, 1),
diff --git a/whisker-main/src/whisker/whiskerNet/Networks/NetworkChromosome.ts b/whisker-main/src/whisker/whiskerNet/Networks/NetworkChromosome.ts
@@ -121,13 +121,13 @@ export abstract class NetworkChromosome extends Chromosome {
      * @param newGenes the ConnectionGenes the network should be initialised with.
      * @returns NetworkChromosome the cloned network.
      */
-    abstract cloneWith(newGenes: ConnectionGene[]);
+    abstract override cloneWith(newGenes: ConnectionGene[]);
 
     /**
      * Deep clone of a network including its structure and attributes.
      * @returns NetworkChromosome the cloned network.
      */
-    abstract clone();
+    abstract override clone();
 
     /**
      * Adds additional input Nodes if we have encountered a new Sprite during the playthrough.
@@ -522,7 +522,7 @@ export abstract class NetworkChromosome extends Chromosome {
         return this._trace.events.length;
     }
 
-    toString(): string {
+    override toString(): string {
         let outputString = 'NodeGenes: \n';
         for (const node of this.allNodes) {
             outputString += node.toString() + '\n';
@@ -552,7 +552,7 @@ export abstract class NetworkChromosome extends Chromosome {
         this._uID = value;
     }
 
-    getFitness(fitnessFunction: FitnessFunction<this>): number {
+    override getFitness(fitnessFunction: FitnessFunction<this>): number {
         if (this._fitnessCache.has(fitnessFunction)) {
             return this._fitnessCache.get(fitnessFunction);
         } else {
diff --git a/whisker-main/src/whisker/whiskerNet/NeuroevolutionPopulations/RandomNeuroevolutionPopulation.ts b/whisker-main/src/whisker/whiskerNet/NeuroevolutionPopulations/RandomNeuroevolutionPopulation.ts
@@ -5,7 +5,7 @@ export class RandomNeuroevolutionPopulation extends NeatPopulation {
     /**
      * In RandomNeuroevolutionPopulation each network is allowed to generate exactly one child.
      */
-    protected assignNumberOfOffspring(): void {
+    protected override assignNumberOfOffspring(): void {
         for (const chromosome of this.networks) {
             chromosome.expectedOffspring = 1;
             chromosome.isParent = true;
diff --git a/whisker-main/src/whisker/whiskerNet/Operators/NeatCrossover.ts b/whisker-main/src/whisker/whiskerNet/Operators/NeatCrossover.ts
@@ -51,7 +51,7 @@ export class NeatCrossover extends NetworkCrossover<NeatChromosome> {
      * Applies the crossover operator.
      * @param parents the parents that should be mated with each other.
      */
-    applyFromPair(parents: Pair<NeatChromosome>): Pair<NeatChromosome> {
+    override applyFromPair(parents: Pair<NeatChromosome>): Pair<NeatChromosome> {
         return this.apply(parents[0], parents[1]);
     }
 
diff --git a/whisker-main/src/whisker/whiskerNet/Operators/NetworkCrossover.ts b/whisker-main/src/whisker/whiskerNet/Operators/NetworkCrossover.ts
@@ -11,5 +11,5 @@ export abstract class NetworkCrossover<C extends NetworkChromosome> extends Cros
      * @param parent2 the second parent
      * @returns the offspring formed by applying crossover to the given parents
      */
-    abstract apply(parent1: C, parent2: C): Pair<C>;
+    abstract override apply(parent1: C, parent2: C): Pair<C>;
 }
diff --git a/whisker-main/test/whisker/search/operators/TournamentSelection.test.ts b/whisker-main/test/whisker/search/operators/TournamentSelection.test.ts
@@ -30,16 +30,16 @@ class InverseOneMaxFitnessFunction extends OneMaxFitnessFunction {
         super(size);
     }
 
-    getFitness(chromosome: BitstringChromosome): number {
+    override getFitness(chromosome: BitstringChromosome): number {
         return this._size - (super.getFitness(chromosome));
     }
 
-    compare (value1: number, value2: number): number {
+    override compare (value1: number, value2: number): number {
         // Smaller fitness values are better
         return value2 - value1;
     }
 
-    isOptimal(fitnessValue: number): boolean {
+    override isOptimal(fitnessValue: number): boolean {
         return fitnessValue == 0;
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ export class BiasedVariableLengthConstrainedChromosomeMutation extends VariableL`
`28`	`28`	`super(min, max, length, reservedCodons, gaussianMutationPower);`
`29`	`29`	`}`
`30`	`30`
`31`		`- protected _getMutationProbability(idx: number, numberOfCodons: number): number {`
	`31`	`+ protected override _getMutationProbability(idx: number, numberOfCodons: number): number {`
`32`	`32`	`Preconditions.checkArgument(idx < numberOfCodons);`
`33`	`33`	`return 2 * (idx + 1) / (numberOfCodons * (numberOfCodons + 1));`
`34`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,7 @@ export abstract class ListChromosome<T> extends Chromosome {`
`50`	`50`	`this._genes = genes;`
`51`	`51`	`}`
`52`	`52`
`53`		`- public toString = () : string => {`
	`53`	`+ public override toString = () : string => {`
`54`	`54`	`let result = "";`
`55`	`55`	`for(const gene of this.getGenes()) {`
`56`	`56`	`result += gene + ":";`
`@@ -64,5 +64,5 @@ export abstract class ListChromosome<T> extends Chromosome {`
`64`	`64`	`* TODO: This is a bit of a hack because of polymorphism. There must be a nicer way?`
`65`	`65`	`* @param newGenes`
`66`	`66`	`*/`
`67`		`- abstract cloneWith(newGenes: T[]);`
	`67`	`+ abstract override cloneWith(newGenes: T[]);`
`68`	`68`	`}`
Original file line number	Diff line number	Diff line change
`@@ -71,7 +71,7 @@ export class NEAT extends SearchAlgorithmDefault<NeatChromosome> {`
`71`	`71`	`*`
`72`	`72`	`* @param candidateChromosome The candidate chromosome to update the archive with.`
`73`	`73`	`*/`
`74`		`- protected updateArchive(candidateChromosome: NeatChromosome): void {`
	`74`	`+ protected override updateArchive(candidateChromosome: NeatChromosome): void {`
`75`	`75`
`76`	`76`	`// We save the first chromosome which managed to cover a block instead of the best performing network since`
`77`	`77`	`// otherwise the dynamic test suite later fails to cover the easiest blocks, e.g simple GameOver state.`