@dra2020/district-analytics 1.0.9 → 1.0.10

package/README.md

@@ -11,7 +11,6 @@ let sr = {} as DA.SessionRequest;
 sr['title'] = "NC 2016 Contingent Corrected Map";
 sr['stateXX'] = "NC";
 sr['nDistricts'] = 13;
-sr['legislativeDistricts'] = false;
 sr['data'] = data as T.GeoFeatureCollection;
 sr['counties'] = counties as T.GeoFeatureCollection;
 sr['graph'] = graph as T.ContiguityGraph;
@@ -19,14 +18,15 @@ sr['plan'] = planByGeoID as DA.PlanByGeoID;
 sr['districtShapes'] = districtShapes as T.GeoFeatureCollection;
 sr['config'] = config as T.Dict;
 
+let text: any;
+let score: DA.GradedTest | DA.PassFailTest;
 let s = new DA.AnalyticsSession(sr);
 
-let bLog = false;
 s.analyzePlan();
+text = s.prepareScorecard();
+text = s.prepareTestLog();
 
-let pa: DA.PlanAnalytics = s.getPlanAnalytics(bLog);
-let ds: DA.DistrictStatistics = s.getDistrictStatistics(bLog);
-
+s.getTest(DA.Tests.Contiguous)
 ```
 
 ## License

package/dist/_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/_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/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;