@dra2020/district-analytics 1.0.1 → 1.0.4

package/dist/src/_api.d.ts

@@ -0,0 +1,27 @@
+import { Scorecard } from './report';
+import * as D from './_data';
+import * as T from './types';
+export declare class AnalyticsSession {
+    title: string;
+    legislativeDistricts: boolean;
+    config: T.Dict;
+    bOneTimeProcessingDone: boolean;
+    bPlanAnalyzed: boolean;
+    bPostProcessingDone: boolean;
+    testScales: T.TestScales;
+    tests: T.TestEntries;
+    scorecard: Scorecard;
+    state: D.State;
+    counties: D.Counties;
+    graph: D.Graph;
+    features: D.Features;
+    plan: D.Plan;
+    districts: D.Districts;
+    constructor(SessionRequest: T.SessionRequest);
+    processConfig(config: T.Dict): T.Dict;
+    analyzePlan(bLog?: boolean): boolean;
+    getTest(testID: T.Test): T.TestEntry;
+    prepareScorecard(): any;
+    prepareTestLog(): any;
+    populationDeviationThreshold(): number;
+}

package/dist/src/_data.d.ts

@@ -0,0 +1,130 @@
+import * as T from './types';
+import { AnalyticsSession } from './_api';
+export declare enum DistrictField {
+    TotalPop = 0,
+    PopDevPct = 1,
+    bEqualPop = 2,
+    bNotEmpty = 3,
+    bContiguous = 4,
+    bNotEmbedded = 5,
+    CountySplits = 6,
+    DemVotes = 7,
+    RepVotes = 8,
+    TwoPartyVote = 9,
+    DemPct = 10,
+    RepPct = 11,
+    DemSeat = 12,
+    TotalVAP = 13,
+    MinorityPop = 14,
+    WhitePop = 15,
+    BlackPop = 16,
+    HispanicPop = 17,
+    PacificPop = 18,
+    AsianPop = 19,
+    NativePop = 20,
+    WhitePct = 21,
+    MinorityPct = 22,
+    BlackPct = 23,
+    HispanicPct = 24,
+    PacificPct = 25,
+    AsianPct = 26,
+    NativePct = 27
+}
+export declare const DisplayFields: DistrictField[];
+export declare class Districts {
+    _session: AnalyticsSession;
+    _shapes: T.GeoFeatureCollection;
+    _geoProperties: T.DistrictProperties;
+    statistics: any[][];
+    constructor(s: AnalyticsSession, ds: T.GeoFeatureCollection);
+    getShape(i: number): T.GeoFeature;
+    getGeoProperties(i: number): any;
+    setGeoProperties(i: number, p: T.DistrictShapeProperties): void;
+    numberOfColumns(): number;
+    numberOfRows(): number;
+    numberOfWorkingDistricts(): number;
+    initStatistics(): any[][];
+    recalcStatistics(bLog?: boolean): void;
+    extractDistrictShapeProperties(bLog?: boolean): void;
+    getCountyIndex(geoID: string): number;
+}
+export declare const enum Dataset {
+    CENSUS = "CENSUS",
+    VAP = "VAP",
+    ELECTION = "ELECTION"
+}
+export declare type DatasetKeys = {
+    CENSUS: string;
+    VAP: string;
+    ELECTION: string;
+};
+export declare const DatasetDescriptions: any;
+export declare const enum FeatureField {
+    TotalPop = "Tot",
+    WhitePop = "Wh",
+    BlackPop = "BlC",
+    HispanicPop = "His",
+    AsianPop = "AsnC",
+    PacificPop = "PacC",
+    NativePop = "NatC",
+    DemVotes = "D",
+    RepVotes = "R",
+    TotalVotes = "Tot"
+}
+export declare class Features {
+    _session: AnalyticsSession;
+    _data: T.GeoFeatureCollection;
+    _keys: DatasetKeys;
+    _featureIDs: T.FeaturesByGeoID;
+    constructor(s: AnalyticsSession, data: T.GeoFeatureCollection, keys: DatasetKeys);
+    nFeatures(): number;
+    featureByIndex(i: number): T.GeoFeature;
+    geoIDForFeature(f: any): string;
+    fieldForFeature(f: any, dt: Dataset, fk: string): any;
+    resetDataset(d: Dataset, k: string): void;
+    mapGeoIDsToFeatureIDs(): void;
+    featureID(i: string): number;
+}
+export declare class Counties {
+    _session: AnalyticsSession;
+    _data: T.GeoFeatureCollection;
+    _countyNameLookup: T.FIPSCodeToCountyNameMap;
+    nCounties: number;
+    index: T.FIPSToOrdinalMap;
+    constructor(s: AnalyticsSession, data: T.GeoFeatureCollection);
+    countyByIndex(i: number): T.GeoFeature;
+    propertyForCounty(f: any, pk: string): any;
+    mapFIPSToName(fips: string, name: string): void;
+    nameFromFIPS(fips: string): string;
+    indexFromFIPS(fips: string): number;
+}
+export declare class State {
+    _session: AnalyticsSession;
+    xx: string;
+    nDistricts: number;
+    totalPop: number;
+    tooBigFIPS: string[];
+    tooBigName: string[];
+    expectedSplits: number;
+    expectedAffected: number;
+    constructor(s: AnalyticsSession, xx: string, n: number);
+}
+export declare class Plan {
+    _session: AnalyticsSession;
+    _planByGeoID: T.PlanByGeoID;
+    _planByDistrictID: T.PlanByDistrictID;
+    districtIDs: number[];
+    constructor(s: AnalyticsSession, p: T.PlanByGeoID);
+    invertPlan(): void;
+    initializeDistrict(i: number): void;
+    byGeoID(): T.PlanByGeoID;
+    byDistrictID(): T.PlanByDistrictID;
+    districtForGeoID(i: string): number;
+    geoIDsForDistrictID(i: number): Set<string>;
+}
+export declare class Graph {
+    _session: AnalyticsSession;
+    _graph: T.ContiguityGraph;
+    constructor(s: AnalyticsSession, graph: T.ContiguityGraph);
+    peerNeighbors(node: string): string[];
+}

