nlptoolkit-classification 1.0.0

package/dist/Performance/ClassificationPerformance.js

@@ -0,0 +1,36 @@
+(function (factory) {
+    if (typeof module === "object" && typeof module.exports === "object") {
+        var v = factory(require, exports);
+        if (v !== undefined) module.exports = v;
+    }
+    else if (typeof define === "function" && define.amd) {
+        define(["require", "exports", "./Performance"], factory);
+    }
+})(function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.ClassificationPerformance = void 0;
+    const Performance_1 = require("./Performance");
+    class ClassificationPerformance extends Performance_1.Performance {
+        /**
+         * A constructor that sets the accuracy and errorRate via given input.
+         *
+         * @param accuracy  Double value input.
+         * @param errorRate Double value input.
+         */
+        constructor(accuracy, errorRate) {
+            super(errorRate == undefined ? 1 - accuracy : errorRate);
+            this.accuracy = accuracy;
+        }
+        /**
+         * Accessor for the accuracy.
+         *
+         * @return Accuracy value.
+         */
+        getAccuracy() {
+            return this.accuracy;
+        }
+    }
+    exports.ClassificationPerformance = ClassificationPerformance;
+});
+//# sourceMappingURL=ClassificationPerformance.js.map

package/dist/Performance/ClassificationPerformance.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ClassificationPerformance.js","sourceRoot":"","sources":["../../source/Performance/ClassificationPerformance.ts"],"names":[],"mappings":";;;;;;;;;;;;IAAA,+CAA0C;IAE1C,MAAa,yBAA0B,SAAQ,yBAAW;QAItD;;;;;WAKG;QACH,YAAY,QAAgB,EAAE,SAAkB;YAC5C,KAAK,CAAC,SAAS,IAAI,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;YACzD,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;QAC5B,CAAC;QAED;;;;WAIG;QACH,WAAW;YACP,OAAO,IAAI,CAAC,QAAQ,CAAA;QACxB,CAAC;KACJ;IAvBD,8DAuBC"}

package/dist/Performance/ConfusionMatrix.d.ts

@@ -0,0 +1,81 @@
+export declare class ConfusionMatrix {
+    private matrix;
+    private classLabels;
+    /**
+     * Constructor that sets the class labels {@link Array} and creates new {@link Map} matrix
+     *
+     * @param classLabels {@link ArrayList} of String.
+     */
+    constructor(classLabels: Array<string>);
+    /**
+     * The classify method takes two Strings; actual class and predicted class as inputs. If the matrix {@link Map} contains
+     * given actual class String as a key, it then assigns the corresponding object of that key to a {@link CounterHashMap}, if not
+     * it creates a new {@link CounterHashMap}. Then, it puts the given predicted class String to the counterHashMap and
+     * also put this counterHashMap to the matrix {@link Map} together with the given actual class String.
+     *
+     * @param actualClass    String input actual class.
+     * @param predictedClass String input predicted class.
+     */
+    classify(actualClass: string, predictedClass: string): void;
+    /**
+     * The addConfusionMatrix method takes a {@link ConfusionMatrix} as an input and loops through actual classes of that {@link Map}
+     * and initially gets one row at a time. Then it puts the current row to the matrix {@link Map} together with the actual class string.
+     *
+     * @param confusionMatrix {@link ConfusionMatrix} input.
+     */
+    addConfusionMatrix(confusionMatrix: ConfusionMatrix): void;
+    /**
+     * The sumOfElements method loops through the keys in matrix {@link Map} and returns the summation of all the values of the keys.
+     * I.e: TP+TN+FP+FN.
+     *
+     * @return The summation of values.
+     */
+    private sumOfElements;
+    /**
+     * The trace method loops through the keys in matrix {@link Map} and if the current key contains the actual key,
+     * it accumulates the corresponding values. I.e: TP+TN.
+     *
+     * @return Summation of values.
+     */
+    private trace;
+    /**
+     * The columnSum method takes a String predicted class as input, and loops through the keys in matrix {@link HashMap}.
+     * If the current key contains the predicted class String, it accumulates the corresponding values. I.e: TP+FP.
+     *
+     * @param predictedClass String input predicted class.
+     * @return Summation of values.
+     */
+    private columnSum;
+    /**
+     * The getAccuracy method returns the result of  TP+TN / TP+TN+FP+FN
+     *
+     * @return the result of  TP+TN / TP+TN+FP+FN
+     */
+    getAccuracy(): number;
+    /**
+     * The precision method loops through the class labels and returns the resulting Array which has the result of TP/FP+TP.
+     *
+     * @return The result of TP/FP+TP.
+     */
+    precision(): Array<number>;
+    /**
+     * The recall method loops through the class labels and returns the resulting Array which has the result of TP/FN+TP.
+     *
+     * @return The result of TP/FN+TP.
+     */
+    recall(): Array<number>;
+    /**
+     * The fMeasure method loops through the class labels and returns the resulting Array which has the average of
+     * recall and precision.
+     *
+     * @return The average of recall and precision.
+     */
+    fMeasure(): Array<number>;
+    /**
+     * The weightedFMeasure method loops through the class labels and returns the resulting Array which has the weighted average of
+     * recall and precision.
+     *
+     * @return The weighted average of recall and precision.
+     */
+    weightedFMeasure(): number;
+}

