nlptoolkit-classification 1.0.7 → 1.0.9

package/dist/Model/NeuralNetwork/NeuralNetworkModel.js

@@ -0,0 +1,211 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NeuralNetworkModel = void 0;
+const ValidatedModel_1 = require("../ValidatedModel");
+const Vector_1 = require("nlptoolkit-math/dist/Vector");
+const Matrix_1 = require("nlptoolkit-math/dist/Matrix");
+const ActivationFunction_1 = require("../../Parameter/ActivationFunction");
+const CompositeInstance_1 = require("../../Instance/CompositeInstance");
+class NeuralNetworkModel extends ValidatedModel_1.ValidatedModel {
+    classLabels;
+    K;
+    d;
+    x;
+    y;
+    r;
+    /**
+     * Constructor that sets the class labels, their sizes as K and the size of the continuous attributes as d.
+     *
+     * @param trainSet {@link InstanceList} to use as train set.
+     */
+    initialize(trainSet) {
+        if (trainSet != undefined) {
+            this.classLabels = trainSet.getDistinctClassLabels();
+            this.K = this.classLabels.length;
+            this.d = trainSet.get(0).continuousAttributeSize();
+        }
+    }
+    /**
+     * The allocateLayerWeights method returns a new {@link Matrix} with random weights.
+     *
+     * @param row    Number of rows.
+     * @param column Number of columns.
+     * @param random Random function to set weights.
+     * @return Matrix with random weights.
+     */
+    allocateLayerWeights(row, column, random) {
+        return new Matrix_1.Matrix(row, column, -0.01, +0.01, random);
+    }
+    /**
+     * The normalizeOutput method takes an input {@link Vector} o, gets the result for e^o of each element of o,
+     * then sums them up. At the end, divides each e^o by the summation.
+     *
+     * @param o Vector to normalize.
+     * @return Normalized vector.
+     */
+    normalizeOutput(o) {
+        let sum = 0.0;
+        let values = new Array();
+        for (let i = 0; i < o.size(); i++) {
+            sum += Math.exp(o.getValue(i));
+        }
+        for (let i = 0; i < o.size(); i++) {
+            values.push(Math.exp(o.getValue(i)) / sum);
+        }
+        return new Vector_1.Vector(values);
+    }
+    /**
+     * The createInputVector method takes an {@link Instance} as an input. It converts given Instance to the {@link Vector}
+     * and insert 1.0 to the first element.
+     *
+     * @param instance Instance to insert 1.0.
+     */
+    createInputVector(instance) {
+        this.x = instance.toVector();
+        this.x.insert(0, 1.0);
+    }
+    /**
+     * The calculateHidden method takes a {@link Vector} input and {@link Matrix} weights, It multiplies the weights
+     * Matrix with given input Vector than applies the sigmoid function and returns the result.
+     *
+     * @param input   Vector to multiply weights.
+     * @param weights Matrix is multiplied with input Vector.
+     * @param activationFunction Activation function.
+     * @return Result of sigmoid function.
+     */
+    calculateHidden(input, weights, activationFunction) {
+        let z = weights.multiplyWithVectorFromRight(input);
+        switch (activationFunction) {
+            case ActivationFunction_1.ActivationFunction.SIGMOID:
+            default:
+                z.sigmoid();
+                break;
+            case ActivationFunction_1.ActivationFunction.TANH:
+                z.tanh();
+                break;
+            case ActivationFunction_1.ActivationFunction.RELU:
+                z.relu();
+                break;
+        }
+        return z;
+    }
+    /**
+     * The calculateOneMinusHidden method takes a {@link Vector} as input. It creates a Vector of ones and
+     * returns the difference between given Vector.
+     *
+     * @param hidden Vector to find difference.
+     * @return Returns the difference between one's Vector and input Vector.
+     */
+    calculateOneMinusHidden(hidden) {
+        let one = new Vector_1.Vector(hidden.size(), 1.0);
+        return one.difference(hidden);
+    }
+    /**
+     * The calculateForwardSingleHiddenLayer method takes two matrices W and V. First it multiplies W with x, then
+     * multiplies V with the result of the previous multiplication.
+     *
+     * @param W Matrix to multiply with x.
+     * @param V Matrix to multiply.
+     * @param activationFunction Activation function.
+     */
+    calculateForwardSingleHiddenLayer(W, V, activationFunction) {
+        let hidden = this.calculateHidden(this.x, W, activationFunction);
+        let hiddenBiased = hidden.biased();
+        this.y = V.multiplyWithVectorFromRight(hiddenBiased);
+    }
+    /**
+     * The calculateRMinusY method creates a new {@link Vector} with given Instance, then it multiplies given
+     * input Vector with given weights Matrix. After normalizing the output, it returns the difference between the newly created
+     * Vector and normalized output.
+     *
+     * @param instance Instance is used to get class labels.
+     * @param input    Vector to multiply weights.
+     * @param weights  Matrix of weights/
+     * @return Difference between newly created Vector and normalized output.
+     */
+    calculateRMinusY(instance, input, weights) {
+        this.r = new Vector_1.Vector(this.K, 1.0, this.classLabels.indexOf(instance.getClassLabel()));
+        let o = weights.multiplyWithVectorFromRight(input);
+        this.y = this.normalizeOutput(o);
+        return this.r.difference(this.y);
+    }
+    /**
+     * The predictWithCompositeInstance method takes an ArrayList possibleClassLabels. It returns the class label
+     * which has the maximum value of y.
+     *
+     * @param possibleClassLabels ArrayList that has the class labels.
+     * @return The class label which has the maximum value of y.
+     */
+    predictWithCompositeInstance(possibleClassLabels) {
+        let predictedClass = possibleClassLabels[0];
+        let maxY = Number.NEGATIVE_INFINITY;
+        for (let i = 0; i < this.classLabels.length; i++) {
+            if (possibleClassLabels.includes(this.classLabels[i]) && this.y.getValue(i) > maxY) {
+                maxY = this.y.getValue(i);
+                predictedClass = this.classLabels[i];
+            }
+        }
+        return predictedClass;
+    }
+    /**
+     * The predict method takes an {@link Instance} as an input, converts it to a Vector and calculates the {@link Matrix} y by
+     * multiplying Matrix W with {@link Vector} x. Then it returns the class label which has the maximum y value.
+     *
+     * @param instance Instance to predict.
+     * @return The class label which has the maximum y.
+     */
+    predict(instance) {
+        this.createInputVector(instance);
+        this.calculateOutput();
+        if (instance instanceof CompositeInstance_1.CompositeInstance) {
+            return this.predictWithCompositeInstance(instance.getPossibleClassLabels());
+        }
+        else {
+            return this.classLabels[this.y.maxIndex()];
+        }
+    }
+    /**
+     * Calculates the posterior probability distribution for the given instance according to neural network model.
+     * @param instance Instance for which posterior probability distribution is calculated.
+     * @return Posterior probability distribution for the given instance.
+     */
+    predictProbability(instance) {
+        this.createInputVector(instance);
+        this.calculateOutput();
+        let result = new Map();
+        for (let i = 0; i < this.classLabels.length; i++) {
+            result.set(this.classLabels[i], this.y.getValue(i));
+        }
+        return result;
+    }
+    /**
+     * Loads the class labels from input model file.
+     * @param input Input model file.
+     */
+    loadClassLabels(input) {
+        let items = input.readLine().split(" ");
+        this.K = parseInt(items[0]);
+        this.d = parseInt(items[1]);
+        this.classLabels = new Array();
+        for (let i = 0; i < this.K; i++) {
+            this.classLabels.push(input.readLine());
+        }
+    }
+    /**
+     * Loads the activation function from an input model file.
+     * @param input Input model file.
+     * @return Activation function read.
+     */
+    loadActivationFunction(input) {
+        switch (input.readLine()) {
+            case "TANH":
+                return ActivationFunction_1.ActivationFunction.TANH;
+            case "RELU":
+                return ActivationFunction_1.ActivationFunction.RELU;
+            default:
+                return ActivationFunction_1.ActivationFunction.SIGMOID;
+        }
+    }
+}
+exports.NeuralNetworkModel = NeuralNetworkModel;
+//# sourceMappingURL=NeuralNetworkModel.js.map