package/dist/src/analyze.d.ts

@@ -0,0 +1,4 @@
+import { AnalyticsSession } from './_api';
+export declare function doAnalyzeDistricts(s: AnalyticsSession, bLog?: boolean): void;
+export declare function doAnalyzePlan(s: AnalyticsSession, bLog?: boolean): void;
+export declare function doDeriveSecondaryTests(s: AnalyticsSession): void;

package/dist/src/cohesive.d.ts

@@ -0,0 +1,4 @@
+import * as T from './types';
+import { AnalyticsSession } from './_api';
+export declare function doCountySplits(s: AnalyticsSession): T.TestEntry;
+export declare function doPlanComplexity(s: AnalyticsSession): T.TestEntry;

package/dist/src/compact.d.ts

@@ -0,0 +1,5 @@
+import * as T from './types';
+import { AnalyticsSession } from './_api';
+export declare function doReock(s: AnalyticsSession, bLog?: boolean): T.TestEntry;
+export declare function doPolsbyPopper(s: AnalyticsSession, bLog?: boolean): T.TestEntry;
+export declare function extractDistrictProperties(s: AnalyticsSession, bLog?: boolean): void;

package/dist/src/constants.d.ts

@@ -0,0 +1,6 @@
+export declare const StateXXToName: any;
+export declare const StateRequirements: any;
+export declare const MinorityDemographicDefns: any;
+export declare const VRASection5Preclearance: any;
+export declare const MajorityMinorityDistricts: any;
+export declare const StateMinorityContacts: any;

package/dist/src/equal.d.ts

@@ -0,0 +1,4 @@
+import * as T from './types';
+import { AnalyticsSession } from './_api';
+export declare function doPopulationDeviation(s: AnalyticsSession): T.TestEntry;
+export declare function doHasEqualPopulations(s: AnalyticsSession): T.TestEntry;

package/dist/src/geofeature.d.ts

@@ -0,0 +1,3 @@
+export declare function gfArea(poly: any): number;
+export declare function gfPerimeter(poly: any): number;
+export declare function gfDiameter(poly: any): number;

package/dist/src/index.d.ts

@@ -0,0 +1,2 @@
+export * from './_api';
+export * from './types';

package/dist/src/minority.d.ts