package/dist/Performance/ConfusionMatrix.js

@@ -0,0 +1,178 @@
+(function (factory) {
+    if (typeof module === "object" && typeof module.exports === "object") {
+        var v = factory(require, exports);
+        if (v !== undefined) module.exports = v;
+    }
+    else if (typeof define === "function" && define.amd) {
+        define(["require", "exports", "nlptoolkit-datastructure/dist/CounterHashMap"], factory);
+    }
+})(function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.ConfusionMatrix = void 0;
+    const CounterHashMap_1 = require("nlptoolkit-datastructure/dist/CounterHashMap");
+    class ConfusionMatrix {
+        /**
+         * Constructor that sets the class labels {@link Array} and creates new {@link Map} matrix
+         *
+         * @param classLabels {@link ArrayList} of String.
+         */
+        constructor(classLabels) {
+            this.matrix = new Map();
+            this.classLabels = classLabels;
+        }
+        /**
+         * The classify method takes two Strings; actual class and predicted class as inputs. If the matrix {@link Map} contains
+         * given actual class String as a key, it then assigns the corresponding object of that key to a {@link CounterHashMap}, if not
+         * it creates a new {@link CounterHashMap}. Then, it puts the given predicted class String to the counterHashMap and
+         * also put this counterHashMap to the matrix {@link Map} together with the given actual class String.
+         *
+         * @param actualClass    String input actual class.
+         * @param predictedClass String input predicted class.
+         */
+        classify(actualClass, predictedClass) {
+            let counterHashMap;
+            if (this.matrix.has(actualClass)) {
+                counterHashMap = this.matrix.get(actualClass);
+            }
+            else {
+                counterHashMap = new CounterHashMap_1.CounterHashMap();
+            }
+            counterHashMap.put(predictedClass);
+            this.matrix.set(actualClass, counterHashMap);
+        }
+        /**
+         * The addConfusionMatrix method takes a {@link ConfusionMatrix} as an input and loops through actual classes of that {@link Map}
+         * and initially gets one row at a time. Then it puts the current row to the matrix {@link Map} together with the actual class string.
+         *
+         * @param confusionMatrix {@link ConfusionMatrix} input.
+         */
+        addConfusionMatrix(confusionMatrix) {
+            for (let actualClass of confusionMatrix.matrix.keys()) {
+                let rowToBeAdded = confusionMatrix.matrix.get(actualClass);
+                if (this.matrix.has(actualClass)) {
+                    let currentRow = this.matrix.get(actualClass);
+                    currentRow.add(rowToBeAdded);
+                    this.matrix.set(actualClass, currentRow);
+                }
+                else {
+                    this.matrix.set(actualClass, rowToBeAdded);
+                }
+            }
+        }
+        /**
+         * The sumOfElements method loops through the keys in matrix {@link Map} and returns the summation of all the values of the keys.
+         * I.e: TP+TN+FP+FN.
+         *
+         * @return The summation of values.
+         */
+        sumOfElements() {
+            let result = 0;
+            for (let actualClass of this.matrix.keys()) {
+                result += this.matrix.get(actualClass).sumOfCounts();
+            }
+            return result;
+        }
+        /**
+         * The trace method loops through the keys in matrix {@link Map} and if the current key contains the actual key,
+         * it accumulates the corresponding values. I.e: TP+TN.
+         *
+         * @return Summation of values.
+         */
+        trace() {
+            let result = 0;
+            for (let actualClass of this.matrix.keys()) {
+                if (this.matrix.get(actualClass).has(actualClass)) {
+                    result += this.matrix.get(actualClass).get(actualClass);
+                }
+            }
+            return result;
+        }
+        /**
+         * The columnSum method takes a String predicted class as input, and loops through the keys in matrix {@link HashMap}.
+         * If the current key contains the predicted class String, it accumulates the corresponding values. I.e: TP+FP.
+         *
+         * @param predictedClass String input predicted class.
+         * @return Summation of values.
+         */
+        columnSum(predictedClass) {
+            let result = 0;
+            for (let actualClass of this.matrix.keys()) {
+                if (this.matrix.get(actualClass).has(predictedClass)) {
+                    result += this.matrix.get(actualClass).get(predictedClass);
+                }
+            }
+            return result;
+        }
+        /**
+         * The getAccuracy method returns the result of  TP+TN / TP+TN+FP+FN
+         *
+         * @return the result of  TP+TN / TP+TN+FP+FN
+         */
+        getAccuracy() {
+            return this.trace() / this.sumOfElements();
+        }
+        /**
+         * The precision method loops through the class labels and returns the resulting Array which has the result of TP/FP+TP.
+         *
+         * @return The result of TP/FP+TP.
+         */
+        precision() {
+            let result = new Array(this.classLabels.length).fill(0);
+            for (let i = 0; i < this.classLabels.length; i++) {
+                let actualClass = this.classLabels[i];
+                if (this.matrix.has(actualClass)) {
+                    result[i] = this.matrix.get(actualClass).get(actualClass) / this.columnSum(actualClass);
+                }
+            }
+            return result;
+        }
+        /**
+         * The recall method loops through the class labels and returns the resulting Array which has the result of TP/FN+TP.
+         *
+         * @return The result of TP/FN+TP.
+         */
+        recall() {
+            let result = new Array(this.classLabels.length).fill(0);
+            for (let i = 0; i < this.classLabels.length; i++) {
+                let actualClass = this.classLabels[i];
+                if (this.matrix.has(actualClass)) {
+                    result[i] = this.matrix.get(actualClass).get(actualClass) / this.matrix.get(actualClass).sumOfCounts();
+                }
+            }
+            return result;
+        }
+        /**
+         * The fMeasure method loops through the class labels and returns the resulting Array which has the average of
+         * recall and precision.
+         *
+         * @return The average of recall and precision.
+         */
+        fMeasure() {
+            let precision = this.precision();
+            let recall = this.recall();
+            let result = new Array(this.classLabels.length).fill(0);
+            for (let i = 0; i < this.classLabels.length; i++) {
+                result[i] = 2 / (1 / precision[i] + 1 / recall[i]);
+            }
+            return result;
+        }
+        /**
+         * The weightedFMeasure method loops through the class labels and returns the resulting Array which has the weighted average of
+         * recall and precision.
+         *
+         * @return The weighted average of recall and precision.
+         */
+        weightedFMeasure() {
+            let fMeasure = this.fMeasure();
+            let sum = 0;
+            for (let i = 0; i < this.classLabels.length; i++) {
+                let actualClass = this.classLabels[i];
+                sum += fMeasure[i] * this.matrix.get(actualClass).sumOfCounts();
+            }
+            return sum / this.sumOfElements();
+        }
+    }
+    exports.ConfusionMatrix = ConfusionMatrix;
+});
+//# sourceMappingURL=ConfusionMatrix.js.map

