@dra2020/district-analytics 1.0.7 → 1.0.8

package/src/settings.ts

@@ -1,20 +0,0 @@
-//
-// GLOBAL CONSTANTS
-//
-
-// Keep four decimal places for fractions [0–1], i.e.,
-// keep two decimal places for %'s [0–100].
-export const PRECISION: number = 4;
-
-// Normalized scores [0-100]
-export const NORMALIZED_RANGE: number = 100;
-
-// The dummy district ID for features not assigned districts yet
-export const NOT_ASSIGNED: number = 0;
-
-// TODO - Discuss w/ Dave & Terry
-// # of items to report as problematic (e.g., features, districts, etc.)
-export const NUMBER_OF_ITEMS_TO_REPORT: number = 10;
-
-// The virtual geoID for "neighbors" in other states
-export const OUT_OF_STATE: string = "OUT_OF_STATE";

package/src/types.ts

@@ -1,185 +0,0 @@
-//
-// TYPE DEFINITIONS
-//
-
-import * as geojson from 'geojson';
-
-// CONFIGURATION TYPES
-
-// Sets of analytics, to enable them to be turned on/off by the host.
-export const enum Suite {
-  Legal,
-  Fair,
-  Best
-}  // as in "best fair map"
-
-// INPUT DATA TYPES
-
-// The SessionRequest specifies an analytics session
-export type SessionRequest = {
-  title: string;
-  stateXX: string;
-  nDistricts: number;
-  legislativeDistricts: boolean;
-  plan: PlanByGeoID;
-  data: GeoFeatureCollection;
-  districtShapes: GeoFeatureCollection;
-  districtProperties: DistrictProperties;
-  graph: ContiguityGraph;
-  countyNameLookup: FIPSCodeToCountyNameMap;
-  counties: GeoFeatureCollection;
-  config: {}
-}
-
-// A Plan is a dict of geoID-districtID pairs indexed by geoID
-export type PlanByGeoID = {
-  [geoID: string]: number;
-}
-
-// A inverted Plan is a dict of districtID's with associated sets of geoID's
-export type PlanByDistrictID = {
-  // TODO - Terry, why does this constructor need a <T> type specification?
-  [districtID: number]: Set<string>;
-}
-
-// A map of geoIDs to feature IDs
-export type FeaturesByGeoID = {
-  [geoID: string]: number;
-}
-
-// The FIPS-codes-to-county-name map for a state
-export type FIPSCodeToCountyNameMap = {
-  [FIPSCode: string]: string;
-}
-
-// The FIPS to array ordinal map 
-export type FIPSToOrdinalMap = {
-  [FIPSCode: string]: number;
-}
-
-// Shapes - following the declarations in dra-client/redistrictdata.ts
-export type GeoFeature = geojson.Feature;
-export type GeoFeatureArray = GeoFeature[];
-export type GeoFeatureCollection = geojson.FeatureCollection;
-export interface GeoFeatureMap {
-  [geoID: string]: GeoFeature;
-}
-
-
-// Contiguity graph
-// - For each geoID, there's a dictionary of neighbors, and the value for each
-//   neighbor geoID key is the "weight" of that connection.
-// - A simple connectivity matrix used a weight of 1.0. However, the "weight"
-//   can be overloaded with some other information, like the length of the shared
-//   border.
-export type ContiguityGraph = {
-  [geoID: string]: Neighbors;
-}
-
-export type Neighbors = {
-  [geoID: string]: number;
-}
-
-// An election (model) captures three actual or composite vote totals:
-// DEM votes, REP votes, and TOTal votes, where DEM + REP <= TOT, because
-// of third-party candidates and write-in votes. IOW, the two-party vote is
-// DEM + REP.
-export type VoteTriple = [number, number, number];
-
-// An index for accessing a vote triple
-export const enum VoteType {
-  Democratic,
-  Republican,
-  Total
-}
-
-// CONFIGURATION TYPES
-
-// Scale config values for an individual test
-export type TestScale = {
-  testScale: Array<number>,
-  testInvertp: boolean
-}
-
-// The scales for all the analytics & validations
-// Presently assigned as part of session initialization
-// Use the Tests enum below as the test index
-export type TestScales = {
-  [test: number]: TestScale;
-}
-
-
-// RETURN TYPES
-
-export type TestEntry = {
-  score?: number | boolean;             // Specific to the test
-  details: Dict;                        // Additional details
-  normalizedScore?: number;             // Normalized to [0–100] for graded tests
-}
-
-// District WIP captures a district-level result, indexed by districtID
-export type DistrictWIP = {
-  [districtID: number]: any;
-}
-
-// TODO - Revise this ...
-// Analytics & validations
-export const enum Test {
-  Complete,
-  Contiguous,
-  FreeOfHoles,
-  EqualPopulation,      // This is the legal/not legal assessment of the population 
-  PopulationDeviation,  // deviation % (when legal, less is still better).
-  Reock,
-  PolsbyPopper,
-  CountySplits,
-  Complexity,
-  SeatsBias,
-  VotesBias,
-  Responsiveness,
-  ResponsiveDistricts,
-  EfficiencyGap,
-  MajorityMinorityDistricts
-}
-
-// The analytics & validation entries for a plan
-// Use the Tests enum above as the test index
-export type TestEntries = {
-  [test: number]: TestEntry;
-}
-
-// DistrictProperties holds properties of district shapes, indexed by districtID
-export type DistrictProperties = {
-  [districtID: number]: any;
-}
-
-// For compactness calculations, we need 3 properties of each district shape:
-export type DistrictShapeProperties = [number, number, number];
-
-// An index for accessing properties extracted from a district shape
-export const enum DistrictShapeProperty {
-  Area,
-  Diameter,
-  Perimeter
-}
-
-// HELPER TYPES
-
-export type GeoIDParts = {
-  state?: string;
-  county?: string;
-  tract?: string;
-  bg?: string;
-  block?: string;
-}
-
-export type GeoIDTotal = {
-  [geoID: string]: number;
-}
-
-// GENERIC TYPES
-
-export type Dict = { [key: string]: any };
-
-
-// END