@@ -0,0 +1,3 @@
+import * as T from './types';
+import { AnalyticsSession } from './_api';
+export declare function doMajorityMinorityDistricts(s: AnalyticsSession): T.TestEntry;

package/dist/src/political.d.ts

@@ -0,0 +1,8 @@
+import * as T from './types';
+import { AnalyticsSession } from './_api';
+export declare function doSeatsBias(s: AnalyticsSession): T.TestEntry;
+export declare function doVotesBias(s: AnalyticsSession): T.TestEntry;
+export declare function doResponsiveness(s: AnalyticsSession): T.TestEntry;
+export declare function doResponsiveDistricts(s: AnalyticsSession): T.TestEntry;
+export declare function doEfficiencyGap(s: AnalyticsSession): T.TestEntry;
+export declare function fptpWin(demPct: number): number;

package/dist/src/preprocess.d.ts

@@ -0,0 +1,2 @@
+import { AnalyticsSession } from './_api';
+export declare function doPreprocessData(s: AnalyticsSession): void;

package/dist/src/report.d.ts

@@ -0,0 +1,15 @@
+import * as T from './types';
+import { AnalyticsSession } from './_api';
+export declare type Scorecard = {
+    [category: number]: ScorecardCategoryEntry;
+};
+declare type ScorecardCategoryEntry = {
+    catName: string;
+    catScore?: number | boolean;
+    catTests: T.TestEntries;
+};
+export declare function doConfigureScales(s: AnalyticsSession): void;
+export declare function doAnalyzePostProcessing(s: AnalyticsSession): void;
+export declare function doPrepareScorecard(s: AnalyticsSession): any;
+export declare function doPrepareTestLog(s: AnalyticsSession): any;
+export {};

package/dist/src/settings.d.ts

@@ -0,0 +1,5 @@
+export declare const PRECISION: number;
+export declare const NORMALIZED_RANGE: number;
+export declare const NOT_ASSIGNED: number;
+export declare const NUMBER_OF_ITEMS_TO_REPORT: number;
+export declare const OUT_OF_STATE: string;

package/dist/src/types.d.ts

@@ -0,0 +1,110 @@
+import * as geojson from 'geojson';
+export declare const enum Suite {
+    Legal = 0,
+    Fair = 1,
+    Best = 2
+}
+export declare 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: {};
+};
+export declare type PlanByGeoID = {
+    [geoID: string]: number;
+};
+export declare type PlanByDistrictID = {
+    [districtID: number]: Set<string>;
+};
+export declare type FeaturesByGeoID = {
+    [geoID: string]: number;
+};
+export declare type FIPSCodeToCountyNameMap = {
+    [FIPSCode: string]: string;
+};
+export declare type FIPSToOrdinalMap = {
+    [FIPSCode: string]: number;
+};
+export declare type GeoFeature = geojson.Feature;
+export declare type GeoFeatureArray = GeoFeature[];
+export declare type GeoFeatureCollection = geojson.FeatureCollection;
+export interface GeoFeatureMap {
+    [geoID: string]: GeoFeature;
+}
+export declare type ContiguityGraph = {
+    [geoID: string]: Neighbors;
+};
+export declare type Neighbors = {
+    [geoID: string]: number;
+};
+export declare type VoteTriple = [number, number, number];
+export declare const enum VoteType {
+    Democratic = 0,
+    Republican = 1,
+    Total = 2
+}
+export declare type TestScale = {
+    testScale: Array<number>;
+    testInvertp: boolean;
+};
+export declare type TestScales = {
+    [test: number]: TestScale;
+};
+export declare type TestEntry = {
+    score?: number | boolean;
+    details: Dict;
+    normalizedScore?: number;
+};
+export declare type DistrictWIP = {
+    [districtID: number]: any;
+};
+export declare const enum Test {
+    Complete = 0,
+    Contiguous = 1,
+    FreeOfHoles = 2,
+    EqualPopulation = 3,
+    PopulationDeviation = 4,
+    Reock = 5,
+    PolsbyPopper = 6,
+    CountySplits = 7,
+    Complexity = 8,
+    SeatsBias = 9,
+    VotesBias = 10,
+    Responsiveness = 11,
+    ResponsiveDistricts = 12,
+    EfficiencyGap = 13,
+    MajorityMinorityDistricts = 14
+}
+export declare type TestEntries = {
+    [test: number]: TestEntry;
+};
+export declare type DistrictProperties = {
+    [districtID: number]: any;
+};
+export declare type DistrictShapeProperties = [number, number, number];
+export declare const enum DistrictShapeProperty {
+    Area = 0,
+    Diameter = 1,
+    Perimeter = 2
+}
+export declare type GeoIDParts = {
+    state?: string;
+    county?: string;
+    tract?: string;
+    bg?: string;
+    block?: string;
+};
+export declare type GeoIDTotal = {
+    [geoID: string]: number;
+};
+export declare type Dict = {
+    [key: string]: any;
+};