package/dist/Performance/ConfusionMatrix.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConfusionMatrix.js","sourceRoot":"","sources":["../../source/Performance/ConfusionMatrix.ts"],"names":[],"mappings":";;;;;;;;;;;;IAAA,iFAA4E;IAE5E,MAAa,eAAe;QAKxB;;;;WAIG;QACH,YAAY,WAA0B;YAR9B,WAAM,GAAwC,IAAI,GAAG,EAAkC,CAAA;YAS3F,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;QAClC,CAAC;QAED;;;;;;;;WAQG;QACH,QAAQ,CAAC,WAAmB,EAAE,cAAsB;YAChD,IAAI,cAAsC,CAAA;YAC1C,IAAI,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,EAAC;gBAC7B,cAAc,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAA;aAChD;iBAAM;gBACH,cAAc,GAAG,IAAI,+BAAc,EAAU,CAAA;aAChD;YACD,cAAc,CAAC,GAAG,CAAC,cAAc,CAAC,CAAA;YAClC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,WAAW,EAAE,cAAc,CAAC,CAAA;QAChD,CAAC;QAED;;;;;WAKG;QACH,kBAAkB,CAAC,eAAgC;YAC/C,KAAK,IAAI,WAAW,IAAI,eAAe,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE;gBACnD,IAAI,YAAY,GAAG,eAAe,CAAC,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;gBAC3D,IAAI,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE;oBAC9B,IAAI,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;oBAC9C,UAAU,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;oBAC7B,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;iBAC5C;qBAAM;oBACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;iBAC9C;aACJ;QACL,CAAC;QAED;;;;;WAKG;QACK,aAAa;YACjB,IAAI,MAAM,GAAG,CAAC,CAAC;YACf,KAAK,IAAI,WAAW,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE;gBACxC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,WAAW,EAAE,CAAC;aACxD;YACD,OAAO,MAAM,CAAC;QAClB,CAAC;QAED;;;;;WAKG;QACK,KAAK;YACT,IAAI,MAAM,GAAG,CAAC,CAAC;YACf,KAAK,IAAI,WAAW,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE;gBACxC,IAAI,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE;oBAC/C,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;iBAC3D;aACJ;YACD,OAAO,MAAM,CAAC;QAClB,CAAC;QAED;;;;;;WAMG;QACK,SAAS,CAAC,cAAsB;YACpC,IAAI,MAAM,GAAG,CAAC,CAAC;YACf,KAAK,IAAI,WAAW,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE;gBACxC,IAAI,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,EAAE;oBAClD,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;iBAC9D;aACJ;YACD,OAAO,MAAM,CAAC;QAClB,CAAC;QAED;;;;WAIG;QACH,WAAW;YACP,OAAO,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,aAAa,EAAE,CAAA;QAC9C,CAAC;QAED;;;;WAIG;QACH,SAAS;YACL,IAAI,MAAM,GAAG,IAAI,KAAK,CAAS,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;YAC/D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;gBAC9C,IAAI,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;gBACtC,IAAI,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE;oBAC9B,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;iBAC3F;aACJ;YACD,OAAO,MAAM,CAAC;QAClB,CAAC;QAED;;;;WAIG;QACH,MAAM;YACF,IAAI,MAAM,GAAG,IAAI,KAAK,CAAS,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;YAC/D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;gBAC9C,IAAI,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;gBACtC,IAAI,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE;oBAC9B,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,WAAW,EAAE,CAAC;iBAC1G;aACJ;YACD,OAAO,MAAM,CAAC;QAClB,CAAC;QAED;;;;;WAKG;QACH,QAAQ;YACJ,IAAI,SAAS,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;YACjC,IAAI,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;YAC3B,IAAI,MAAM,GAAG,IAAI,KAAK,CAAS,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;YAC/D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;gBAC9C,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;aACtD;YACD,OAAO,MAAM,CAAC;QAClB,CAAC;QAED;;;;;WAKG;QACH,gBAAgB;YACZ,IAAI,QAAQ,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;YAC/B,IAAI,GAAG,GAAG,CAAC,CAAC;YACZ,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;gBAC9C,IAAI,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;gBACtC,GAAG,IAAI,QAAQ,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,WAAW,EAAE,CAAC;aACnE;YACD,OAAO,GAAG,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;QACtC,CAAC;KACJ;IA5KD,0CA4KC"}

