Source: compute/types/typesGeoms.js

  1. /**
  2.  * @namespace typesGeoms
  3.  */
  4. /**
  5.  * @typedef {canPoint1D[] | canPoint2D[]} canPoints - geometries for a number of candidates.
  6.  * For 2D, an array of objects: {x,y}. For 1D, an array of objects: {x}.
  7.  * @memberof typesGeoms
  8.  */
  9. /**
  10.  * @typedef {voterGeom1D[] | voterGeom2D[]} voterGeoms - geometries for a number of voters
  11.  * @memberof typesGeoms
  12.  */
  13. /**
  14.  * @typedef {voterGeom1D | voterGeom2D} voterGeom - geometries for a number of voters
  15.  * @memberof typesGeoms
  16.  */
  17. /**
  18.  * @typedef {number} canPoint1D - the point where a candidate sits in 1D - x position
  19.  * @memberof typesGeoms
  20.  */
  21. /**
  22.  * @typedef {number[]} canPoint2D - the point where a candidate sits in 2D- [x,y] position
  23.  * @memberof typesGeoms
  24.  */
  25. /**
  26.  * @typedef {object} voterGeom1D - the geometry of a voter distribution in 1D
  27.  * @property {number} x - x position
  28.  * @property {number} w - width
  29.  * @property {String} densityProfile - how voters are spread in policy space
  30.  * @memberof typesGeoms
  31.  */
  32. /**
  33.  * @typedef {object} voterGeom2D - the geometry of a voter distribution in 2D
  34.  * @property {number} x - x position
  35.  * @property {number} y - y position
  36.  * @property {number} w - width
  37.  * @property {String} densityProfile - how voters are spread in policy space
  38.  * @memberof typesGeoms
  39.  */
  41. export default {}