package/dist/Model/NeuralNetwork/NeuralNetworkModel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NeuralNetworkModel.js","sourceRoot":"","sources":["../../../source/Model/NeuralNetwork/NeuralNetworkModel.ts"],"names":[],"mappings":";;;AAAA,sDAAiD;AACjD,wDAAmD;AAEnD,wDAAmD;AAEnD,2EAAsE;AACtE,wEAAmE;AAInE,MAAsB,kBAAmB,SAAQ,+BAAc;IAEjD,WAAW,CAAe;IAC1B,CAAC,CAAQ;IACT,CAAC,CAAQ;IACT,CAAC,CAAQ;IACT,CAAC,CAAQ;IACT,CAAC,CAAQ;IAInB;;;;OAIG;IACO,UAAU,CAAC,QAAsB;QACvC,IAAI,QAAQ,IAAI,SAAS,EAAC,CAAC;YACvB,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAC,sBAAsB,EAAE,CAAA;YACpD,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,CAAA;YAChC,IAAI,CAAC,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,uBAAuB,EAAE,CAAA;QACtD,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACO,oBAAoB,CAAC,GAAW,EAAE,MAAc,EAAE,MAAc;QACtE,OAAO,IAAI,eAAM,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACzD,CAAC;IAED;;;;;;OAMG;IACO,eAAe,CAAC,CAAS;QAC/B,IAAI,GAAG,GAAG,GAAG,CAAC;QACd,IAAI,MAAM,GAAG,IAAI,KAAK,EAAU,CAAA;QAChC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,EAAE,EAAC,CAAC;YAC/B,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;QACnC,CAAC;QACD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,EAAE,EAAC,CAAC;YAC/B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC;QAC/C,CAAC;QACD,OAAO,IAAI,eAAM,CAAC,MAAM,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;OAKG;IACO,iBAAiB,CAAC,QAAkB;QAC1C,IAAI,CAAC,CAAC,GAAG,QAAQ,CAAC,QAAQ,EAAE,CAAC;QAC7B,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IAC1B,CAAC;IAED;;;;;;;;OAQG;IACO,eAAe,CAAC,KAAa,EAAE,OAAe,EAAE,kBAAsC;QAC5F,IAAI,CAAC,GAAG,OAAO,CAAC,2BAA2B,CAAC,KAAK,CAAC,CAAC;QACnD,QAAQ,kBAAkB,EAAC,CAAC;YACxB,KAAK,uCAAkB,CAAC,OAAO,CAAC;YAChC;gBACI,CAAC,CAAC,OAAO,EAAE,CAAC;gBACZ,MAAM;YACV,KAAK,uCAAkB,CAAC,IAAI;gBACxB,CAAC,CAAC,IAAI,EAAE,CAAC;gBACT,MAAM;YACV,KAAK,uCAAkB,CAAC,IAAI;gBACxB,CAAC,CAAC,IAAI,EAAE,CAAC;gBACT,MAAM;QACd,CAAC;QACD,OAAO,CAAC,CAAC;IACb,CAAC;IAED;;;;;;OAMG;IACO,uBAAuB,CAAC,MAAc;QAC5C,IAAI,GAAG,GAAG,IAAI,eAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,GAAG,CAAC,CAAC;QACzC,OAAO,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IAClC,CAAC;IAED;;;;;;;OAOG;IACO,iCAAiC,CAAC,CAAS,EAAE,CAAS,EAAE,kBAAsC;QACpG,IAAI,MAAM,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,kBAAkB,CAAC,CAAC;QACjE,IAAI,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC;QACnC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,2BAA2B,CAAC,YAAY,CAAC,CAAC;IACzD,CAAC;IAED;;;;;;;;;OASG;IACO,gBAAgB,CAAC,QAAkB,EAAE,KAAa,EAAE,OAAe;QACzE,IAAI,CAAC,CAAC,GAAG,IAAI,eAAM,CAAC,IAAI,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC;QACrF,IAAI,CAAC,GAAG,OAAO,CAAC,2BAA2B,CAAC,KAAK,CAAC,CAAC;QACnD,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;QACjC,OAAO,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACrC,CAAC;IAED;;;;;;OAMG;IACO,4BAA4B,CAAC,mBAAkC;QACrE,IAAI,cAAc,GAAG,mBAAmB,CAAC,CAAC,CAAC,CAAC;QAC5C,IAAI,IAAI,GAAG,MAAM,CAAC,iBAAiB,CAAA;QACnC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAC/C,IAAI,mBAAmB,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,IAAI,EAAE,CAAC;gBACjF,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;gBAC1B,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;YACzC,CAAC;QACL,CAAC;QACD,OAAO,cAAc,CAAC;IAC1B,CAAC;IAED;;;;;;OAMG;IACH,OAAO,CAAC,QAAkB;QACtB,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;QACjC,IAAI,CAAC,eAAe,EAAE,CAAC;QACvB,IAAI,QAAQ,YAAY,qCAAiB,EAAE,CAAC;YACxC,OAAO,IAAI,CAAC,4BAA4B,CAAsB,QAAS,CAAC,sBAAsB,EAAE,CAAC,CAAC;QACtG,CAAC;aAAM,CAAC;YACJ,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC/C,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,kBAAkB,CAAC,QAAkB;QACjC,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;QACjC,IAAI,CAAC,eAAe,EAAE,CAAC;QACvB,IAAI,MAAM,GAAG,IAAI,GAAG,EAAkB,CAAC;QACvC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC,EAAE,EAAC,CAAC;YAC9C,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;QACxD,CAAC;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;;OAGG;IACH,eAAe,CAAC,KAAmB;QAC/B,IAAI,KAAK,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QACvC,IAAI,CAAC,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;QAC3B,IAAI,CAAC,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;QAC3B,IAAI,CAAC,WAAW,GAAG,IAAI,KAAK,EAAU,CAAA;QACtC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,EAAC,CAAC;YAC7B,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAA;QAC3C,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,sBAAsB,CAAC,KAAmB;QACtC,QAAQ,KAAK,CAAC,QAAQ,EAAE,EAAC,CAAC;YACtB,KAAK,MAAM;gBACP,OAAO,uCAAkB,CAAC,IAAI,CAAA;YAClC,KAAK,MAAM;gBACP,OAAO,uCAAkB,CAAC,IAAI,CAAA;YAClC;gBACI,OAAO,uCAAkB,CAAC,OAAO,CAAA;QACzC,CAAC;IACL,CAAC;CACJ;AAvND,gDAuNC"}