package/dist/Performance/DetailedClassificationPerformance.d.ts

@@ -0,0 +1,17 @@
+import { ClassificationPerformance } from "./ClassificationPerformance";
+import { ConfusionMatrix } from "./ConfusionMatrix";
+export declare class DetailedClassificationPerformance extends ClassificationPerformance {
+    private readonly confusionMatrix;
+    /**
+     * A constructor that  sets the accuracy and errorRate as 1 - accuracy via given {@link ConfusionMatrix} and also sets the confusionMatrix.
+     *
+     * @param confusionMatrix {@link ConfusionMatrix} input.
+     */
+    constructor(confusionMatrix: ConfusionMatrix);
+    /**
+     * Accessor for the confusionMatrix.
+     *
+     * @return ConfusionMatrix.
+     */
+    getConfusionMatrix(): ConfusionMatrix;
+}

package/dist/Performance/DetailedClassificationPerformance.js

@@ -0,0 +1,35 @@
+(function (factory) {
+    if (typeof module === "object" && typeof module.exports === "object") {
+        var v = factory(require, exports);
+        if (v !== undefined) module.exports = v;
+    }
+    else if (typeof define === "function" && define.amd) {
+        define(["require", "exports", "./ClassificationPerformance"], factory);
+    }
+})(function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.DetailedClassificationPerformance = void 0;
+    const ClassificationPerformance_1 = require("./ClassificationPerformance");
+    class DetailedClassificationPerformance extends ClassificationPerformance_1.ClassificationPerformance {
+        /**
+         * A constructor that  sets the accuracy and errorRate as 1 - accuracy via given {@link ConfusionMatrix} and also sets the confusionMatrix.
+         *
+         * @param confusionMatrix {@link ConfusionMatrix} input.
+         */
+        constructor(confusionMatrix) {
+            super(confusionMatrix.getAccuracy());
+            this.confusionMatrix = confusionMatrix;
+        }
+        /**
+         * Accessor for the confusionMatrix.
+         *
+         * @return ConfusionMatrix.
+         */
+        getConfusionMatrix() {
+            return this.confusionMatrix;
+        }
+    }
+    exports.DetailedClassificationPerformance = DetailedClassificationPerformance;
+});
+//# sourceMappingURL=DetailedClassificationPerformance.js.map

