All files / lib/math vector.js

100% Statements 64/64
89.66% Branches 26/29
100% Functions 19/19
100% Lines 52/52

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219                                                                    24743x 7528x       17215x                       7646x 7646x 52354x   7646x                 2450x                 4938x                 4981x 4981x 35337x                     2489x 2489x 17666x   2489x                     3x 6x     2x 2x 1x   6x                 17190x                 12243x 12243x 1x 4x     12242x 12242x 1x       12241x 101930x     12242x               2449x 2449x 17190x   2449x                 4897x 4897x 4897x 34376x   4897x                 37x                 56x 56x 1x   55x 55x 584x   55x                 37x       42x  
/*
 * Copyright (c) AXA Group Operations Spain S.A.
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
 
/**
 * Class representing a Vector and some of the possible operations.
 */
class Vector {
  /**
   * Constructor of the class
   * @param {Number[] | Vector} elements Elements for initializing the vector.
   * @param {boolean} useClone If true, the input array is cloned. If false, it uses
   *                     the elements input directly by reference.
   */
  constructor(elements, useClone = true) {
    if (useClone) {
      this.elements = elements
        ? (elements.elements || elements).slice()
        : undefined;
    } else {
      this.elements = elements.elements || elements;
    }
  }
 
  /**
   * Creates a new array, where we can say the number of elements, and also the
   * value used for initializing each cell of the array.
   * @param {Number} numElements Number of elements.
   * @param {Number} value Initialization value.
   * @returns {Number[]} Array initialized with the given value at each cell.
   */
  static createArray(numElements, value) {
    const result = [];
    for (let i = 0; i < numElements; i += 1) {
      result.push(value);
    }
    return result;
  }
 
  /**
   * Creates a new array where each element value is 1.
   * @param {Number} numElements Number of elements.
   * @returns {Number[]} Array where each cell is 1.
   */
  static one(numElements) {
    return new Vector(Vector.createArray(numElements, 1));
  }
 
  /**
   * Creates a new array where each element value is 0.
   * @param {Number} numElements Number of elements.
   * @returns {Number[]} Array where each cell is 0.
   */
  static zero(numElements) {
    return new Vector(Vector.createArray(numElements, 0));
  }
 
  /**
   * Iterate every element of the vector, and executed the provided function
   * for each one.
   * @param {Function} fn Function with signature (element, index).
   */
  forEach(fn) {
    const numElements = this.elements.length;
    for (let i = 0; i < numElements; i += 1) {
      fn(this.elements[i], i);
    }
  }
 
  /**
   * Creates a new vector where each element is the element of this vector,
   * but operated by a function.
   * @param {Function} fn Function with signature (element, index).
   * @returns {Vector} New vector result of apply the function to each element.
   */
  map(fn) {
    const result = Vector.zero(this.elements.length);
    this.forEach((value, i) => {
      result.elements[i] = fn(value, i);
    });
    return result;
  }
 
  /**
   * Run an binary operation over this vector.
   * @param {Number|Number[] | Vector} operand Scalar o vector to operate this with.
   * @param {Fucntion} operator Operator binary function with
   *            signature (operandElement, thisElement, index)
   */
  runOperation(operand, operator) {
    // If operand is an scalar.
    if (typeof operand === 'number') {
      return this.map((v, i) => operator(v, operand, i));
    }
    // If operand is a vector.
    const values = operand.elements || operand;
    if (this.elements.length !== values.length) {
      throw new Error('Cannot operate two vectors with different dimensions.');
    }
    return this.map((v, i) => operator(v, values[i], i));
  }
 
  /**
   * Return a vector where every element is the natural logarithm of the
   * input element.
   * @returns {Vector} Result vector.
   */
  log() {
    return this.map(x => Math.log(x));
  }
 
  /**
   * Return a new Vector that is the result of this - value.
   * @param {Vector} value Vector to subtract from this one.
   * @returns {Vector} Result vector that is this - value.
   */
  subtract(value) {
    const elements = [];
    if (typeof value === 'number') {
      for (let i = 0, li = this.elements.length; i < li; i += 1) {
        elements.push(this.elements[i] - value);
      }
    } else {
      const values = value.elements || value;
      if (this.elements.length !== values.length) {
        throw new Error(
          'Cannot operate two vectors with different dimensions.'
        );
      }
      for (let i = 0, li = this.elements.length; i < li; i += 1) {
        elements.push(this.elements[i] - values[i]);
      }
    }
    return new Vector(elements, false);
  }
 
  /**
   * Returns the sum of all the elements of the Vector.
   * @returns {Number} Sum of all the vector elements.
   */
  sum() {
    let result = 0;
    this.forEach(element => {
      result += element;
    });
    return result;
  }
 
  /**
   * Multiply this vector by the vector provided element by element.
   * @param {Number[] | Vector} value Vector to multiply by this one.
   * @returns {Vector} Vector result of multiplication of both.
   */
  elementMultiply(value) {
    const values = value.elements || value;
    const elements = [];
    for (let i = 0, li = this.elements.length; i < li; i += 1) {
      elements.push(this.elements[i] * values[i]);
    }
    return new Vector(elements, false);
  }
 
  /**
   * Return a new array that is the concatenation of both.
   * @param {Vector | Number[]} values Vector or array to be added.
   * @returns {Vector} Vector that is concat of this with values.
   */
  augment(values) {
    return new Vector(this.elements.concat(values.elements || values), false);
  }
 
  /**
   * Calculates the dot product (scalar product) between two vectors.
   * @param {Vector | Number[]} value Vector to be multiplied by this one.
   * @returns {Number} Scalar representing the dot product.
   */
  dot(value) {
    const elements = value.elements || value;
    if (this.elements.length !== elements.length) {
      throw new Error('Cannot operate two vectors with different dimensions.');
    }
    let product = 0;
    for (let i = 0; i < elements.length; i += 1) {
      product += this.elements[i] * elements[i];
    }
    return product;
  }
 
  /**
   * Returns a vector that is a subvector of this from element n.
   * @param {Number} n Position of the chomp.
   * @returns {Vector} Vector that is subvector of this from element n.
   */
  chomp(n) {
    return new Vector(this.elements.slice(n), false);
  }
}
 
module.exports = Vector;