package/src/utils.ts

@@ -1,245 +0,0 @@
-//
-// UTILITIES
-//
-
-import * as T from './types'
-import * as S from './settings';
-
-// PLAN HELPERS
-
-// Is a "neighbor" in state?
-export function isInState(geoID: string): boolean {
-  return geoID != S.OUT_OF_STATE;
-}
-
-// Is a "neighbor" out of state?
-export function isOutOfState(geoID: string): boolean {
-  return geoID == S.OUT_OF_STATE;
-}
-
-// Get the districtID to which a geoID is assigned
-export function getDistrict(plan: T.PlanByGeoID, geoID: string): number | undefined {
-  // All geoIDs in a state *should be* assigned to a district (including the
-  // dummy "unassigned" district), but "water-only" features are sometimes missing
-  // from a map. This is also a guard against a bug in which a geoID has no district.
-  if (keyExists(geoID, plan)) {
-    return plan[geoID];
-  }
-  else {
-    return undefined;
-  }
-}
-
-// Invert a feature assignment structure to sets of ids by district
-// NOTE - This is here vs. _data.ts, so it can also be used in cli.ts
-export function invertPlan(plan: T.PlanByGeoID): T.PlanByDistrictID {
-  let invertedPlan = {} as T.PlanByDistrictID;
-
-  // Add a dummy 'unassigned' district
-  invertedPlan[S.NOT_ASSIGNED] = new Set();
-
-  for (let geoID in plan) {
-    let districtID = plan[geoID];
-
-    // Make sure the set for the districtID exists
-    if (!(objectContains(invertedPlan, districtID))) {
-      invertedPlan[districtID] = new Set();
-    }
-
-    // Add the geoID to the districtID's set
-    invertedPlan[districtID].add(geoID);
-  }
-
-  return invertedPlan;
-}
-
-// WORKING WITH GEOIDS
-
-export function parseGeoID(geoID: string): T.GeoIDParts {
-  let parts: T.GeoIDParts = {};
-
-  parts['state'] = geoID.substring(0, 2);
-  parts['county'] = geoID.substring(0, 5);
-
-  let l: number = geoID.length;
-
-  if (l >= 11) {
-    parts['tract'] = geoID.substring(0, 11);
-  }
-
-  if (l >= 12) {
-    parts['bg'] = geoID.substring(0, 12);
-  }
-
-  if (l == 15) {
-    parts['block'] = geoID;
-  }
-
-  return parts;
-}
-
-export function getFIPSFromCountyGeoID(geoID: string): string {
-  return geoID.substring(2, 5);
-}
-
-
-// NORMALIZING RESULTS
-
-// Convert a raw score [0-1] into a normalized score [0-100]
-export function normalize(rawScore: number, scale: Array<number>, invertp: boolean = false): number {
-  // Invert the axis if necessary to make bigger = better
-  if (invertp) {
-    rawScore = 1.0 - rawScore;
-  }
-
-  // Coerce the value to be w/in the given range
-  let rangeMin: number = scale[0];
-  let rangeMax: number = scale[1];
-  let coercedValue = Math.min(Math.max(rawScore, rangeMin), rangeMax);
-
-  // Scale the bounded value w/in the range [0 - (rangeMax - rangeMin)]
-  let scaledValue = (coercedValue - rangeMin) / (rangeMax - rangeMin);
-
-  // Finally, make the range [0-100]
-  return Math.round(scaledValue * S.NORMALIZED_RANGE);
-}
-
-// Round a fractional number [0-1] to the desired level of PRECISION.
-export function trim(fullFraction: number): number {
-  let shiftPlaces = 10 ** S.PRECISION;
-
-  return Math.round(fullFraction * shiftPlaces) / shiftPlaces;
-}
-
-// ARRAY HELPERS
-
-export function sumArray(arr: number[]): number {
-  return arr.reduce((a, b) => a + b, 0);
-}
-
-export function avgArray(arr: number[]): number {
-  return (arr.reduce((a, b) => a + b, 0)) / arr.length;
-}
-
-export function minArray(arr: number[]): number {
-  return Math.min(...arr);
-}
-
-export function maxArray(arr: number[]): number {
-  return Math.max(...arr);
-}
-
-export function initArray(n: number, value: any): any[] {
-  return Array.from(Array(n), () => value);
-}
-
-export function andArray(arr: boolean[]): boolean {
-  return arr.reduce(function (a, b) { return a && b; }, true);
-}
-
-// WORKING WITH OBJECT KEYS/PROPERTIES
-
-// TODO - Terry, is this copesetic?
-// Does an object have a key/property?
-export function keyExists(k: string, o: object): boolean {
-  return k in o;
-}
-
-// TODO - Terry, can these three be combined into a generic isEmpty() check?
-// Does an object (dict) have any keys/properties?
-export function isObjectEmpty(o: object): boolean {
-  return Object.keys(o).length === 0
-}
-// Does a Set have any members?
-export function isSetEmpty(s: any): boolean {
-  return s.size === 0
-}
-// Does an array hold any items?
-export function isArrayEmpty(a: any[]): boolean {
-  if (a === undefined || a.length == 0) {
-    // array empty or does not exist
-    return true;
-  }
-  else {
-    return false;
-  }
-}
-
-// Get the keys for an object
-export function getObjectKeys(o: object): string[] {
-  return Object.keys(o);
-}
-
-// TODO - Convert getNumericObjectKeys() idiom to for..of where possible
-export function getNumericObjectKeys(o: object): number[] {
-  return Object.keys(o).map(Number);
-}
-
-export function getSelectObjectKeys(o: T.Dict, v: any[]): string[] {
-  let selectKeys: string[] = [];
-
-  Object.keys(o).forEach(key => {
-    if (arrayContains(v, o[key])) {
-      selectKeys.push(key);
-    }
-  });
-
-  return selectKeys;
-}
-
-export function arrayContains(a: any[], item: any): boolean {
-  return a.some(x => x === item);
-}
-
-export function objectContains(o: object, key: any): boolean {
-  return (key in o);
-}
-
-
-// ENUM HELPERS
-
-// Source: https://stackoverflow.com/questions/38034673/determine-the-number-of-enum-elements-typescript
-export function countEnumValues(enumName: any): number {
-  let count = 0
-  for (let item in enumName) {
-    if (isNaN(Number(item))) count++
-  }
-  return count
-}
-
-// COPYING - Copied from dra-client/util.ts
-
-export function shallowCopy(src: any): any {
-  if (Array.isArray(src))
-    return src.slice();
-  else if (typeof src === 'object') {
-    let dst: any = {};
-    for (var p in src) if (src.hasOwnProperty(p))
-      dst[p] = src[p];
-    return dst;
-  }
-  else
-    return src;
-}
-
-export function deepCopy(src: any): any {
-  if (Array.isArray(src)) {
-    let dst: any[] = [];
-
-    for (let i: number = 0; i < src.length; i++)
-      dst.push(deepCopy(src[i]));
-    return dst;
-  }
-  else if (typeof src === 'object') {
-    let dst: any = {};
-    for (var p in src) if (src.hasOwnProperty(p))
-      dst[p] = deepCopy(src[p]);
-    return dst;
-  }
-  else
-    return src;
-}
-
-
-// TODO - Terry: What is this the simple explanation of what this thing is doing?
-export { depthof } from '@dra2020/util';