package/dist/Model/{KnnInstance.d.ts → NonParametric/KnnInstance.d.ts}

@@ -1,4 +1,4 @@
-import { Instance } from "../Instance/Instance";
+import { Instance } from "../../Instance/Instance";
 export declare class KnnInstance {
     private readonly distance;
     private readonly instance;

package/dist/Model/NonParametric/KnnInstance.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KnnInstance = void 0;
+class KnnInstance {
+    distance;
+    instance;
+    /**
+     * The constructor that sets the instance and distance value.
+     *
+     * @param instance {@link Instance} input.
+     * @param distance Double distance value.
+     */
+    constructor(instance, distance) {
+        this.instance = instance;
+        this.distance = distance;
+    }
+    getInstance() {
+        return this.instance;
+    }
+    getDistance() {
+        return this.distance;
+    }
+}
+exports.KnnInstance = KnnInstance;
+//# sourceMappingURL=KnnInstance.js.map

package/dist/Model/NonParametric/KnnInstance.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"KnnInstance.js","sourceRoot":"","sources":["../../../source/Model/NonParametric/KnnInstance.ts"],"names":[],"mappings":";;;AAEA,MAAa,WAAW;IAEH,QAAQ,CAAQ;IAChB,QAAQ,CAAU;IAEnC;;;;;OAKG;IACH,YAAY,QAAkB,EAAE,QAAgB;QAC5C,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC7B,CAAC;IAED,WAAW;QACP,OAAO,IAAI,CAAC,QAAQ,CAAA;IACxB,CAAC;IAED,WAAW;QACP,OAAO,IAAI,CAAC,QAAQ,CAAA;IACxB,CAAC;CAEJ;AAxBD,kCAwBC"}

