votesim.models.spatial.base
######################################################

.. automodule:: votesim.models.spatial.base

.. Contents::
   :depth: 2


Class Summary
==================

.. autosummary::
    
        Candidates
    
        Election
    
        SimpleVoters
    
        VotersGroup
    



Function Summary
===================

.. autosummary::
    
        gaussian_preferences
    
        generate_preferences
    
        load_election
    
        ltruncnorm
    




Module Classes
==================


Candidates
--------------------------------------------

.. autoclass:: Candidates

Method/Attribute Summary
++++++++++

.. autosummary::

   Candidates.set_seed

   Candidates.reset

   Candidates.add_random

   Candidates.add

   Candidates.add_median

   Candidates.add_faction
   


.. automethod:: Candidates.set_seed

.. automethod:: Candidates.reset

.. automethod:: Candidates.add_random

.. automethod:: Candidates.add

.. automethod:: Candidates.add_median

.. automethod:: Candidates.add_faction
  

Election
--------------------------------------------

.. autoclass:: Election

Method/Attribute Summary
++++++++++

.. autosummary::

   Election.init

   Election.set_models

   Election.user_data

   Election.reset

   Election.run

   Election.electionData

   Election.electionStats

   Election.get_results

   Election.get_parameter_keys

   Election.get_parameters

   Election.get_output_docs

   Election.dataseries

   Election.dataframe

   Election.save

   Election.rerun
   


.. automethod:: Election.init

.. automethod:: Election.set_models

.. automethod:: Election.user_data

.. automethod:: Election.reset

.. automethod:: Election.run

.. automethod:: Election.electionData

.. automethod:: Election.electionStats

.. automethod:: Election.get_results

.. automethod:: Election.get_parameter_keys

.. automethod:: Election.get_parameters

.. automethod:: Election.get_output_docs

.. automethod:: Election.dataseries

.. automethod:: Election.dataframe

.. automethod:: Election.save

.. automethod:: Election.rerun
  

SimpleVoters
--------------------------------------------

.. autoclass:: SimpleVoters

Method/Attribute Summary
++++++++++

.. autosummary::

   SimpleVoters.set_seed

   SimpleVoters.set_strategy

   SimpleVoters.add_random

   SimpleVoters.add_points

   SimpleVoters.add

   SimpleVoters.calc_ratings

   SimpleVoters.electionStats

   SimpleVoters.reset
   


.. automethod:: SimpleVoters.set_seed

.. automethod:: SimpleVoters.set_strategy

.. automethod:: SimpleVoters.add_random

.. automethod:: SimpleVoters.add_points

.. automethod:: SimpleVoters.add

.. automethod:: SimpleVoters.calc_ratings

.. automethod:: SimpleVoters.electionStats

.. automethod:: SimpleVoters.reset
  

VotersGroup
--------------------------------------------

.. autoclass:: VotersGroup

Method/Attribute Summary
++++++++++

.. autosummary::

   VotersGroup.calc_ratings

   VotersGroup.voters

   VotersGroup.ElectionStats
   


.. automethod:: VotersGroup.calc_ratings

.. automethod:: VotersGroup.voters

.. automethod:: VotersGroup.ElectionStats
  






Module Functions
====================



 
gaussian_preferences
---------------------------------------------------------
.. autofunction:: gaussian_preferences


 
generate_preferences
---------------------------------------------------------
.. autofunction:: generate_preferences


 
load_election
---------------------------------------------------------
.. autofunction:: load_election


 
ltruncnorm
---------------------------------------------------------
.. autofunction:: ltruncnorm