Source code for mapof.elections.features

import mapof.elections.features.approx as approx
import mapof.elections.features.banzhaf_cc as banzhaf_cc
import mapof.elections.features.cohesive as cohesive
import mapof.elections.features.dap as dap
import mapof.elections.features.entropy as entropy
import mapof.elections.features.justified_representation as jr
import mapof.elections.features.simple_ordinal as simple_ordinal
import mapof.elections.features.simple_approval as simple_approval
import mapof.elections.features.partylist as partylist
import mapof.elections.features.proportionality_degree as prop_deg
import mapof.elections.features.ranging_cc as ranging_cc
import mapof.elections.features.scores as scores
import mapof.elections.features.abc_features as approval_rule_features

from mapof.elections.features.register import \
    registered_ordinal_election_features, \
    registered_approval_election_features





def get_local_feature(feature_id):
    """ Local feature depends only on a single instance """

    if feature_id in registered_approval_election_features:
        return registered_approval_election_features.get(feature_id)
    elif feature_id in registered_ordinal_election_features:
        return registered_ordinal_election_features.get(feature_id)
    else:
        raise ValueError(f'Incorrect feature id: {feature_id}')





def add_approval_feature(name: str, function: callable) -> None:
    """
    Adds a new approval feature to the list of available approval features.

    Parameters
    ----------
        name : str
            Name of the feature.
        function : callable
            function that calculates the feature.

    Returns
    -------
        None
    """
    registered_approval_election_features[name] = function





def add_ordinal_feature(name: str, function: callable) -> None:
    """
    Adds a new approval feature to the list of available approval features.

    Parameters
    ----------
        name : str
            Name of the feature.
        function : callable
            function that calculates the feature.

    Returns
    -------
        None
    """
    registered_ordinal_election_features[name] = function



__all__ = [
    'get_local_feature',
    'add_approval_feature',
    'add_ordinal_feature'
]