package/dist/Model/{KnnModel.d.ts → NonParametric/KnnModel.d.ts}

@@ -1,7 +1,8 @@
-import { Model } from "./Model";
-import { InstanceList } from "../InstanceList/InstanceList";
-import { Instance } from "../Instance/Instance";
-import { DistanceMetric } from "../DistanceMetric/DistanceMetric";
+import { Model } from "../Model";
+import { InstanceList } from "../../InstanceList/InstanceList";
+import { Instance } from "../../Instance/Instance";
+import { DistanceMetric } from "../../DistanceMetric/DistanceMetric";
+import { Parameter } from "../../Parameter/Parameter";
 export declare class KnnModel extends Model {
     private data;
     private k;
@@ -9,11 +10,16 @@ export declare class KnnModel extends Model {
     /**
      * Constructor that sets the data {@link InstanceList}, k value and the {@link DistanceMetric}.
      *
-     * @param dataOrFileName           {@link InstanceList} input.
+     * @param data           {@link InstanceList} input.
      * @param k              K value.
      * @param distanceMetric {@link DistanceMetric} input.
      */
-    constructor(dataOrFileName: InstanceList | string, k?: number, distanceMetric?: DistanceMetric);
+    constructor1(data: InstanceList, k: number, distanceMetric: DistanceMetric): void;
+    /**
+     * Loads a K-nearest neighbor model from an input model file.
+     * @param fileName Model file name.
+     */
+    constructor2(fileName: string): void;
     /**
      * The predict method takes an {@link Instance} as an input and finds the nearest neighbors of given instance. Then
      * it returns the first possible class label as the predicted class.
@@ -22,6 +28,11 @@ export declare class KnnModel extends Model {
      * @return The first possible class label as the predicted class.
      */
     predict(instance: Instance): string;
+    /**
+     * Calculates the posterior probability distribution for the given instance according to K-means model.
+     * @param instance Instance for which posterior probability distribution is calculated.
+     * @return Posterior probability distribution for the given instance.
+     */
     predictProbability(instance: Instance): Map<string, number>;
     /**
      * The nearestNeighbors method takes an {@link Instance} as an input. First it gets the possible class labels, then loops
@@ -34,4 +45,17 @@ export declare class KnnModel extends Model {
      */
     nearestNeighbors(instance: Instance): InstanceList;
     saveTxt(fileName: string): void;
+    /**
+     * Training algorithm for K-nearest neighbor classifier.
+     *
+     * @param trainSet   Training data given to the algorithm.
+     * @param parameters K: k parameter of the K-nearest neighbor algorithm
+     *                   distanceMetric: distance metric used to calculate the distance between two instances.
+     */
+    train(trainSet: InstanceList, parameters: Parameter): void;
+    /**
+     * Loads the K-nearest neighbor model from an input file.
+     * @param fileName File name of the K-nearest neighbor model.
+     */
+    loadModel(fileName: string): void;
 }

package/dist/Model/NonParametric/KnnModel.js

@@ -0,0 +1,111 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KnnModel = void 0;
+const Model_1 = require("../Model");
+const InstanceList_1 = require("../../InstanceList/InstanceList");
+const CompositeInstance_1 = require("../../Instance/CompositeInstance");
+const KnnInstance_1 = require("./KnnInstance");
+const EuclidianDistance_1 = require("../../DistanceMetric/EuclidianDistance");
+const FileContents_1 = require("nlptoolkit-util/dist/FileContents");
+class KnnModel extends Model_1.Model {
+    data;
+    k;
+    distanceMetric;
+    /**
+     * Constructor that sets the data {@link InstanceList}, k value and the {@link DistanceMetric}.
+     *
+     * @param data           {@link InstanceList} input.
+     * @param k              K value.
+     * @param distanceMetric {@link DistanceMetric} input.
+     */
+    constructor1(data, k, distanceMetric) {
+        this.data = data;
+        this.k = k;
+        this.distanceMetric = distanceMetric;
+    }
+    /**
+     * Loads a K-nearest neighbor model from an input model file.
+     * @param fileName Model file name.
+     */
+    constructor2(fileName) {
+        this.distanceMetric = new EuclidianDistance_1.EuclidianDistance();
+        let input = new FileContents_1.FileContents(fileName);
+        this.k = parseInt(input.readLine());
+        this.data = this.loadInstanceList(input);
+    }
+    /**
+     * The predict method takes an {@link Instance} as an input and finds the nearest neighbors of given instance. Then
+     * it returns the first possible class label as the predicted class.
+     *
+     * @param instance {@link Instance} to make prediction.
+     * @return The first possible class label as the predicted class.
+     */
+    predict(instance) {
+        let nearestNeighbors = this.nearestNeighbors(instance);
+        let predictedClass;
+        if (instance instanceof CompositeInstance_1.CompositeInstance && nearestNeighbors.size() == 0) {
+            predictedClass = instance.getPossibleClassLabels()[0];
+        }
+        else {
+            predictedClass = Model_1.Model.getMaximum(nearestNeighbors.getClassLabels());
+        }
+        return predictedClass;
+    }
+    /**
+     * Calculates the posterior probability distribution for the given instance according to K-means model.
+     * @param instance Instance for which posterior probability distribution is calculated.
+     * @return Posterior probability distribution for the given instance.
+     */
+    predictProbability(instance) {
+        let nearestNeighbors = this.nearestNeighbors(instance);
+        return nearestNeighbors.classDistribution().getProbabilityDistribution();
+    }
+    /**
+     * The nearestNeighbors method takes an {@link Instance} as an input. First it gets the possible class labels, then loops
+     * through the data {@link InstanceList} and creates new {@link Array} of {@link KnnInstance}s and adds the corresponding data with
+     * the distance between data and given instance. After sorting this newly created ArrayList, it loops k times and
+     * returns the first k instances as an {@link InstanceList}.
+     *
+     * @param instance {@link Instance} to find nearest neighbors/
+     * @return The first k instances which are nearest to the given instance as an {@link InstanceList}.
+     */
+    nearestNeighbors(instance) {
+        let result = new InstanceList_1.InstanceList();
+        let instances = new Array();
+        let possibleClassLabels = undefined;
+        if (instance instanceof CompositeInstance_1.CompositeInstance) {
+            possibleClassLabels = instance.getPossibleClassLabels();
+        }
+        for (let i = 0; i < this.data.size(); i++) {
+            if (!(instance instanceof CompositeInstance_1.CompositeInstance) || possibleClassLabels.includes(this.data.get(i).getClassLabel())) {
+                instances.push(new KnnInstance_1.KnnInstance(this.data.get(i), this.distanceMetric.distance(this.data.get(i), instance)));
+            }
+        }
+        instances.sort((a, b) => a.getDistance() < b.getDistance() ? -1 : a.getDistance() > b.getDistance() ? 1 : 0);
+        for (let i = 0; i < Math.min(this.k, instances.length); i++) {
+            result.add(instances[i].getInstance());
+        }
+        return result;
+    }
+    saveTxt(fileName) {
+    }
+    /**
+     * Training algorithm for K-nearest neighbor classifier.
+     *
+     * @param trainSet   Training data given to the algorithm.
+     * @param parameters K: k parameter of the K-nearest neighbor algorithm
+     *                   distanceMetric: distance metric used to calculate the distance between two instances.
+     */
+    train(trainSet, parameters) {
+        this.constructor1(trainSet, parameters.getK(), parameters.getDistanceMetric());
+    }
+    /**
+     * Loads the K-nearest neighbor model from an input file.
+     * @param fileName File name of the K-nearest neighbor model.
+     */
+    loadModel(fileName) {
+        this.constructor2(fileName);
+    }
+}
+exports.KnnModel = KnnModel;
+//# sourceMappingURL=KnnModel.js.map

package/dist/Model/NonParametric/KnnModel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"KnnModel.js","sourceRoot":"","sources":["../../../source/Model/NonParametric/KnnModel.ts"],"names":[],"mappings":";;;AAAA,oCAA+B;AAC/B,kEAA6D;AAG7D,wEAAmE;AACnE,+CAA0C;AAC1C,8EAAyE;AACzE,oEAA+D;AAI/D,MAAa,QAAS,SAAQ,aAAK;IAEvB,IAAI,CAAc;IAClB,CAAC,CAAQ;IACT,cAAc,CAAgB;IAEtC;;;;;;OAMG;IACH,YAAY,CAAC,IAAkB,EAAE,CAAS,EAAE,cAA8B;QACtE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC,CAAC,GAAG,CAAC,CAAA;QACV,IAAI,CAAC,cAAc,GAAG,cAAc,CAAA;IACxC,CAAC;IAED;;;OAGG;IACH,YAAY,CAAC,QAAgB;QACzB,IAAI,CAAC,cAAc,GAAG,IAAI,qCAAiB,EAAE,CAAA;QAC7C,IAAI,KAAK,GAAG,IAAI,2BAAY,CAAC,QAAQ,CAAC,CAAA;QACtC,IAAI,CAAC,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAA;QACnC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAA;IAC5C,CAAC;IAED;;;;;;OAMG;IACH,OAAO,CAAC,QAAkB;QACtB,IAAI,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QACvD,IAAI,cAAc,CAAA;QAClB,IAAI,QAAQ,YAAY,qCAAiB,IAAI,gBAAgB,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC;YACxE,cAAc,GAAwB,QAAS,CAAC,sBAAsB,EAAE,CAAC,CAAC,CAAC,CAAC;QAChF,CAAC;aAAM,CAAC;YACJ,cAAc,GAAG,aAAK,CAAC,UAAU,CAAC,gBAAgB,CAAC,cAAc,EAAE,CAAC,CAAC;QACzE,CAAC;QACD,OAAO,cAAc,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IACH,kBAAkB,CAAC,QAAkB;QACjC,IAAI,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QACvD,OAAO,gBAAgB,CAAC,iBAAiB,EAAE,CAAC,0BAA0B,EAAE,CAAC;IAC7E,CAAC;IAED;;;;;;;;OAQG;IACH,gBAAgB,CAAC,QAAkB;QAC/B,IAAI,MAAM,GAAG,IAAI,2BAAY,EAAE,CAAC;QAChC,IAAI,SAAS,GAAG,IAAI,KAAK,EAAe,CAAC;QACzC,IAAI,mBAAmB,GAAG,SAAS,CAAC;QACpC,IAAI,QAAQ,YAAY,qCAAiB,EAAE,CAAC;YACxC,mBAAmB,GAAwB,QAAS,CAAC,sBAAsB,EAAE,CAAC;QAClF,CAAC;QACD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC;YACxC,IAAI,CAAC,CAAC,QAAQ,YAAY,qCAAiB,CAAC,IAAI,mBAAmB,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC,EAAE,CAAC;gBAC7G,SAAS,CAAC,IAAI,CAAC,IAAI,yBAAW,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;YAChH,CAAC;QACL,CAAC;QACD,SAAS,CAAC,IAAI,CAAC,CAAC,CAAc,EAAE,CAAc,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA,CAAC,CAAC,CAAC,CAAC,CAAC;QACtI,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,EAAE,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YAC1D,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;QAC3C,CAAC;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,OAAO,CAAC,QAAgB;IACxB,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,QAAsB,EAAE,UAAqB;QAC/C,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAkB,UAAW,CAAC,IAAI,EAAE,EAAkB,UAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;IACrH,CAAC;IAED;;;OAGG;IACH,SAAS,CAAC,QAAgB;QACtB,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAA;IAC/B,CAAC;CAEJ;AA5GD,4BA4GC"}