package/dist/Performance/DetailedClassificationPerformance.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DetailedClassificationPerformance.js","sourceRoot":"","sources":["../../source/Performance/DetailedClassificationPerformance.ts"],"names":[],"mappings":";;;;;;;;;;;;IAAA,2EAAsE;IAGtE,MAAa,iCAAkC,SAAQ,qDAAyB;QAI5E;;;;WAIG;QACH,YAAY,eAAgC;YACxC,KAAK,CAAC,eAAe,CAAC,WAAW,EAAE,CAAC,CAAC;YACrC,IAAI,CAAC,eAAe,GAAG,eAAe,CAAA;QAC1C,CAAC;QAED;;;;WAIG;QACH,kBAAkB;YACd,OAAO,IAAI,CAAC,eAAe,CAAA;QAC/B,CAAC;KACJ;IAtBD,8EAsBC"}

package/dist/Performance/ExperimentPerformance.d.ts

@@ -0,0 +1,88 @@
+import { Performance } from "./Performance";
+import { DetailedClassificationPerformance } from "./DetailedClassificationPerformance";
+import { ClassificationPerformance } from "./ClassificationPerformance";
+export declare class ExperimentPerformance {
+    private results;
+    private containsDetails;
+    private classification;
+    /**
+     * A constructor that takes a file name as an input and takes the inputs from that file assigns these inputs to the
+     * errorRate and adds them to the results {@link Array} as a new {@link Performance}.
+     *
+     * @param fileName String input.
+     */
+    constructor(fileName?: string);
+    /**
+     * The add method takes a {@link Performance} as an input and adds it to the results {@link Array}.
+     *
+     * @param performance {@link Performance} input.
+     */
+    add(performance: Performance): void;
+    /**
+     * The numberOfExperiments method returns the size of the results {@link Array}.
+     *
+     * @return The results {@link Array}.
+     */
+    numberOfExperiments(): number;
+    /**
+     * The getErrorRate method takes an index as an input and returns the errorRate at given index of
+     * results {@link Array}.
+     *
+     * @param index Index of results {@link Array} to retrieve.
+     * @return The errorRate at given index of results {@link Array}.
+     */
+    getErrorRate(index: number): number;
+    /**
+     * The getAccuracy method takes an index as an input. It returns the accuracy of a {@link Performance} at given
+     * index of results {@link Array}.
+     *
+     * @param index Index of results {@link Array} to retrieve.
+     * @return The accuracy of a {@link Performance} at given index of results {@link Array}.
+     */
+    getAccuracy(index: number): number;
+    /**
+     * The meanPerformance method loops through the performances of results {@link Array} and sums up the errorRates
+     * of each then returns a new {@link Performance} with the mean of that summation.
+     *
+     * @return A new {@link Performance} with the mean of the summation of errorRates.
+     */
+    meanPerformance(): Performance;
+    /**
+     * The meanClassificationPerformance method loops through the performances of results {@link Array} and sums up the
+     * accuracy of each classification performance, then returns a new classificationPerformance with the mean of that
+     * summation.
+     *
+     * @return A new classificationPerformance with the mean of that summation.
+     */
+    meanClassificationPerformance(): ClassificationPerformance;
+    /**
+     * The meanDetailedPerformance method gets the first confusion matrix of results {@link Array}.
+     * Then, it adds new confusion matrices as the {@link DetailedClassificationPerformance} of
+     * other elements of results ArrayList' confusion matrices as a {@link DetailedClassificationPerformance}.
+     *
+     * @return A new {@link DetailedClassificationPerformance} with the {@link ConfusionMatrix} sum.
+     */
+    meanDetailedPerformance(): DetailedClassificationPerformance;
+    /**
+     * The standardDeviationPerformance method loops through the {@link Performance}s of results {@link Array} and
+     * returns a new Performance with the standard deviation.
+     *
+     * @return A new Performance with the standard deviation.
+     */
+    standardDeviationPerformance(): Performance;
+    /**
+     * The standardDeviationClassificationPerformance method loops through the {@link Performance}s of results {@link ArrayList} and
+     * returns a new {@link ClassificationPerformance} with standard deviation.
+     *
+     * @return A new {@link ClassificationPerformance} with standard deviation.
+     */
+    standardDeviationClassificationPerformance(): ClassificationPerformance;
+    /**
+     * The isBetter method  takes an {@link ExperimentPerformance} as an input and returns true if the result of compareTo method is positive
+     * and false otherwise.
+     *
+     * @param experimentPerformance {@link ExperimentPerformance} input.
+     * @return True if the result of compareTo method is positive and false otherwise.
+     */
+    isBetter(experimentPerformance: ExperimentPerformance): boolean;
+}

