ecclesia/dist/election/attribution/transform.d.ts

Framework for political and electoral simulations

import { Simple } from '../ballots.js';
import { Attribution } from './base.js';
import '@gouvernathor/python/collections';

/**
 * Transforms a standard proportional attribution method into one that requires a certain threshold
 * (percentage of the total votes) to be reached by the parties in order to receive seats.
 * Mostly useful for proportional attribution methods -
 * but works for any simple-ballot-based attribution method.
 *
 * Replaces the Proportional class implementation.
 *
 * If the attribution implements a certain type
 * that extends Attribution<Party, Simple<Party>>
 * without adding any new method or property,
 * such as Proportional,
 * and if the contingency implements the same type, null, or undefined / not passed,
 * then it can be considered that the returned value implements that type too.
 *
 * @param threshold The threshold, between 0 and 1
 * @param contingency The fallback attribution in case the threshold is not reached by any party.
 * It takes an Attribution, or undefined (the default), or null.
 * Null in this case has the specific behavior that if no party reaches the threshold,
 * an AttributionFailure error will be raised.
 * If undefined (or nothing is passed), the contingency will default to running
 * the same attribution method without the threshold.
 * @param attribution The votes passed to this attribution method are guaranteed to be above the threshold,
 * except if the contingency is undefined and no party reached the threshold
 * (in that case, all parties will be passed).
 */
declare function addThresholdToSimpleAttribution<Party>({ threshold, attribution, contingency }: {
    threshold: number;
    attribution: Attribution<Party, Simple<Party>>;
    contingency?: Attribution<Party, Simple<Party>> | null;
}): Attribution<Party, Simple<Party>>;

export { addThresholdToSimpleAttribution };