@dra2020/district-analytics 10.0.4 → 10.0.7

package/dist/district-analytics.js

@@ -143,11 +143,6 @@ class AnalyticsSession {
         this.districts = new D.Districts(this, SessionRequest['districtShapes']);
     }
     processConfig(config) {
-        // NOTE - Session settings are required:
-        // - Analytics suites can be defaulted to all with [], but
-        // - Dataset keys must be explicitly specified with 'dataset'
-        // NOTE - Legacy feature: Always calc everything
-        config['suites'] = [0 /* Legal */, 1 /* Fair */, 2 /* Best */];
         // Default the Census & redistricting cycle to 2010
         if (!(U.keyExists('cycle', config)))
             config['cycle'] = 2010;
@@ -230,58 +225,6 @@ class AnalyticsSession {
     //  1. All polygons in a multi-polygon; and
     //  2. All holes in a otherwise cohesive polygon.
     // Note that all non-cohesive features are always simple polygons.
-    /*
-    let i: number, j: number;
-    let nPoly: number = 0;
-    for (i = 0;nPoly == 0 && i < this.cacheDistricts.features.length;i++)
-    {
-      let f = this.cacheDistricts.features[i];
-  
-      if (f.geometry.type === 'MultiPolygon')
-        nPoly += f.geometry.coordinates.length;
-      else if (f.geometry.type === 'Polygon' && f.geometry.coordinates.length)
-        nPoly += (f.geometry.coordinates.length - 1);
-    }
-    if (nPoly)
-    {
-      this.cacheNoncohesive = {type: 'FeatureCollection', features: []};
-      let af: any = this.cacheNoncohesive.features;
-      let oUnique: any = {};
-  
-      // First add discontiguous polygons
-      for (i = 0;i < this.cacheDistricts.features.length;i++)
-      {
-        let f = this.cacheDistricts.features[i];
-  
-        if (f.geometry.type === 'MultiPolygon')
-        {
-          // Push all non-contiguous polygons
-          for (j = 0;j < f.geometry.coordinates.length;j++)
-          {
-            let p: any = f.geometry.coordinates[j];
-            oUnique[Hash.qhash(p[0])] = true;
-            af.push({type: 'Feature', properties: {id: `${af.length + 1}`}, geometry: {type: 'Polygon', coordinates: p}});
-          }
-        }
-      }
-  
-      // Now add unique holes
-      for (i = 0;i < this.cacheDistricts.features.length;i++)
-      {
-        let f = this.cacheDistricts.features[i];
-  
-        if (f.geometry.type === 'Polygon')
-        {
-          // Push all holes from this polygon
-          for (j = 1;j < f.geometry.coordinates.length;j++)
-          {
-            let p: any = f.geometry.coordinates[j];
-            if (oUnique[Hash.qhash(p)] === undefined)
-              af.push({type: 'Feature', properties: {id: `${af.length + 1}`}, geometry: {type: 'Polygon', coordinates: [p]}});
-          }
-        }
-      }
-    } */
     // HELPERS USED INTERNALLY
     // Get an individual test, so you can drive UI with the results.
     getTest(testID) {
@@ -1056,12 +999,11 @@ function doAnalyzePlan(s, bLog = false) {
     s.bPostProcessingDone = false;
 }
 exports.doAnalyzePlan = doAnalyzePlan;
+//
 // Derive secondary analytics that are based on primary tests.
 // This concept allows Population Deviation to be a primary numeric test and
 // Equal Population to be secondary pass/fail validation.
 //
-// NOTE - Should this be conditionalized on the test suites requested? 
-//   Those are encapsulated in reports.ts right now, so not doing that.
 function doDeriveSecondaryTests(s, bLog = false) {
     s.tests[3 /* EqualPopulation */] = equal_1.doHasEqualPopulations(s, bLog);
 }
@@ -1265,14 +1207,12 @@ const Poly = __importStar(__webpack_require__(/*! @dra2020/poly */ "@dra2020/pol
 const Compactness = __importStar(__webpack_require__(/*! @dra2020/compactness */ "@dra2020/compactness"));
 const U = __importStar(__webpack_require__(/*! ./utils */ "./src/utils.ts"));
 // HELPER TO EXTRACT PROPERTIES OF DISTRICT SHAPES
-// TODO - Create an array, as opposed to a dict
 function extractDistrictProperties(s, bLog = false) {
     // NOTE - I am assuming that district IDs are integers 1–N
     for (let i = 1; i <= s.state.nDistricts; i++) {
         const poly = s.districts.getDistrictShapeByID(i);
         // Guard against no shape for empty districts AND null shapes
         if (isAShape(poly)) {
-            // TODO - OPTIMIZE: Bundle these calls?
             const area = Poly.polyAreaFlat(poly);
             const perimeter = Poly.polyPerimeterFlat(poly);
             const diameter = Poly.polyDiameterFlat(poly);
@@ -1755,34 +1695,6 @@ function prepareRequirementsChecklist(s, bLog = false) {
     return paRequirements;
 }
 exports.prepareRequirementsChecklist = prepareRequirementsChecklist;
-/* 10-23-2020 - Removed the district statistics sample.
-
-export const sampleDistrictStatistics: DistrictStatistics = {
-  table: [
-    // District 0 is the dummy unassigned district
-    // HACK - Total VAP #'s at the end are just so the same matches the type
-    [0, 0, 0, null, null, null, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
-    [1, 653133, -0.0950, T.TriState.Green, T.TriState.Red, T.TriState.Green, T.TriState.Green, 0.4177, 0.5823, 0.8631, 0.1369, 0.0734, 0.0360, 0.0009, 0.0235, 0.0064, 50000],
-    [2, 620961, -0.1396, T.TriState.Green, T.TriState.Red, T.TriState.Red, T.TriState.Green, 0.8820, 0.1180, 0.3129, 0.6871, 0.6169, 0.0391, 0.0013, 0.0310, 0.0099, 50000],
-    [3, 971777, 0.3465, T.TriState.Green, T.TriState.Red, T.TriState.Green, T.TriState.Green, 0.7261, 0.2739, 0.5174, 0.4826, 0.1745, 0.1572, 0.0020, 0.1531, 0.0090, 50000],
-    [4, 863420, 0.1964, T.TriState.Green, T.TriState.Red, T.TriState.Green, T.TriState.Green, 0.8957, 0.1043, 0.1734, 0.8266, 0.6489, 0.1348, 0.0020, 0.0496, 0.0127, 50000],
-    [5, 805029, 0.1155, T.TriState.Green, T.TriState.Red, T.TriState.Green, T.TriState.Yellow, 0.5743, 0.4257, 0.6587, 0.3413, 0.2494, 0.0363, 0.0012, 0.0536, 0.0081, 50000],
-    [6, 824741, 0.1428, T.TriState.Green, T.TriState.Red, T.TriState.Green, T.TriState.Red, 0.5341, 0.4659, 0.7045, 0.2955, 0.1619, 0.0526, 0.0018, 0.0782, 0.0090, 50000],
-    [7, 549714, -0.2383, T.TriState.Green, T.TriState.Green, T.TriState.Green, T.TriState.Green, 0.5025, 0.4975, 0.6906, 0.3094, 0.2468, 0.0319, 0.0013, 0.0258, 0.0111, 50000],
-    [8, 484777, -0.3283, T.TriState.Green, T.TriState.Green, T.TriState.Green, T.TriState.Green, 0.4105, 0.5895, 0.8370, 0.1630, 0.1074, 0.0316, 0.0013, 0.0197, 0.0077, 50000],
-    // District N+1 is the dummy state-summary district
-    [9, 721694, 0.6748, T.TriState.Green, T.TriState.Red, T.TriState.Red, T.TriState.Red, 0.6293, 0.3707, 0.5722, 0.4278, 0.2925, 0.0729, 0.0015, 0.0618, 0.0093, 400000]
-  ],
-  details: {},
-  datasets: {
-    shapes: "2010 VTD shapes",
-    census: "2010 Census Total Population",
-    vap: "2010 Voting Age Population",
-    election: "2016 Presidential, US Senate, Governor, and AG election results"
-  },
-  resources: {}
-}
-*/
 // Create a DistrictStatistics instance, deep copying the underlying values.
 function prepareDistrictStatistics(s, bLog = false) {
     if (!(s.bPostProcessingDone)) {
@@ -1841,76 +1753,6 @@ function prepareDistrictStatistics(s, bLog = false) {
     return ds;
 }
 exports.prepareDistrictStatistics = prepareDistrictStatistics;
-// META-DATA FOR TESTS/ANALYTICS
-// 
-// NOTE - This structure is a vestige of having created a metadata-driven
-//   scorecard w/in district-analytics at first. It works for creating the
-//   unstyled results structures, so it isn't a high priority to rationalize.
-var TestType;
-(function (TestType) {
-    TestType[TestType["PassFail"] = 0] = "PassFail";
-    TestType[TestType["Percentage"] = 1] = "Percentage";
-    TestType[TestType["Number"] = 2] = "Number";
-})(TestType || (TestType = {}));
-const completeDefn = {
-    ID: 0 /* Complete */,
-    name: "Complete",
-    normalize: false,
-    externalType: TestType.PassFail,
-    suites: [0 /* Legal */]
-};
-const contiguousDefn = {
-    ID: 1 /* Contiguous */,
-    name: "Contiguous",
-    normalize: false,
-    externalType: TestType.PassFail,
-    suites: [0 /* Legal */]
-};
-const freeOfHolesDefn = {
-    ID: 2 /* FreeOfHoles */,
-    name: "Free of Holes",
-    normalize: false,
-    externalType: TestType.PassFail,
-    suites: [0 /* Legal */]
-};
-const equalPopulationDefn = {
-    ID: 3 /* EqualPopulation */,
-    name: "Equal Population",
-    normalize: false,
-    externalType: TestType.PassFail,
-    suites: [0 /* Legal */]
-};
-const populationDeviationDefn = {
-    ID: 4 /* PopulationDeviation */,
-    name: "Population Deviation",
-    normalize: true,
-    externalType: TestType.Percentage,
-    suites: [0 /* Legal */, 2 /* Best */] // Both so EqualPopulation can be assessed
-};
-const unexpectedCountySplitsDefn = {
-    ID: 5 /* UnexpectedCountySplits */,
-    name: "Unexpected County Splits",
-    normalize: false,
-    externalType: TestType.Percentage,
-    suites: [2 /* Best */]
-};
-const VTDSplitsDefn = {
-    ID: 6 /* VTDSplits */,
-    name: "VTD Splits",
-    normalize: false,
-    externalType: TestType.Number,
-    suites: [2 /* Best */]
-};
-// All the tests that have been defined (can be reported on)
-const testDefns = {
-    [0 /* Complete */]: completeDefn,
-    [1 /* Contiguous */]: contiguousDefn,
-    [2 /* FreeOfHoles */]: freeOfHolesDefn,
-    [3 /* EqualPopulation */]: equalPopulationDefn,
-    [4 /* PopulationDeviation */]: populationDeviationDefn,
-    [5 /* UnexpectedCountySplits */]: unexpectedCountySplitsDefn,
-    [6 /* VTDSplits */]: VTDSplitsDefn,
-};
 // Postprocess analytics - Normalize numeric results and derive secondary tests.
 // Do this after analytics have been run and before preparing a test log or scorecard. 
 function doAnalyzePostProcessing(s, bLog = false) {
@@ -2148,7 +1990,6 @@ exports.PRECISION = 4;
 exports.NORMALIZED_RANGE = 100;
 // The dummy district ID for features not assigned districts yet
 exports.NOT_ASSIGNED = 0;
-// TODO - DASHBOARD: Discuss w/ Dave
 // # of items to report as problematic (e.g., features, districts, etc.)
 exports.NUMBER_OF_ITEMS_TO_REPORT = 10;
 // The virtual geoID for "neighbors" in other states
@@ -2282,28 +2123,6 @@ function isUninhabited(geoID, s) {
     return bUninhabited;
 }
 exports.isUninhabited = isUninhabited;
-// NORMALIZING RESULTS
-function normalize(rawScore, testScale) {
-    let rangeMin = testScale.scale[0];
-    let rangeMax = testScale.scale[1];
-    // Invert the raw value if necessary to make bigger = better
-    // TODO - This works for Population Deviation, because the max is 1.0.
-    //   Generalize this???
-    if (testScale.bInvertRaw) {
-        rawScore = 1.0 - rawScore;
-    }
-    // Coerce the value to be w/in the given range
-    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);
-    // Invert the scaled value if necessary to make bigger = better
-    if (testScale.bInvertScaled) {
-        scaledValue = 1.0 - scaledValue;
-    }
-    // Finally, make the range [0-100]
-    return Math.round(scaledValue * S.NORMALIZED_RANGE);
-}
-exports.normalize = normalize;
 // Round a fractional number [0-1] to the desired level of PRECISION.
 function trim(fullFraction, digits = undefined) {
     if (digits == 0) {
@@ -2341,14 +2160,11 @@ function andArray(arr) {
 }
 exports.andArray = andArray;
 // WORKING WITH OBJECT KEYS/PROPERTIES
-// TODO - TERRY, is this copesetic?
-// TODO - Handle integer keys?
 // Does an object have a key/property?
 function keyExists(k, o) {
     return k in o;
 }
 exports.keyExists = keyExists;
-// TODO - TERRY, can these three be combined into a generic isEmpty() check?
 // Does an object (dict) have any keys/properties?
 function isObjectEmpty(o) {
     return Object.keys(o).length === 0;
@@ -2375,7 +2191,6 @@ function getObjectKeys(o) {
     return Object.keys(o);
 }
 exports.getObjectKeys = getObjectKeys;
-// TODO - Convert getNumericObjectKeys() idiom to for..of where possible
 function getNumericObjectKeys(o) {
     return Object.keys(o).map(Number);
 }
@@ -2447,7 +2262,6 @@ function mapBooleanToTriState(bool) {
     return (bool) ? 0 /* Green */ : 2 /* Red */;
 }
 exports.mapBooleanToTriState = mapBooleanToTriState;
-// TODO - TERRY: What is this the simple explanation of what this thing is doing?
 var util_1 = __webpack_require__(/*! @dra2020/util */ "@dra2020/util");
 exports.depthof = util_1.depthof;
 
@@ -2593,38 +2407,6 @@ function doIsContiguous(s, bLog = false) {
     return test;
 }
 exports.doIsContiguous = doIsContiguous;
-/* GRAPH - Removed 10/05/2020. Using dra-graph instead.
-// Are the features in a district fully connected?
-export function isConnected(districtGeos: Set<string>, graph: D.Graph): boolean
-{
-  // TODO - TERRY, why does this constructor need a <T> type specification?
-  let visited = new Set<string>();
-  let toProcess: string[] = [];
-
-  // Start processing with the first geoID in the district
-  let iter = districtGeos.values();
-  toProcess.push(iter.next().value);
-
-  // While there are geoIDs in the district that haven't been processed
-  while (toProcess.length > 0)
-  {
-    // Grab a geoID and process it
-    let node = toProcess.pop() as string;
-    visited.add(node);
-
-    // Get its actual, in-state neighbors
-    let actualNeighbors = graph.peerNeighbors(node).filter(x => U.isInState(x));
-
-    // Add neighbors to visit, if they're in the same district Y haven't already been visited
-    let neighborsToVisit = actualNeighbors.filter(x => districtGeos.has(x) && (!visited.has(x)));
-    // TODO - TERRY, is this the quickest/best way to do this?
-    toProcess.push(...neighborsToVisit);
-  }
-
-  // Stop when you've visited all the geoIDs in the district
-  return visited.size == districtGeos.size;
-}
-*/
 //
 // FREE OF HOLES - Are any districts fully embedded w/in another district?
 //
@@ -2635,9 +2417,6 @@ export function isConnected(districtGeos: Set<string>, graph: D.Graph): boolean
 //   To test this, load the NC 2010 map 'SAMPLE-BG-map-hole.csv'. District 1,
 //   Buncombe County (37021), is a donut hole w/in District 3.
 //
-// TODO - OPTIMIZE: This to take advantage of district boundary info, if/when
-//   we cache one to optimize compactness.
-//
 function doIsFreeOfHoles(s, bLog = false) {
     let test = s.getTest(2 /* FreeOfHoles */);
     // Initialize values
@@ -2667,89 +2446,6 @@ function doIsFreeOfHoles(s, bLog = false) {
     return test;
 }
 exports.doIsFreeOfHoles = doIsFreeOfHoles;
-/* GRAPH - Removed 10/05/2020. Using dra-graph instead.
-// Test whether one district is embedded w/in any other.
-export function isEmbedded(districtID: number, geoIDs: Set<string>, plan: D.Plan, graph: D.Graph): boolean
-{
-  // NOTE - "features" here = "geoIDs." These aren't "features" proper, just
-  //   identifier strings.
-  let features = geoIDs;
-  let planByGeo = plan.byGeoID();
-
-  // Assume the district is embedded
-  let bEmbedded = true;
-  // Keep track of the neighoring districts
-  let neighboringDistricts = new Set();
-
-  // TODO - OPTIMIZE: Use just the boundary features, when available
-  // Get the features for the real district
-  let featuresToCheck = Array.from(features);
-
-  // If the district has features, check whether it is embedded
-  if (!(U.isArrayEmpty(featuresToCheck)))
-  {
-    // For each feature that needs to be checked (see above)
-    for (let feature of featuresToCheck)
-    {
-      // Get its neighbors (including the virtual "out of state" ones)
-      let neighbors = graph.peerNeighbors(feature);
-
-      for (let neighbor of neighbors)
-      {
-        if (U.isOutOfState(neighbor))
-        {
-          bEmbedded = false;
-          // No need to check any more neighbors
-          break;
-        }
-        else
-        {
-          let neighboringDistrict = U.getDistrict(planByGeo, neighbor);
-
-          // Assume that a missing district assignment (= None) means that the
-          // feature is "water-only" AND part of the state border (vs. internal)
-          // and, therefore, not in the plan/map.
-
-          if (neighboringDistrict == undefined)
-          {
-            bEmbedded = false;
-            // No need to check any more neighbors
-            break;
-          }
-          else
-          {
-            // TODO - OPTIMIZE: Since we're checking *all* features in a district right
-            //   now, not just boundary features and neighbors in other districts,
-            //   prune out the current district. If/when we optimize compactness
-            //   to cache district boundaries (as before in my Python implementation),
-            //   we won't have to guard adding "neighboring" districts in this way.
-            if (neighboringDistrict != districtID)
-            {
-              neighboringDistricts.add(neighboringDistrict);
-            }
-
-            if (neighboringDistricts.size > 1)
-            {
-              bEmbedded = false;
-              // No need to check any more neighbors
-              break;
-            }
-          }
-        }
-      }
-      // If a district is not embedded, there's no need to check anymore
-      // border geos.
-      if (!bEmbedded)
-      {
-        break;
-      }
-    }
-
-  }
-
-  return bEmbedded;
-}
-*/
 
 
 /***/ }),