Source: compute/types/typesGeometry.js

  1. import * as geoms from './typesGeoms.js'
  2. import * as typesPoints from './typesPoints.js'
  4. // How exporting types works:
  5. // https://stackoverflow.com/a/73232942
  6. /**
  7.  * @namespace typesGeometry
  8.  */
  9. /**
  10.  * @typedef {object} geometry - geometry for casting votes
  11.  * @property {geoms.canPoints} canPoints
  12.  * @property {geoms.voterGeoms} voterGeoms
  13.  * @property {number} dimensions
  14.  * @property {parties} parties
  15.  * @property {string} [strategySeed]
  16.  * @property {object} [voterStrategyList]
  17.  * @memberof typesGeometry
  18.  */
  20. /**
  21.  * @typedef {object} parties - describes parties each candidate belongs to.
  22.  * @property {number[]} partiesByCan - each candidate has party.
  23.  * @property {number} numParties - total number of parties.
  24.  * @memberof typesGeometry
  25.  */
  27. /**
  28.  * @typedef {object} testGeometry -geometry for casting one vote
  29.  * @property {typesPoints.points} canPoints
  30.  * @property {typesPoints.points} voterPoints
  31.  * @property {number} dimensions
  32.  * @property {parties} parties
  33.  * @memberof typesGeometry
  34.  */
  36. export default {}