package/dist/Performance/ExperimentPerformance.js

@@ -0,0 +1,176 @@
+(function (factory) {
+    if (typeof module === "object" && typeof module.exports === "object") {
+        var v = factory(require, exports);
+        if (v !== undefined) module.exports = v;
+    }
+    else if (typeof define === "function" && define.amd) {
+        define(["require", "exports", "./Performance", "fs", "./DetailedClassificationPerformance", "./ClassificationPerformance"], factory);
+    }
+})(function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.ExperimentPerformance = void 0;
+    const Performance_1 = require("./Performance");
+    const fs = require("fs");
+    const DetailedClassificationPerformance_1 = require("./DetailedClassificationPerformance");
+    const ClassificationPerformance_1 = require("./ClassificationPerformance");
+    class ExperimentPerformance {
+        /**
+         * A constructor that takes a file name as an input and takes the inputs from that file assigns these inputs to the
+         * errorRate and adds them to the results {@link Array} as a new {@link Performance}.
+         *
+         * @param fileName String input.
+         */
+        constructor(fileName) {
+            this.results = new Array();
+            this.containsDetails = true;
+            this.classification = true;
+            if (fileName != undefined) {
+                let data = fs.readFileSync(fileName, 'utf8');
+                let lines = data.split("\n");
+                for (let line of lines) {
+                    this.results.push(new Performance_1.Performance(Number.parseFloat(line)));
+                }
+            }
+        }
+        /**
+         * The add method takes a {@link Performance} as an input and adds it to the results {@link Array}.
+         *
+         * @param performance {@link Performance} input.
+         */
+        add(performance) {
+            if (!(performance instanceof DetailedClassificationPerformance_1.DetailedClassificationPerformance)) {
+                this.containsDetails = false;
+            }
+            if (!(performance instanceof ClassificationPerformance_1.ClassificationPerformance)) {
+                this.classification = false;
+            }
+            this.results.push(performance);
+        }
+        /**
+         * The numberOfExperiments method returns the size of the results {@link Array}.
+         *
+         * @return The results {@link Array}.
+         */
+        numberOfExperiments() {
+            return this.results.length;
+        }
+        /**
+         * The getErrorRate method takes an index as an input and returns the errorRate at given index of
+         * results {@link Array}.
+         *
+         * @param index Index of results {@link Array} to retrieve.
+         * @return The errorRate at given index of results {@link Array}.
+         */
+        getErrorRate(index) {
+            return this.results[index].getErrorRate();
+        }
+        /**
+         * The getAccuracy method takes an index as an input. It returns the accuracy of a {@link Performance} at given
+         * index of results {@link Array}.
+         *
+         * @param index Index of results {@link Array} to retrieve.
+         * @return The accuracy of a {@link Performance} at given index of results {@link Array}.
+         */
+        getAccuracy(index) {
+            if (this.results[index] instanceof ClassificationPerformance_1.ClassificationPerformance) {
+                return this.results[index].getAccuracy();
+            }
+        }
+        /**
+         * The meanPerformance method loops through the performances of results {@link Array} and sums up the errorRates
+         * of each then returns a new {@link Performance} with the mean of that summation.
+         *
+         * @return A new {@link Performance} with the mean of the summation of errorRates.
+         */
+        meanPerformance() {
+            let sumError = 0;
+            for (let performance of this.results) {
+                sumError += performance.getErrorRate();
+            }
+            return new Performance_1.Performance(sumError / this.results.length);
+        }
+        /**
+         * The meanClassificationPerformance method loops through the performances of results {@link Array} and sums up the
+         * accuracy of each classification performance, then returns a new classificationPerformance with the mean of that
+         * summation.
+         *
+         * @return A new classificationPerformance with the mean of that summation.
+         */
+        meanClassificationPerformance() {
+            if (this.results.length == 0 || !this.classification) {
+                return undefined;
+            }
+            let sumAccuracy = 0;
+            for (let performance of this.results) {
+                let classificationPerformance = performance;
+                sumAccuracy += classificationPerformance.getAccuracy();
+            }
+            return new ClassificationPerformance_1.ClassificationPerformance(sumAccuracy / this.results.length);
+        }
+        /**
+         * The meanDetailedPerformance method gets the first confusion matrix of results {@link Array}.
+         * Then, it adds new confusion matrices as the {@link DetailedClassificationPerformance} of
+         * other elements of results ArrayList' confusion matrices as a {@link DetailedClassificationPerformance}.
+         *
+         * @return A new {@link DetailedClassificationPerformance} with the {@link ConfusionMatrix} sum.
+         */
+        meanDetailedPerformance() {
+            if (this.results.length == 0 || !this.containsDetails) {
+                return undefined;
+            }
+            let sum = this.results[0].getConfusionMatrix();
+            for (let i = 1; i < this.results.length; i++) {
+                sum.addConfusionMatrix(this.results[i].getConfusionMatrix());
+            }
+            return new DetailedClassificationPerformance_1.DetailedClassificationPerformance(sum);
+        }
+        /**
+         * The standardDeviationPerformance method loops through the {@link Performance}s of results {@link Array} and
+         * returns a new Performance with the standard deviation.
+         *
+         * @return A new Performance with the standard deviation.
+         */
+        standardDeviationPerformance() {
+            let sumErrorRate = 0;
+            let averagePerformance = this.meanPerformance();
+            for (let performance of this.results) {
+                sumErrorRate += Math.pow(performance.getErrorRate() - averagePerformance.getErrorRate(), 2);
+            }
+            return new Performance_1.Performance(Math.sqrt(sumErrorRate / (this.results.length - 1)));
+        }
+        /**
+         * The standardDeviationClassificationPerformance method loops through the {@link Performance}s of results {@link ArrayList} and
+         * returns a new {@link ClassificationPerformance} with standard deviation.
+         *
+         * @return A new {@link ClassificationPerformance} with standard deviation.
+         */
+        standardDeviationClassificationPerformance() {
+            if (this.results.length == 0 || !this.classification) {
+                return undefined;
+            }
+            let sumAccuracy = 0, sumErrorRate = 0;
+            let averageClassificationPerformance = this.meanClassificationPerformance();
+            for (let performance of this.results) {
+                let classificationPerformance = performance;
+                sumAccuracy += Math.pow(classificationPerformance.getAccuracy() - averageClassificationPerformance.getAccuracy(), 2);
+                sumErrorRate += Math.pow(classificationPerformance.getErrorRate() - averageClassificationPerformance.getErrorRate(), 2);
+            }
+            return new ClassificationPerformance_1.ClassificationPerformance(Math.sqrt(sumAccuracy / (this.results.length - 1)), Math.sqrt(sumErrorRate / (this.results.length - 1)));
+        }
+        /**
+         * The isBetter method  takes an {@link ExperimentPerformance} as an input and returns true if the result of compareTo method is positive
+         * and false otherwise.
+         *
+         * @param experimentPerformance {@link ExperimentPerformance} input.
+         * @return True if the result of compareTo method is positive and false otherwise.
+         */
+        isBetter(experimentPerformance) {
+            let accuracy1 = this.meanClassificationPerformance().getAccuracy();
+            let accuracy2 = experimentPerformance.meanClassificationPerformance().getAccuracy();
+            return accuracy1 > accuracy2;
+        }
+    }
+    exports.ExperimentPerformance = ExperimentPerformance;
+});
+//# sourceMappingURL=ExperimentPerformance.js.map

