Source: compute/types/typesGrid.js

  1. import * as typesGeoms from './typesGeoms.js'
  2. import * as typesPoints from './typesPoints.js'
  4. /**
  5.  * @namespace typesGrid
  6.  */
  7. /**
  8.  * @typedef {grid1D | grid2D} grid - data for points on a grid
  9.  */
  10. /**
  11.  * @typedef {object} grid1D - data for points on a 1D grid
  12.  * @property {number[]} x - x coordinates for grid points
  13.  * @property {number[]} density - density for grid points
  14.  * @property {typesPoints.point1D[]} voterPoints - grid points in point1D format
  15.  * @property {number[]} voteCounts - voteCount for each grid point
  16.  * @property {number} totalVotes - total number of votes
  17.  * @property {typesGeoms.voterGeom1D} voterGeom - the geometry of a voter distribution in 1D
  18.  * @memberof typesGrid
  19.  */
  20. /**
  21. * @typedef {object} gridX
  22. * @property {number[]} gridX - x coordinates for grid points
  23. * @property {typesPoints.point1D[]} voterPoints - grid points in point1D format
  24. * @property {number} gridPointLength - size of grid point's region in policy space. density * length = count.
  25.  * @memberof typesGrid
  26.  */
  28. /**
  29.  * @typedef {object} grid2D - data for points on a 2D grid
  30.  * @property {number[]} x - x coordinates for grid points
  31.  * @property {number[]} y - y coordinates for grid points
  32.  * @property {number[]} density - density for grid points
  33.  * @property {number[]} voteCounts - voteCount for each grid point
  34.  * @property {number} totalVotes - total number of votes
  35.  * @property {number} nx - number of x coordinates
  36.  * @property {number} ny - number of y coordinates
  37.  * @property {number} width - width and height of grid in pixels. grid is square.
  38.  * @property {typesPoints.point2D[]} voterPoints - grid points in point2D format
  39.  * @property {typesGeoms.voterGeom2D} voterGeom - the geometry of a voter distribution in 2D
  40.  * @memberof typesGrid
  41.  */
  43. export default {}