package/dist/src/utils.d.ts

@@ -0,0 +1,28 @@
+import * as T from './types';
+export declare function isInState(geoID: string): boolean;
+export declare function isOutOfState(geoID: string): boolean;
+export declare function getDistrict(plan: T.PlanByGeoID, geoID: string): number | undefined;
+export declare function invertPlan(plan: T.PlanByGeoID): T.PlanByDistrictID;
+export declare function parseGeoID(geoID: string): T.GeoIDParts;
+export declare function getFIPSFromCountyGeoID(geoID: string): string;
+export declare function normalize(rawScore: number, scale: Array<number>, invertp?: boolean): number;
+export declare function trim(fullFraction: number): number;
+export declare function sumArray(arr: number[]): number;
+export declare function avgArray(arr: number[]): number;
+export declare function minArray(arr: number[]): number;
+export declare function maxArray(arr: number[]): number;
+export declare function initArray(n: number, value: any): any[];
+export declare function andArray(arr: boolean[]): boolean;
+export declare function keyExists(k: string, o: object): boolean;
+export declare function isObjectEmpty(o: object): boolean;
+export declare function isSetEmpty(s: any): boolean;
+export declare function isArrayEmpty(a: any[]): boolean;
+export declare function getObjectKeys(o: object): string[];
+export declare function getNumericObjectKeys(o: object): number[];
+export declare function getSelectObjectKeys(o: T.Dict, v: any[]): string[];
+export declare function arrayContains(a: any[], item: any): boolean;
+export declare function objectContains(o: object, key: any): boolean;
+export declare function countEnumValues(enumName: any): number;
+export declare function shallowCopy(src: any): any;
+export declare function deepCopy(src: any): any;
+export { depthof } from '@dra2020/util';

package/dist/src/valid.d.ts

@@ -0,0 +1,8 @@
+import * as T from './types';
+import * as D from './_data';
+import { AnalyticsSession } from './_api';
+export declare function doIsComplete(s: AnalyticsSession): T.TestEntry;
+export declare function doIsContiguous(s: AnalyticsSession): T.TestEntry;
+export declare function isConnected(districtGeos: Set<string>, graph: D.Graph): boolean;
+export declare function doIsFreeOfHoles(s: AnalyticsSession): T.TestEntry;
+export declare function isEmbedded(districtID: number, geoIDs: Set<string>, plan: D.Plan, graph: D.Graph): boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dra2020/district-analytics",
-  "version": "1.0.1",
+  "version": "1.0.4",
   "description": "District analytics TypeScript package",
   "main": "dist/district-analytics.js",
   "types": "dist/index.d.ts",
@@ -12,22 +12,24 @@
     "prepare": "npm run build",
     "webpack": "node_modules/.bin/webpack"
   },
-  "files": [
-    "lib/**/*"
-  ],
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/alecramsay/district-analytics.git"
+    "url": "git+https://github.com/dra2020/district-analytics.git"
   },
+  "files": [
+    "*/src/*",
+    "*/dist/*.*",
+    "*/dist/*/*.*"
+  ],
   "keywords": [
     "Typescript"
   ],
   "author": "Alec Ramsay",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/alecramsay/district-analytics/issues"
+    "url": "https://github.com/dra2020/district-analytics/issues"
   },
-  "homepage": "https://github.com/alecramsay/district-analytics#readme",
+  "homepage": "https://github.com/dra2020/district-analytics#readme",
   "devDependencies": {
     "@types/geojson": "^7946.0.7",
     "@types/jest": "^24.0.17",