package/dist/Performance/ExperimentPerformance.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExperimentPerformance.js","sourceRoot":"","sources":["../../source/Performance/ExperimentPerformance.ts"],"names":[],"mappings":";;;;;;;;;;;;IAAA,+CAA0C;IAC1C,yBAAyB;IACzB,2FAAsF;IACtF,2EAAsE;IAEtE,MAAa,qBAAqB;QAM9B;;;;;WAKG;QACH,YAAY,QAAiB;YAVrB,YAAO,GAAuB,IAAI,KAAK,EAAe,CAAA;YACtD,oBAAe,GAAY,IAAI,CAAA;YAC/B,mBAAc,GAAY,IAAI,CAAA;YASlC,IAAI,QAAQ,IAAI,SAAS,EAAC;gBACtB,IAAI,IAAI,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;gBAC5C,IAAI,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;gBAC5B,KAAK,IAAI,IAAI,IAAI,KAAK,EAAC;oBACnB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,yBAAW,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;iBAC9D;aACJ;QACL,CAAC;QAED;;;;WAIG;QACH,GAAG,CAAC,WAAwB;YACxB,IAAI,CAAC,CAAC,WAAW,YAAY,qEAAiC,CAAC,EAAC;gBAC5D,IAAI,CAAC,eAAe,GAAG,KAAK,CAAA;aAC/B;YACD,IAAI,CAAC,CAAC,WAAW,YAAY,qDAAyB,CAAC,EAAC;gBACpD,IAAI,CAAC,cAAc,GAAG,KAAK,CAAA;aAC9B;YACD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;QAClC,CAAC;QAED;;;;WAIG;QACH,mBAAmB;YACf,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAA;QAC9B,CAAC;QAED;;;;;;WAMG;QACH,YAAY,CAAC,KAAa;YACtB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,YAAY,EAAE,CAAA;QAC7C,CAAC;QAED;;;;;;WAMG;QACH,WAAW,CAAC,KAAa;YACrB,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,YAAY,qDAAyB,EAAC;gBACzD,OAAoC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAE,CAAC,WAAW,EAAE,CAAA;aACzE;QACL,CAAC;QAED;;;;;WAKG;QACH,eAAe;YACX,IAAI,QAAQ,GAAG,CAAC,CAAC;YACjB,KAAK,IAAI,WAAW,IAAI,IAAI,CAAC,OAAO,EAAE;gBAClC,QAAQ,IAAI,WAAW,CAAC,YAAY,EAAE,CAAC;aAC1C;YACD,OAAO,IAAI,yBAAW,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAC3D,CAAC;QAED;;;;;;WAMG;QACH,6BAA6B;YACzB,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE;gBAClD,OAAO,SAAS,CAAC;aACpB;YACD,IAAI,WAAW,GAAG,CAAC,CAAC;YACpB,KAAK,IAAI,WAAW,IAAK,IAAI,CAAC,OAAO,EAAE;gBACnC,IAAI,yBAAyB,GAA+B,WAAW,CAAC;gBACxE,WAAW,IAAI,yBAAyB,CAAC,WAAW,EAAE,CAAC;aAC1D;YACD,OAAO,IAAI,qDAAyB,CAAC,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAC5E,CAAC;QAED;;;;;;WAMG;QACH,uBAAuB;YACnB,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE;gBACnD,OAAO,SAAS,CAAC;aACpB;YACD,IAAI,GAAG,GAAwC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAE,CAAC,kBAAkB,EAAE,CAAC;YACrF,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;gBAC1C,GAAG,CAAC,kBAAkB,CAAsC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAE,CAAC,kBAAkB,EAAE,CAAC,CAAC;aACtG;YACD,OAAO,IAAI,qEAAiC,CAAC,GAAG,CAAC,CAAC;QACtD,CAAC;QAED;;;;;WAKG;QACH,4BAA4B;YACxB,IAAI,YAAY,GAAG,CAAC,CAAC;YACrB,IAAI,kBAAkB,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;YAChD,KAAK,IAAI,WAAW,IAAI,IAAI,CAAC,OAAO,EAAE;gBAClC,YAAY,IAAI,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,YAAY,EAAE,GAAG,kBAAkB,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC,CAAC;aAC/F;YACD,OAAO,IAAI,yBAAW,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QAChF,CAAC;QAED;;;;;WAKG;QACH,0CAA0C;YACtC,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE;gBAClD,OAAO,SAAS,CAAC;aACpB;YACD,IAAI,WAAW,GAAG,CAAC,EAAE,YAAY,GAAG,CAAC,CAAC;YACtC,IAAI,gCAAgC,GAAG,IAAI,CAAC,6BAA6B,EAAE,CAAC;YAC5E,KAAK,IAAI,WAAW,IAAI,IAAI,CAAC,OAAO,EAAE;gBAClC,IAAI,yBAAyB,GAA+B,WAAW,CAAC;gBACxE,WAAW,IAAI,IAAI,CAAC,GAAG,CAAC,yBAAyB,CAAC,WAAW,EAAE,GAAG,gCAAgC,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,CAAC;gBACrH,YAAY,IAAI,IAAI,CAAC,GAAG,CAAC,yBAAyB,CAAC,YAAY,EAAE,GAAG,gCAAgC,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC,CAAC;aAC3H;YACD,OAAO,IAAI,qDAAyB,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,EACnF,IAAI,CAAC,IAAI,CAAC,YAAY,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QAC7D,CAAC;QAED;;;;;;WAMG;QACH,QAAQ,CAAC,qBAA4C;YACjD,IAAI,SAAS,GAAG,IAAI,CAAC,6BAA6B,EAAE,CAAC,WAAW,EAAE,CAAC;YACnE,IAAI,SAAS,GAAG,qBAAqB,CAAC,6BAA6B,EAAE,CAAC,WAAW,EAAE,CAAC;YACpF,OAAO,SAAS,GAAG,SAAS,CAAA;QAChC,CAAC;KACJ;IAzKD,sDAyKC"}

package/dist/Performance/Performance.d.ts

@@ -0,0 +1,15 @@
+export declare class Performance {
+    protected errorRate: number;
+    /**
+     * Constructor that sets the error rate.
+     *
+     * @param errorRate Double input.
+     */
+    constructor(errorRate: number);
+    /**
+     * Accessor for the error rate.
+     *
+     * @return Double errorRate.
+     */
+    getErrorRate(): number;
+}