@dra2020/district-analytics 15.6.0 → 16.0.1

package/dist/district-analytics.js

@@ -54,6 +54,7 @@ const minority_1 = __webpack_require__(/*! ./minority */ "./src/minority.ts");
 const D = __importStar(__webpack_require__(/*! ./_data */ "./src/_data.ts"));
 const M = __importStar(__webpack_require__(/*! ./minority */ "./src/minority.ts"));
 const U = __importStar(__webpack_require__(/*! ./utils */ "./src/utils.ts"));
+// MMD - Extended for optional # reps per district
 class AnalyticsSession {
     constructor(SessionRequest) {
         this.legislativeDistricts = false; // 2020
@@ -79,6 +80,17 @@ class AnalyticsSession {
         this.features = new D.Features(this, SessionRequest['data'], this.config['datasets']);
         this.plan = new D.Plan(this, SessionRequest['plan']);
         this.districts = new D.Districts(this, SessionRequest['districtShapes']);
+        // MMD - Validate & handle optional # reps per district
+        const repsByDistrictt = SessionRequest['repsByDistrictt'];
+        const nDistricts = this.state.nDistricts;
+        if (repsByDistrictt !== undefined) {
+            if (repsByDistrictt.length != nDistricts)
+                throw new Error("Mismatched #'s of districts passed to AnalyticsSession constructor!");
+            if (repsByDistrictt.includes(0))
+                throw new Error("Zero reps for a district passed to AnalyticsSession constructor!");
+            // Assume a positive integer # of reps per district
+            this.repsByDistrictt = SessionRequest['repsByDistrictt'];
+        }
     }
     processConfig(config) {
         // Default the Census & redistricting cycle to 2010
@@ -135,7 +147,7 @@ class AnalyticsSession {
             let popDevPct = this.districts.table.popDevPct;
             let totalVAP = this.districts.table.totalVAP;
             const summaryRow = this.districts.numberOfRows() - 1;
-            totalPop[summaryRow] = this._profile.population.targetSize;
+            totalPop[summaryRow] = this._profile.population.targetSize; // MMD - This is generalized when the profile is created.
             popDevPct[summaryRow] = popDev;
             totalVAP[summaryRow] = Math.round(totalVAP[summaryRow] / this._profile.nDistricts);
             // Added w/ new scorecard
@@ -333,8 +345,8 @@ class Districts {
             return null;
     }
     setGeoProperties(i, p) { this._geoProperties[i] = p; }
-    // +1 for dummy unassigned 0 "district" and +1 for N+1 summary "district" for
-    // state-level values. Real districts are 1–N.
+    // +1 for dummy unassigned 0 "district" and +1 for N+1 summary "district" for state-level values. 
+    // Real districts are 1–N.
     numberOfRows() { return this._session.state.nDistricts + 2; }
     numberOfWorkingDistricts() { return this._session.state.nDistricts + 1; }
     initTable() {
@@ -372,17 +384,24 @@ class Districts {
         };
         return t;
     }
+    // MMD - Generalized district statistics for MMD's
     // This is the workhorse computational routine!
     recalcStatistics(bLog = false) {
         // Initialize debug counters
         nMissingDataset = 0;
         nMissingProperty = 0;
+        // MMD - Generalized targetSize
         // Compute these once per recalc cycle
-        let targetSize = Math.round(this._session.state.totalPop / this._session.state.nDistricts);
-        let deviationThreshold = this._session.populationDeviationThreshold();
+        const nDistricts = this._session.state.nDistricts;
+        const repsByDistrictt = this._session.repsByDistrictt;
+        const nReps = this._session.state.nReps;
+        const stateTotal = this._session.state.totalPop;
+        const targetSize = this._session.state.targetSize;
+        // const targetSize = Math.round(this._session.state.totalPop / this._session.state.nDistricts);
+        const deviationThreshold = this._session.populationDeviationThreshold();
         // let planByDistrict = this._session.plan.byDistrictID();
-        let plan = this._session.plan;
-        let graph = this._session.graph;
+        const plan = this._session.plan;
+        const graph = this._session.graph;
         // Add an extra 0th virtual county bucket for county-district splitting analysis 
         let nCountyBuckets = this._session.counties.nCounties + 1;
         // INITIALIZE STATE VALUES THAT WILL BE ACCUMULATED
@@ -440,80 +459,87 @@ class Districts {
                 bNotEmpty = true;
                 // ... loop over the geoIDs creating district-by-district statistics 
                 geoIDs.forEach(function (geoID) {
-                    // Skip water-only features
-                    if (!(U.isWaterOnly(geoID))) {
-                        // Map from geoID to feature index
-                        let featureID = outerThis._session.features.featureID(geoID);
-                        let f = outerThis._session.features.featureByIndex(featureID);
-                        if (f == undefined) {
-                            if (bLog)
-                                console.log("Statistics: Skipping undefined feature in district statistics: GEOID =", geoID, "Feature ID =", featureID);
+                    // 01-04-22 -- Removed water-only guard
+                    // // Skip water-only features
+                    // if (!(U.isWaterOnly(geoID)))
+                    // {
+                    // Map from geoID to feature index
+                    let featureID = outerThis._session.features.featureID(geoID);
+                    let f = outerThis._session.features.featureByIndex(featureID);
+                    if (f == undefined) {
+                        if (bLog)
+                            console.log("Statistics: Skipping undefined feature in district statistics: GEOID =", geoID, "Feature ID =", featureID);
+                    }
+                    else {
+                        // ACCUMULATE VALUES
+                        // Total population of each feature
+                        // NOTE - This result is used more than once
+                        // 03-27-21
+                        const dkCENSUS = outerThis._session.features._keys["CENSUS" /* CENSUS */];
+                        featurePop = fieldForFeature(f, dkCENSUS, 0 /* TotalPop */);
+                        // featurePop = outerThis._session.features.fieldForFeature(f, T.Dataset.CENSUS, T.FeatureField.TotalPop);
+                        // Total district population
+                        totalPop += featurePop;
+                        // Ignore features when the county is unrecognized
+                        const countyFIPS = U.parseGeoID(geoID)['county'];
+                        if (U.keyExists(countyFIPS, outerThis._session.counties.index)) {
+                            // Total population by counties w/in a district,
+                            // except the dummy unassigned district 0
+                            if (i > 0)
+                                countySplits[outerThis.getCountyIndex(geoID)] += featurePop;
                         }
                         else {
-                            // ACCUMULATE VALUES
-                            // Total population of each feature
-                            // NOTE - This result is used more than once
-                            // 03-27-21
-                            const dkCENSUS = outerThis._session.features._keys["CENSUS" /* CENSUS */];
-                            featurePop = fieldForFeature(f, dkCENSUS, 0 /* TotalPop */);
-                            // featurePop = outerThis._session.features.fieldForFeature(f, T.Dataset.CENSUS, T.FeatureField.TotalPop);
-                            // Total district population
-                            totalPop += featurePop;
-                            // Ignore features when the county is unrecognized
-                            const countyFIPS = U.parseGeoID(geoID)['county'];
-                            if (U.keyExists(countyFIPS, outerThis._session.counties.index)) {
-                                // Total population by counties w/in a district,
-                                // except the dummy unassigned district 0
-                                if (i > 0)
-                                    countySplits[outerThis.getCountyIndex(geoID)] += featurePop;
-                            }
-                            else {
-                                if (bLog)
-                                    console.log("Statistics: County not recognized:", geoID);
-                            }
-                            // Democratic and Republican vote totals
-                            // 10-22-2020 - Added Other votes
-                            // 10-24-2020 - Added guard against inconsistent election data
-                            // 03-27-2021
-                            const dkELECTION = outerThis._session.features._keys["ELECTION" /* ELECTION */];
-                            const featureDem = fieldForFeature(f, dkELECTION, 7 /* DemVotes */);
-                            // const featureDem = outerThis._session.features.fieldForFeature(f, T.Dataset.ELECTION, T.FeatureField.DemVotes);
-                            const featureRep = fieldForFeature(f, dkELECTION, 8 /* RepVotes */);
-                            const featureTot = fieldForFeature(f, dkELECTION, 9 /* TotalVotes */);
-                            demVotes += featureDem;
-                            repVotes += featureRep;
-                            totVotes += featureTot;
-                            // NOTE: Unless you grab the values above before accumulating them,
-                            //   you can't accumulate othVotes for districts. You must calculate
-                            //   them by implication later.
-                            if (bLog) {
-                                const bBadElection = (featureDem + featureRep > featureTot) ? true : false;
-                                if (bBadElection)
-                                    console.log("Statistics: Inconsistent election data for precinct:", geoID, featureDem, featureRep, featureTot);
-                            }
-                            // Voting-age demographic breakdowns (or citizen voting-age)
-                            // 03-27-21
-                            const dkVAP = outerThis._session.features._keys["VAP" /* VAP */];
-                            totalVAP += fieldForFeature(f, dkVAP, 0 /* TotalPop */);
-                            // totalVAP += outerThis._session.features.fieldForFeature(f, T.Dataset.VAP, T.FeatureField.TotalPop);
-                            whitePop += fieldForFeature(f, dkVAP, 1 /* WhitePop */);
-                            blackPop += fieldForFeature(f, dkVAP, 2 /* BlackPop */);
-                            hispanicPop += fieldForFeature(f, dkVAP, 3 /* HispanicPop */);
-                            pacificPop += fieldForFeature(f, dkVAP, 5 /* PacificPop */);
-                            asianPop += fieldForFeature(f, dkVAP, 4 /* AsianPop */);
-                            nativePop += fieldForFeature(f, dkVAP, 6 /* NativePop */);
+                            if (bLog)
+                                console.log("Statistics: County not recognized:", geoID);
                         }
+                        // Democratic and Republican vote totals
+                        // 10-22-2020 - Added Other votes
+                        // 10-24-2020 - Added guard against inconsistent election data
+                        // 03-27-2021
+                        const dkELECTION = outerThis._session.features._keys["ELECTION" /* ELECTION */];
+                        const featureDem = fieldForFeature(f, dkELECTION, 7 /* DemVotes */);
+                        // const featureDem = outerThis._session.features.fieldForFeature(f, T.Dataset.ELECTION, T.FeatureField.DemVotes);
+                        const featureRep = fieldForFeature(f, dkELECTION, 8 /* RepVotes */);
+                        const featureTot = fieldForFeature(f, dkELECTION, 9 /* TotalVotes */);
+                        demVotes += featureDem;
+                        repVotes += featureRep;
+                        totVotes += featureTot;
+                        // NOTE: Unless you grab the values above before accumulating them,
+                        //   you can't accumulate othVotes for districts. You must calculate
+                        //   them by implication later.
+                        if (bLog) {
+                            const bBadElection = (featureDem + featureRep > featureTot) ? true : false;
+                            if (bBadElection)
+                                console.log("Statistics: Inconsistent election data for precinct:", geoID, featureDem, featureRep, featureTot);
+                        }
+                        // Voting-age demographic breakdowns (or citizen voting-age)
+                        // 03-27-21
+                        const dkVAP = outerThis._session.features._keys["VAP" /* VAP */];
+                        totalVAP += fieldForFeature(f, dkVAP, 0 /* TotalPop */);
+                        // totalVAP += outerThis._session.features.fieldForFeature(f, T.Dataset.VAP, T.FeatureField.TotalPop);
+                        whitePop += fieldForFeature(f, dkVAP, 1 /* WhitePop */);
+                        blackPop += fieldForFeature(f, dkVAP, 2 /* BlackPop */);
+                        hispanicPop += fieldForFeature(f, dkVAP, 3 /* HispanicPop */);
+                        pacificPop += fieldForFeature(f, dkVAP, 5 /* PacificPop */);
+                        asianPop += fieldForFeature(f, dkVAP, 4 /* AsianPop */);
+                        nativePop += fieldForFeature(f, dkVAP, 6 /* NativePop */);
                     }
-                    else {
-                        if (bLog)
-                            console.log("Statistics: Skipping water-only feature in district statistics:", geoID);
-                    }
+                    // }
+                    // else
+                    // {
+                    //   if (bLog) console.log("Statistics: Skipping water-only feature in district statistics:", geoID);
+                    // }
                 });
                 // COMPUTE DERIVED VALUES
+                // MMD - Generalized the per-district population deviations's for MMD's with variable #'s of reps per district.
+                // - The real districts are indexed 1–N.
+                // - But the # reps per district are indexed from zero.
                 // Population deviation % and equal population (boolean) by district.
                 if (i > 0) {
                     if (totalPop > 0) {
-                        popDevPct = (totalPop - targetSize) / targetSize;
+                        const n = (repsByDistrictt) ? repsByDistrictt[i - 1] : 1; // MMD - # of reps for the district
+                        popDevPct = (totalPop - (n * targetSize)) / (n * targetSize); // MMD
+                        // popDevPct = (totalPop - targetSize) / targetSize;
                         bEqualPop = (Math.abs(popDevPct) <= deviationThreshold);
                     }
                 }
@@ -998,47 +1024,75 @@ exports.fieldForFeature = fieldForFeature;
 //  f is a direct GeoJSON feature
 //  p is a geoID
 function _getFeatures(f, datasetKey, p) {
-    // Shim to load sample data2.json from disk for command-line scaffolding
-    if (f.properties && f.properties['datasets']) {
-        if (!f.properties['datasets'][datasetKey]) {
-            // Feature is missing the dataset
-            nMissingDataset += 1;
-            // console.log(`${nMissingDataset}: Data ${datasetKey} missing for feature ${f} Returning zero.`);
-            return 0;
+    if (!f.properties || !f.properties.datasets)
+        return 0;
+    if (datasetKey && !f.properties.datasets[datasetKey])
+        return 0;
+    let n = datasetKey ? f.properties.datasets[datasetKey][p] : f.properties[p];
+    return !n || isNaN(n) ? 0 : n;
+}
+/* 01-04-22 -- Replaced with the above
+function _getFeatures(f: any, datasetKey: string, p: string): any
+{
+  // Shim to load sample data2.json from disk for command-line scaffolding
+  if (f.properties && f.properties['datasets'])
+  {
+    if (!f.properties['datasets'][datasetKey])
+    {
+      // Feature is missing the dataset
+      nMissingDataset += 1;
+      // console.log(`${nMissingDataset}: Data ${datasetKey} missing for feature ${f} Returning zero.`);
+
+      return 0;
+    }
+
+    return f.properties['datasets'][datasetKey][p];
+  }
+
+  // NOTE - The fGetW() code from dra-client below here ...
+
+  // Direct property?
+  if (f.properties && f.properties[p] !== undefined)
+  {
+    return f.properties[p];
+  }
+
+  // Joined property?
+  let a: any[] = _fGetJoined(f);
+  if (a)
+  {
+    for (let i: number = 0; i < a.length; i++)
+    {
+      let o: any = a[i];
+      if (!datasetKey)
+      {
+        if (o[p] !== undefined)
+        {
+          return o[p];
         }
-        return f.properties['datasets'][datasetKey][p];
-    }
-    // NOTE - The fGetW() code from dra-client below here ...
-    // Direct property?
-    if (f.properties && f.properties[p] !== undefined) {
-        return f.properties[p];
-    }
-    // Joined property?
-    let a = _fGetJoined(f);
-    if (a) {
-        for (let i = 0; i < a.length; i++) {
-            let o = a[i];
-            if (!datasetKey) {
-                if (o[p] !== undefined) {
-                    return o[p];
-                }
-            }
-            else {
-                if (o['datasets'] && o['datasets'][datasetKey]) {
-                    let v = (o['datasets'][datasetKey][p]);
-                    if ((!(v == null)) && (!(v == undefined))) {
-                        return o['datasets'][datasetKey][p];
-                    }
-                }
-            }
+      }
+      else
+      {
+        if (o['datasets'] && o['datasets'][datasetKey])
+        {
+          let v = (o['datasets'][datasetKey][p]);
+          if ((!(v == null)) && (!(v == undefined)))
+          {
+            return o['datasets'][datasetKey][p];
+          }
         }
+      }
     }
-    // Feature is missing the property
-    nMissingProperty += 1;
-    // console.log(`${nMissingProperty}: ${p} value undefined for ${f.properties['GEOID10']}. Returning zero.`);
-    return 0;
-    // return undefined;
+  }
+
+  // Feature is missing the property
+  nMissingProperty += 1;
+  // console.log(`${nMissingProperty}: ${p} value undefined for ${f.properties['GEOID10']}. Returning zero.`);
+
+  return 0;
+  // return undefined;
 }
+*/
 function _fGetJoined(f) {
     return (f.properties && f.properties.joined) ? f.properties.joined : undefined;
 }
@@ -1065,9 +1119,11 @@ class Counties {
 }
 exports.Counties = Counties;
 // CLASSES TO ORGANIZE AND/OR ABSTRACT OTHER DATA
+// MMD - Extended this for # of reps
 class State {
     constructor(s, xx, n) {
         this.totalPop = 0;
+        this.targetSize = 0; // HACK - Will get set by doPreprocessCensus()
         this.tooBigFIPS = [];
         this.tooBigName = [];
         this.singleCountyDistrictMax = 0;
@@ -1076,6 +1132,7 @@ class State {
         this._session = s;
         this.xx = xx;
         this.nDistricts = n;
+        this.nReps = (s.repsByDistrictt) ? s.repsByDistrictt.reduce((a, b) => a + b, 0) : this.nDistricts; // MMD
     }
 }
 exports.State = State;
@@ -1556,6 +1613,7 @@ function isAShape(poly) {
 //
 Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports.doHasEqualPopulations = void 0;
+// MMD - This generalizes for variable #'s of reps per district.
 // NOTE - This validity check is *derived* and depends on population deviation %
 //   being computed (above) and normalized in test log & scorecard generation.
 function doHasEqualPopulations(s, bLog = false) {
@@ -1563,7 +1621,7 @@ function doHasEqualPopulations(s, bLog = false) {
     // Get the normalized population deviation %
     let popDevTest = s.getTest(4 /* PopulationDeviation */);
     const popDevPct = popDevTest['score'];
-    const popDevNormalized = popDevTest['normalizedScore'];
+    // const popDevNormalized: number = popDevTest['normalizedScore'] as number;
     test['details']['deviation'] = popDevPct;
     test['details']['thresholds'] = popDevTest['details']['scale'];
     // Populate the N+1 summary "district" in district.statistics
@@ -1820,9 +1878,13 @@ function doPreprocessCensus(s, bLog = false) {
         countyTotals[i] = totalByCounty[fipsCode];
     }
     s.counties.totalPopulation = countyTotals;
+    // MMD - Rationalized calculation of target size *per rep*
+    s.state.targetSize = s.state.totalPop / s.state.nReps;
     // ANALYZE THE COUNTIES
+    // MMD - This "these counties must be split" analysis does NOT generalize to heterogenous MMD.
     // 'target_size': 733499, # calc as total / districts
-    let targetSize = Math.round(s.state.totalPop / s.state.nDistricts);
+    const targetSize = s.state.targetSize;
+    // let targetSize = Math.round(s.state.totalPop / s.state.nDistricts);
     // Find counties that are bigger than the target district size.
     // 'too_big' = The counties that are bigger than a district, e.g., ['Mecklenburg', 'Wake']
     // 'too_big_fips' = Their FIPS codes, e.g., ['119', '183']
@@ -2100,12 +2162,15 @@ const U = __importStar(__webpack_require__(/*! ./utils */ "./src/utils.ts"));
 const dra_analytics_1 = __webpack_require__(/*! @dra2020/dra-analytics */ "@dra2020/dra-analytics");
 // PROFILE A PLAN
 const KEEP_DECIMALS = 6;
+// MMD - Added # reps per district to the profile
 function profilePlan(s, bLog = false) {
     const state = s.state.xx;
     const planName = s.title;
     const nDistricts = s.state.nDistricts;
+    const nReps = s.state.nReps; // MMD
     const nCounties = s.counties.nCounties;
-    const targetSize = Math.round(s.state.totalPop / nDistricts);
+    const targetSize = s.state.targetSize; // MMD
+    // const targetSize: number = Math.round(s.state.totalPop / nDistricts);
     const popByDistrict = U.deepCopy(s.districts.table.totalPop.slice(1, -1));
     const geoPropsByDistrict = makeArrayOfGeoProps(s, bLog);
     const splits = makeNakedCxD(s);
@@ -2126,10 +2191,12 @@ function profilePlan(s, bLog = false) {
     }
     const statewideDemographics = getStatewideDemographics(s);
     const demographicsByDistrict = getDemographicsByDistrict(s);
+    // MMD - Extended the profile for # reps per district
     const profile = {
         state: state,
         name: planName,
         nDistricts: nDistricts,
+        repsByDistrict: s.repsByDistrictt,
         nCounties: nCounties,
         bStateLeg: s.legislativeDistricts,
         population: {
@@ -2227,10 +2294,12 @@ function computeMetrics(p, districtShapes, bLog = false) {
     // Calculate county-district splitting metrics ...
     const CxD = p.counties;
     const _sS = dra_analytics_1.Splitting.makeSplittingScorecard(CxD, bLog);
+    // MMD - Add # reps per district to call
     // Calculate population deviation-related metrics ...
     const totPopByDistrict = p.population.byDistrict;
     const targetSize = p.population.targetSize;
-    const _pdS = dra_analytics_1.Equal.makePopulationScorecard(totPopByDistrict, targetSize, bLegislative, bLog);
+    const repsByDistrict = p.repsByDistrict;
+    const _pdS = dra_analytics_1.Equal.makePopulationScorecard(totPopByDistrict, targetSize, bLegislative, repsByDistrict, bLog);
     const details = {};
     // Assemble the pieces into new scorecard
     const scorecard = {