Source: compute/types/typesVotesForGeom.js

  1. import * as typesVoteArrays from './typesVoteArrays.js'
  2. import * as typesVotesForGeomGrid from './typesVotesForGeomGrid.js'
  4. /**
  5.  * @namespace typesVotesForGeom
  6.  */
  7. /**
  8.  * @typedef {typesVotesForGeomGrid.votesForGeomGrid | votesForGeomCells | votesForGeomIntervals | votesForGeomPlurality} votesForGeom
  9.  */
  11. /**
  12.  * @typedef {object} votesForGeomCells - Vote data for just one voter geometry in the form of 2D cells.
  13.  * @property {number[][][]} cells - each cell is a list of points.
  14.  * @property {typesVoteArrays.rankings} rankings - rankings for each cell
  15.  * @property {typesVoteArrays.cansByRankList} cansByRankList - cansByRank for each cell
  16.  * @property {number[]} voteCounts - number of votes for each cell
  17.  * @property {number} totalVotes - total number of votes
  18.  * @memberof typesVotesForGeom
  19.  */
  20. /**
  21.  * @typedef {object} rankingPolygons2D - calculated cells of 2D policy space where voters share the same ranking.
  22.  * @property {number[][][]} cells - each cell is a list of points.
  23.  * @property {typesVoteArrays.rankings} rankings - rankings for each cell
  24.  * @property {typesVoteArrays.cansByRankList} cansByRankList - cansByRank for each cell
  25.  * @memberof typesVotesForGeom
  26.  */
  28. /**
  29.  * @typedef {object} votesForGeomIntervals - Vote data for just one voter geometry in the form of 1D intervals.
  30.  * @property {typesVoteArrays.rankings} rankings - rankings for each interval
  31.  * @property {typesVoteArrays.cansByRankList} cansByRankList - cansByRank for each interval
  32.  * @property {number[]} voteCounts - number of votes for each interval
  33.  * @property {number} totalVotes - total number of votes
  34.  * @property {number[]} intervalBorders - midpoints and two infinity points
  35.  * @memberof typesVotesForGeom
  36.  */
  37. /**
  38.  * @typedef {object} rankingIntervals1D - calculated intervals of 1D policy space where voters share the same ranking.
  39.  * @property {typesVoteArrays.rankings} rankings - rankings for each interval
  40.  * @property {typesVoteArrays.cansByRankList} cansByRankList - cansByRank for each interval
  41.  * @property {number[]} intervalBorders - midpoints and two infinity points
  42.  * @memberof typesVotesForGeom
  43.  */
  45. /**
  46.  * @typedef {object} votesForGeomPlurality - Vote data for just one voter geometry in the form of 1D intervals.
  47.  * @property {number[]} countByCan - The number of plurality votes for a candidate.
  48.  * @property {number} totalVotes - total number of votes
  49.  * @memberof typesVotesForGeom
  50.  */
  52. export default {}