package/dist/Model/{GaussianModel.d.ts → Parametric/GaussianModel.d.ts}

@@ -1,6 +1,6 @@
 import { DiscreteDistribution } from "nlptoolkit-math/dist/DiscreteDistribution";
-import { Instance } from "../Instance/Instance";
-import { ValidatedModel } from "./ValidatedModel";
+import { Instance } from "../../Instance/Instance";
+import { ValidatedModel } from "../ValidatedModel";
 import { FileContents } from "nlptoolkit-util/dist/FileContents";
 import { Vector } from "nlptoolkit-math/dist/Vector";
 export declare abstract class GaussianModel extends ValidatedModel {
@@ -22,7 +22,25 @@ export declare abstract class GaussianModel extends ValidatedModel {
      * @return The class which has the maximum value of metric.
      */
     predict(instance: Instance): string;
+    /**
+     * Loads the prior probability distribution from an input model file.
+     * @param input Input model file.
+     * @return Prior probability distribution.
+     * @throws IOException If the input file can not be read, the method throws IOException.
+     */
     loadPriorDistribution(input: FileContents): number;
+    /**
+     * Loads hash map of vectors from input model file.
+     * @param input Input model file.
+     * @param size Number of vectors to be read from input model file.
+     * @return Hash map of vectors.
+     * @throws IOException If the input file can not be read, the method throws IOException.
+     */
     loadVectors(input: FileContents, size: number): Map<string, Vector>;
+    /**
+     * Calculates the posterior probability distribution for the given instance according to Gaussian model.
+     * @param instance Instance for which posterior probability distribution is calculated.
+     * @return Posterior probability distribution for the given instance.
+     */
     predictProbability(instance: Instance): Map<string, number>;
 }

package/dist/Model/Parametric/GaussianModel.js

@@ -0,0 +1,95 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GaussianModel = void 0;
+const DiscreteDistribution_1 = require("nlptoolkit-math/dist/DiscreteDistribution");
+const ValidatedModel_1 = require("../ValidatedModel");
+const CompositeInstance_1 = require("../../Instance/CompositeInstance");
+const Vector_1 = require("nlptoolkit-math/dist/Vector");
+class GaussianModel extends ValidatedModel_1.ValidatedModel {
+    priorDistribution;
+    /**
+     * The predict method takes an Instance as an input. First it gets the size of prior distribution and loops this size times.
+     * Then it gets the possible class labels and and calculates metric value. At the end, it returns the class which has the
+     * maximum value of metric.
+     *
+     * @param instance {@link Instance} to predict.
+     * @return The class which has the maximum value of metric.
+     */
+    predict(instance) {
+        let maxMetric = Number.NEGATIVE_INFINITY;
+        let predictedClass, size;
+        if (instance instanceof CompositeInstance_1.CompositeInstance) {
+            predictedClass = instance.getPossibleClassLabels()[0];
+            size = instance.getPossibleClassLabels().length;
+        }
+        else {
+            predictedClass = this.priorDistribution.getMaxItem();
+            size = this.priorDistribution.size;
+        }
+        for (let i = 0; i < size; i++) {
+            let Ci;
+            if (instance instanceof CompositeInstance_1.CompositeInstance) {
+                Ci = instance.getPossibleClassLabels()[i];
+            }
+            else {
+                Ci = this.priorDistribution.getItem(i);
+            }
+            if (this.priorDistribution.containsItem(Ci)) {
+                let metric = this.calculateMetric(instance, Ci);
+                if (metric > maxMetric) {
+                    maxMetric = metric;
+                    predictedClass = Ci;
+                }
+            }
+        }
+        return predictedClass;
+    }
+    /**
+     * Loads the prior probability distribution from an input model file.
+     * @param input Input model file.
+     * @return Prior probability distribution.
+     * @throws IOException If the input file can not be read, the method throws IOException.
+     */
+    loadPriorDistribution(input) {
+        let size = parseInt(input.readLine());
+        this.priorDistribution = new DiscreteDistribution_1.DiscreteDistribution();
+        for (let i = 0; i < size; i++) {
+            let line = input.readLine();
+            let items = line.split(" ");
+            for (let j = 0; j < parseInt(items[1]); j++) {
+                this.priorDistribution.addItem(items[0]);
+            }
+        }
+        return size;
+    }
+    /**
+     * Loads hash map of vectors from input model file.
+     * @param input Input model file.
+     * @param size Number of vectors to be read from input model file.
+     * @return Hash map of vectors.
+     * @throws IOException If the input file can not be read, the method throws IOException.
+     */
+    loadVectors(input, size) {
+        let map = new Map();
+        for (let i = 0; i < size; i++) {
+            let line = input.readLine();
+            let items = line.split(" ");
+            let vector = new Vector_1.Vector(parseInt(items[1]), 0);
+            for (let j = 2; j < items.length; j++) {
+                vector.setValue(j - 2, parseFloat(items[j]));
+            }
+            map.set(items[0], vector);
+        }
+        return map;
+    }
+    /**
+     * Calculates the posterior probability distribution for the given instance according to Gaussian model.
+     * @param instance Instance for which posterior probability distribution is calculated.
+     * @return Posterior probability distribution for the given instance.
+     */
+    predictProbability(instance) {
+        return undefined;
+    }
+}
+exports.GaussianModel = GaussianModel;
+//# sourceMappingURL=GaussianModel.js.map

package/dist/Model/Parametric/GaussianModel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GaussianModel.js","sourceRoot":"","sources":["../../../source/Model/Parametric/GaussianModel.ts"],"names":[],"mappings":";;;AAAA,oFAA+E;AAE/E,sDAAiD;AACjD,wEAAmE;AAEnE,wDAAmD;AAEnD,MAAsB,aAAc,SAAQ,+BAAc;IAE5C,iBAAiB,CAAsB;IAWjD;;;;;;;OAOG;IACH,OAAO,CAAC,QAAkB;QACtB,IAAI,SAAS,GAAG,MAAM,CAAC,iBAAiB,CAAC;QACzC,IAAI,cAAc,EAAE,IAAI,CAAA;QACxB,IAAI,QAAQ,YAAY,qCAAiB,EAAE,CAAC;YACxC,cAAc,GAAwB,QAAS,CAAC,sBAAsB,EAAE,CAAC,CAAC,CAAC,CAAC;YAC5E,IAAI,GAAwB,QAAS,CAAC,sBAAsB,EAAE,CAAC,MAAM,CAAC;QAC1E,CAAC;aAAM,CAAC;YACJ,cAAc,GAAG,IAAI,CAAC,iBAAiB,CAAC,UAAU,EAAE,CAAC;YACrD,IAAI,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC;QACvC,CAAC;QACD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC;YAC5B,IAAI,EAAE,CAAA;YACN,IAAI,QAAQ,YAAY,qCAAiB,EAAE,CAAC;gBACxC,EAAE,GAAwB,QAAS,CAAC,sBAAsB,EAAE,CAAC,CAAC,CAAC,CAAC;YACpE,CAAC;iBAAM,CAAC;gBACJ,EAAE,GAAG,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YAC3C,CAAC;YACD,IAAI,IAAI,CAAC,iBAAiB,CAAC,YAAY,CAAC,EAAE,CAAC,EAAE,CAAC;gBAC1C,IAAI,MAAM,GAAG,IAAI,CAAC,eAAe,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;gBAChD,IAAI,MAAM,GAAG,SAAS,EAAE,CAAC;oBACrB,SAAS,GAAG,MAAM,CAAC;oBACnB,cAAc,GAAG,EAAE,CAAC;gBACxB,CAAC;YACL,CAAC;QACL,CAAC;QACD,OAAO,cAAc,CAAC;IAC1B,CAAC;IAED;;;;;OAKG;IACH,qBAAqB,CAAC,KAAmB;QACrC,IAAI,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAA;QACrC,IAAI,CAAC,iBAAiB,GAAG,IAAI,2CAAoB,EAAE,CAAA;QACnD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,EAAE,EAAC,CAAC;YAC3B,IAAI,IAAI,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAA;YAC3B,IAAI,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC5B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAC,CAAC;gBACzC,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;YAC5C,CAAC;QACL,CAAC;QACD,OAAO,IAAI,CAAA;IACf,CAAC;IAED;;;;;;OAMG;IACH,WAAW,CAAC,KAAmB,EAAE,IAAY;QACzC,IAAI,GAAG,GAAG,IAAI,GAAG,EAAkB,CAAA;QACnC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,EAAE,EAAC,CAAC;YAC3B,IAAI,IAAI,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAA;YAC3B,IAAI,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;YAC3B,IAAI,MAAM,GAAG,IAAI,eAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;YAC9C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAC,CAAC;gBACnC,MAAM,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;YAChD,CAAC;YACD,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAA;QAC7B,CAAC;QACD,OAAO,GAAG,CAAA;IACd,CAAC;IAED;;;;OAIG;IACH,kBAAkB,CAAC,QAAkB;QACjC,OAAO,SAAS,CAAC;IACrB,CAAC;CACJ;AAjGD,sCAiGC"}

package/dist/Model/Parametric/KMeansModel.d.ts

@@ -0,0 +1,36 @@
+import { GaussianModel } from "./GaussianModel";
+import { InstanceList } from "../../InstanceList/InstanceList";
+import { Instance } from "../../Instance/Instance";
+import { Parameter } from "../../Parameter/Parameter";
+export declare class KMeansModel extends GaussianModel {
+    private classMeans;
+    private distanceMetric;
+    /**
+     * Loads a K-means model from an input model file.
+     * @param fileName Model file name.
+     */
+    constructor2(fileName: string): void;
+    /**
+     * The calculateMetric method takes an {@link Instance} and a String as inputs. It loops through the class means, if
+     * the corresponding class label is same as the given String it returns the negated distance between given instance and the
+     * current item of class means. Otherwise it returns the smallest negative number.
+     *
+     * @param instance {@link Instance} input.
+     * @param Ci       String input.
+     * @return The negated distance between given instance and the current item of class means.
+     */
+    calculateMetric(instance: Instance, Ci: string): number;
+    saveTxt(fileName: string): void;
+    /**
+     * Training algorithm for K-Means classifier. K-Means finds the mean of each class for training.
+     *
+     * @param trainSet   Training data given to the algorithm.
+     * @param parameters distanceMetric: distance metric used to calculate the distance between two instances.
+     */
+    train(trainSet: InstanceList, parameters: Parameter): void;
+    /**
+     * Loads the K-means model from an input file.
+     * @param fileName File name of the K-means model.
+     */
+    loadModel(fileName: string): void;
+}