@dra2020/dra-analytics 3.3.5 → 4.0.0

package/README.md

@@ -44,6 +44,10 @@ The analytics in DRA include metrics favored by [many scholars](./docs/attributi
 
 A [command-line interface](./docs/cli.md) (CLI) was added in v3.
 
+## Updates
+
+- 12/18/21 -- Added multi-member district (MMD) support to makePopulationScorecard().
+
 ## Build status for master branch
 
 [![CircleCI](https://circleci.com/gh/dra2020/dra-graph.svg?style=svg&circle-token=5c5fdd1ea8b6aa5fc80ec7657b805b3953c58e00)](https://circleci.com/gh/dra2020/dra-analytics)

package/dist/dra-analytics.js

@@ -849,6 +849,7 @@ Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports.makePopulationScorecard = exports.isRoughlyEqual = exports.calcPopulationDeviation = void 0;
 const C = __importStar(__webpack_require__(/*! ../rate/dra-config */ "./lib/rate/dra-config.ts"));
 const U = __importStar(__webpack_require__(/*! ../utils/all */ "./lib/utils/all.ts"));
+// MMD - This is the same for SMD & MMD. It's the calculation of min, max, and target size that differs.
 function calcPopulationDeviation(max, min, targetSize) {
     return (max - min) / targetSize; // Don't trim the result here!
 }
@@ -858,10 +859,35 @@ function isRoughlyEqual(devation, bLegislative) {
     return (devation <= threshold) ? true : false;
 }
 exports.isRoughlyEqual = isRoughlyEqual;
-function makePopulationScorecard(totPopByDistrict, targetSize, bLegislative, bLog = false) {
-    const nonEmptyDistricts = totPopByDistrict.filter(x => x > 0);
+// MMD
+// - Add optional # of reps per district. 
+// - Assume targetSize has been calculated correctly per # of reps not districts.
+// - If it exists, handle the MMD-specific calculations.
+function makePopulationScorecard(totPopByDistrict, targetSize, bLegislative, repsByDistrict, bLog = false) {
+    const nDistricts = totPopByDistrict.length;
+    // MMD - Validate reps per district input
+    if (repsByDistrict) {
+        if (repsByDistrict.length != nDistricts)
+            throw new Error("Mismatched #'s of districts passed to makePopulationScorecard()!");
+        if (repsByDistrict.includes(0))
+            throw new Error("Zero reps for a district passed to makePopulationScorecard()!");
+        // Assume a positive integer # of reps per district
+    }
+    // MMD - Figure out the type of districts, SMD or MMD.
+    const nReps = (repsByDistrict) ? repsByDistrict.reduce((a, b) => a + b, 0) : nDistricts;
+    const bSMD = (!repsByDistrict || (nReps == nDistricts)) ? true : false;
+    // MMD - Generalize populations for non-empty districts
+    // const nonEmptyDistricts = totPopByDistrict.filter(x => x > 0);
+    let popPerRep = U.deepCopy(totPopByDistrict);
+    if (!bSMD && repsByDistrict) {
+        for (let i = 0; i < nDistricts; i += 1) {
+            popPerRep[i] = totPopByDistrict[i] / repsByDistrict[i];
+        }
+    }
+    const nonEmptyDistricts = popPerRep.filter(x => x > 0);
     let min = 0;
     let max = 0;
+    // MMD - This is already generalized, because nonEmptyDistricts is generalized.
     if (nonEmptyDistricts.length > 1) {
         min = U.minArray(nonEmptyDistricts);
         max = U.maxArray(nonEmptyDistricts);
@@ -2883,6 +2909,7 @@ exports.adjustSplittingRating = exports.rateSplittingLegacy = exports.rateDistri
 const C = __importStar(__webpack_require__(/*! ./dra-config */ "./lib/rate/dra-config.ts"));
 const normalize_1 = __webpack_require__(/*! ../rate/normalize */ "./lib/rate/normalize.ts");
 const method_1 = __webpack_require__(/*! ../partisan/method */ "./lib/partisan/method.ts");
+// MMD - This is already generalized, if deviations have been calculated based on # of reps instead of districts.
 // RATE POPULATION DEVIATION
 function ratePopulationDeviation(rawDeviation, bLegislative) {
     const _normalizer = new normalize_1.Normalizer(rawDeviation);