From 366b0466c33232be533515abc73dc399b37fa211 Mon Sep 17 00:00:00 2001 From: Simon Rey Date: Wed, 21 Feb 2024 18:02:40 +0100 Subject: [PATCH] Docs++ --- docs-source/source/quickstart.rst | 2 +- docs-source/source/reference/constants.rst | 5 + docs-source/source/reference/index.rst | 2 + .../source/reference/inputvalidators.rst | 5 + docs/_modules/index.html | 6 +- docs/_modules/prefsampling.html | 378 ++++++++++++++ .../prefsampling/inputvalidators.html | 432 ++++++++++++++++ docs/_sources/quickstart.rst | 2 +- docs/_sources/reference/constants.rst | 5 + docs/_sources/reference/index.rst | 2 + docs/_sources/reference/inputvalidators.rst | 5 + docs/genindex.html | 34 +- docs/index.html | 2 + docs/objects.inv | Bin 1068 -> 1156 bytes docs/py-modindex.html | 7 + docs/quickstart.html | 4 +- docs/reference/constants.html | 452 +++++++++++++++++ docs/reference/index.html | 11 + docs/reference/inputvalidators.html | 474 ++++++++++++++++++ docs/search.html | 2 + docs/searchindex.js | 2 +- 21 files changed, 1823 insertions(+), 9 deletions(-) create mode 100644 docs-source/source/reference/constants.rst create mode 100644 docs-source/source/reference/inputvalidators.rst create mode 100644 docs/_modules/prefsampling.html create mode 100644 docs/_modules/prefsampling/inputvalidators.html create mode 100644 docs/_sources/reference/constants.rst create mode 100644 docs/_sources/reference/inputvalidators.rst create mode 100644 docs/reference/constants.html create mode 100644 docs/reference/inputvalidators.html diff --git a/docs-source/source/quickstart.rst b/docs-source/source/quickstart.rst index 321a488..9bd17bd 100644 --- a/docs-source/source/quickstart.rst +++ b/docs-source/source/quickstart.rst @@ -259,7 +259,7 @@ They are also all gathered in the :code:`prefsampling.CONSTANTS` enumeration. CONSTANTS.BUNKE_SHEARER Not that :py:class:`~prefsampling.core.euclidean.EuclideanSpace` and -:py:class:`~prefsampling.constants` are not the same enumeration so direct comparison will fail. +:py:class:`~prefsampling.CONSTANTS` are not the same enumeration so direct comparison will fail. Indeed, :code:`CONSTANTS.BALL == EuclideanSpace.BALL` is evaluated to :code:`False`. However, the values are the same so :code:`CONSTANTS.BALL.value == EuclideanSpace.BALL.value` is evaluated to :code:`True`. \ No newline at end of file diff --git a/docs-source/source/reference/constants.rst b/docs-source/source/reference/constants.rst new file mode 100644 index 0000000..1bdfb9b --- /dev/null +++ b/docs-source/source/reference/constants.rst @@ -0,0 +1,5 @@ +Constants +========= + +.. autoclass:: prefsampling.CONSTANTS + :members: diff --git a/docs-source/source/reference/index.rst b/docs-source/source/reference/index.rst index cdf60e3..01558e7 100644 --- a/docs-source/source/reference/index.rst +++ b/docs-source/source/reference/index.rst @@ -8,3 +8,5 @@ Reference approval/index tree/index core/index + constants + inputvalidators diff --git a/docs-source/source/reference/inputvalidators.rst b/docs-source/source/reference/inputvalidators.rst new file mode 100644 index 0000000..801b6c9 --- /dev/null +++ b/docs-source/source/reference/inputvalidators.rst @@ -0,0 +1,5 @@ +Input Validators +================ + +.. automodule:: prefsampling.inputvalidators + :members: diff --git a/docs/_modules/index.html b/docs/_modules/index.html index 760e96f..1638762 100644 --- a/docs/_modules/index.html +++ b/docs/_modules/index.html @@ -159,6 +159,8 @@
  • Approval
  • Tree
  • Core
    • +
  • Constants
    • +
  • Input Validators
    • @@ -279,6 +281,7 @@

    All modules for which code is available

    +
    diff --git a/docs/_modules/prefsampling.html b/docs/_modules/prefsampling.html new file mode 100644 index 0000000..68a05b3 --- /dev/null +++ b/docs/_modules/prefsampling.html @@ -0,0 +1,378 @@ + + + + + + + + + + prefsampling — PrefSampling + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + +
    +
    +
    +
    + + + Ctrl+K +
    +
    + +
    +
    + + +
    +
    + + + + + +
    + + + +
    + + + + +
    + +
    +
    + + + +
    +
    + +
    +
    +
    + + +
    +
    + + + + +
    + +
    + + + +
    + +
    +
    + +
    +
    + +
    + +
    + +
    + + +
    + +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + +
    +
    + + + +
    +

    + +
    +
    + +
    +
    +
    + + + + +
    + +

    Source code for prefsampling

    +__author__ = "Simon Rey and Stanisław Szufa"
+__email__ = "reysimon@orange.fr"
+__version__ = "0.1.8"
+
+from enum import Enum
+from itertools import chain
+
+from prefsampling.approval import NoiseType
+from prefsampling.core.euclidean import EuclideanSpace
+from prefsampling.ordinal import TreeSampler
+
+
+
    
+[docs]
+class CONSTANTS(Enum):
+    """ All constants of the package """
+    _ignore_ = 'member cls'
+    cls = vars()
+    for member in chain(list(EuclideanSpace), list(TreeSampler), list(NoiseType)):
+        if member.name in cls:
+            raise ValueError(f"The name {member.name} is used in more than one enumeration. The"
+                             f"CONSTANTS class needs unique names to be well-defined.")
+        cls[member.name] = member.value
    
+
+
    + +
    + + + + + + +
    + +
    +
    +
    + +
    + + + +
    + + +
    +
    + +
    + +
    + +

    +By Simon Rey and Stanisław Szufa +

    + +
    + +
    + + +

    + + © Copyright 2023, Simon Rey and Stanisław Szufa. +
    + +

    + +
    + +
    + +
    + +
    + +
    + +
    +
    + + +
    +
    +
    + + + + + + + + \ No newline at end of file diff --git a/docs/_modules/prefsampling/inputvalidators.html b/docs/_modules/prefsampling/inputvalidators.html new file mode 100644 index 0000000..79f1fa1 --- /dev/null +++ b/docs/_modules/prefsampling/inputvalidators.html @@ -0,0 +1,432 @@ + + + + + + + + + + prefsampling.inputvalidators — PrefSampling + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + +
    +
    +
    +
    + + + Ctrl+K +
    +
    + +
    +
    + + +
    +
    + + + + + +
    + + + +
    + + + + +
    + +
    +
    + + + +
    +
    + +
    +
    +
    + + +
    +
    + + + + +
    + +
    + + + +
    + +
    +
    + +
    +
    + +
    + +
    + +
    + + +
    + +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + +
    +
    + + + +
    +

    + +
    +
    + +
    +
    +
    + + + + +
    + +

    Source code for prefsampling.inputvalidators

    +from __future__ import annotations
+
+from functools import wraps
+
+
+
    
+[docs]
+def validate_num_voters_candidates(func):
+    """
+    Decorator that tests that the first two arguments of the function are integers larger than 0.
+
+    Parameters
+    ----------
+    func: Callable
+        The decorated function
+
+    """
+
+    @wraps(func)
+    def wrapper(num_voters, num_candidates, *args, **kwargs):
+        try:
+            assert int(num_voters) == num_voters
+        except (ValueError, AssertionError):
+            raise TypeError("The number of voters needs to be an integer.")
+        if num_voters < 1:
+            raise ValueError("The number of voters needs to be at least 1.")
+        try:
+            assert int(num_candidates) == num_candidates
+        except (ValueError, AssertionError):
+            raise TypeError("The number of candidates needs to be an integer.")
+        if num_candidates < 1:
+            raise ValueError("The number of candidates needs to be at least 1.")
+        return func(num_voters, num_candidates, *args, **kwargs)
+
+    return wrapper
    
+
+
+
+
    
+[docs]
+def validate_int(
+    value, value_descr: str = "value", lower_bound: int = None, upper_bound: int = None
+):
+    """
+    Validates that the input value is an int. Lower and upper bounds on the value of the int can be
+    provided.
+
+    Parameters
+    ----------
+        value:
+            The value to validate
+        value_descr: str, default: :code:`"value"`
+            A description of the value used in the message of the exceptions raised when the value
+            is not a valid input.
+        lower_bound: int, default: :code:`None`
+            A lower bound on the value.
+        upper_bound: int, default: :code:`None`
+            An upper bound on the value.
+
+    Raises
+    ------
+        TypeError
+            When the value is not an int or cannot be cast as an int.
+        ValueError
+            When the value is either strictly smaller than the lower bound or strictly greater than
+            the upper bound.
+    """
+    try:
+        int(value)
+    except (ValueError, TypeError):
+        raise TypeError(f"The {value_descr} needs to be an integer.")
+    if int(value) != value:
+        raise TypeError(f"The {value_descr} needs to be an integer.")
+    if lower_bound is not None and value < lower_bound:
+        raise ValueError(f"The {value_descr} needs to be {lower_bound} or more.")
+    if upper_bound is not None and value > upper_bound:
+        raise ValueError(f"The {value_descr} needs to be {upper_bound} or less.")
    
+
+
    + +
    + + + + + + +
    + +
    +
    +
    + +
    + + + +
    + + +
    +
    + +
    + +
    + +

    +By Simon Rey and Stanisław Szufa +

    + +
    + +
    + + +

    + + © Copyright 2023, Simon Rey and Stanisław Szufa. +
    + +

    + +
    + +
    + +
    + +
    + +
    + +
    +
    + + +
    +
    +
    + + + + + + + + \ No newline at end of file diff --git a/docs/_sources/quickstart.rst b/docs/_sources/quickstart.rst index 321a488..9bd17bd 100644 --- a/docs/_sources/quickstart.rst +++ b/docs/_sources/quickstart.rst @@ -259,7 +259,7 @@ They are also all gathered in the :code:`prefsampling.CONSTANTS` enumeration. CONSTANTS.BUNKE_SHEARER Not that :py:class:`~prefsampling.core.euclidean.EuclideanSpace` and -:py:class:`~prefsampling.constants` are not the same enumeration so direct comparison will fail. +:py:class:`~prefsampling.CONSTANTS` are not the same enumeration so direct comparison will fail. Indeed, :code:`CONSTANTS.BALL == EuclideanSpace.BALL` is evaluated to :code:`False`. However, the values are the same so :code:`CONSTANTS.BALL.value == EuclideanSpace.BALL.value` is evaluated to :code:`True`. \ No newline at end of file diff --git a/docs/_sources/reference/constants.rst b/docs/_sources/reference/constants.rst new file mode 100644 index 0000000..1bdfb9b --- /dev/null +++ b/docs/_sources/reference/constants.rst @@ -0,0 +1,5 @@ +Constants +========= + +.. autoclass:: prefsampling.CONSTANTS + :members: diff --git a/docs/_sources/reference/index.rst b/docs/_sources/reference/index.rst index cdf60e3..01558e7 100644 --- a/docs/_sources/reference/index.rst +++ b/docs/_sources/reference/index.rst @@ -8,3 +8,5 @@ Reference approval/index tree/index core/index + constants + inputvalidators diff --git a/docs/_sources/reference/inputvalidators.rst b/docs/_sources/reference/inputvalidators.rst new file mode 100644 index 0000000..801b6c9 --- /dev/null +++ b/docs/_sources/reference/inputvalidators.rst @@ -0,0 +1,5 @@ +Input Validators +================ + +.. automodule:: prefsampling.inputvalidators + :members: diff --git a/docs/genindex.html b/docs/genindex.html index 6f67786..93a2a4b 100644 --- a/docs/genindex.html +++ b/docs/genindex.html @@ -159,6 +159,8 @@
  • Approval
  • Tree
  • Core
    • +
  • Constants
    • +
  • Input Validators
    • @@ -299,6 +301,7 @@

    Index

    | S | T | U + | V | Z @@ -329,11 +332,13 @@

    C

    - + @@ -450,6 +455,8 @@

    M

  • prefsampling.core.euclidean
  • prefsampling.core.filters +
    • +
  • prefsampling.inputvalidators
  • prefsampling.ordinal
    • @@ -505,8 +512,6 @@

    P

  • module
    • - - + + +

    V

    + + + +
    +

    Z

    + + +
    diff --git a/docs/objects.inv b/docs/objects.inv index f3e2ce0f594d25bfab63bd9d77e47a904b235924..c8b03f1544c8b475a109ef47d5984a9f3923ee59 100644 GIT binary patch delta 1043 zcmV+u1nm2)2!sicfPa}mciK1*fbaelesA{*?OuCxsoSt64#lL0Ui1`s2-?V!E6Hi; zuV2Z=V1tYyh)bS5n)zlVk473&NLVSH7mV`f@#G;%mr=4z!(#J+FsxMgPiPcC0w?f} z2(C2dT8-B_XMg=2j)J0Xj*CKySIn$+F0ztA_`YS{48Nm1gMZ&OqgEUBqQ;4!3YMD! z+#$J`XTZiEACs>!O7G%m5icwnYc1(hslf~WF1o*;CSUx6|BWV-Xz|HE_(wdOCSN08 z;EbyO1mzk@Xa+5MRdS-K;8&0#FZ9M2t0atOfVn5$s$|R)%7n!=^)^$Q7g%bFnQtCy ziULyf4|t;I;(yh=`_CP2)7>Y_Rh~ve%%MWp=h6FeXlWQ&LxzORDEF2erR2z_$A(d* zuVWG+q31ZUL+2bNR?qy&3!!KggkPL_t`?Ew2JW2gA%2*f)8D$3a3!%*;;xJ8D|r$v8A9IIv?~l;{d~m1r_#W(qE}6)1 zC-f#7!d&o8E=uKvn`6erFF!0UWR83S3x>%HXn&1ZN&IA&GB4(+BvL4Ks=s*yvjF^J zIvheJVQ>qu;8g#qw}EH$FU-{157%5jG+j}0x=FbNX_~yNINI#{p7YucopV@Qy|Kw_ zq{vzd$Uvfo>J00U>jv6pP8O6g>;>mFwk`}kNqZe$2}wMI87Ol%Ffi; zPk+GdiO@(Zy>MzDgS}cNh*fH7%#D+D8=Fy7+I-+TYdiXTc>~@{j?H$_92uI(JEkVr z9Fr(Eqh_FXcVB01J)PF*fZ2Sb*CwQn_0N)$7ZZWh?HTT+wdFVa9;Q}sXt8s5U}L7% zw(9%krS0|PuQOq^l?9G}3AicU{}_am=6^MCwLN`^PFrLc5`uPr&}-Q;S~S9-x3lPD z9Je3lyBT5leJ2fiDxVv9TpYuPS`@hUmm6}h|3Z6<3KU>T*4><_WwlaTkI(Tl1lu_s zZIHdZyS=~fQy`d#RlGAKpg_bTzH8reU=?rk|`xD6fR0e`D2L7Qi^BHf^zk-5P8KQcpn%AkiZGNYlq)a zp2Od8sSEa|Q5(Mv#-q}O3KKyU+^tHmP{OcM!G{6n5wP&neSh*TM%i^7rEzM}SZhfi zDh*!n*U`<*G`aE*{u)gtQTo|G_-8zuCf_1o;GC*of^v-{w1XDCs5sG7@H5CzlzQch zRS`yWz}ypWQ8DHTW!&PLdRr+iN-Qn0om6-I@<`W&wnVYfzwCCI|86FrNT ze7=7st8!cbBADkiH|N+Nx0VCK3K3JwrKy$H@z>)!N!qca>(OI2b*&oSNr0?&Qo2vD zgLw?h9^ELJ#0T2c*ODjEU7XIRvssk-hi8-P^fvw+UlNUGaW;vPB);SvgW2JfDa^5; zy+L~lXn(ldK85xuMO7jNrqRF;4E!-SNcZ^|55NacTF=~r4gV<%8E*GqMMIbizA8ke zyl@N5nE2y|#f2=8PhiO~c>=8wtB9ZIQs%|f10sb|hno0TFiXHsri~|55(bw53r_XF z<`{TJ|G`Wx{cuf<)pSA0;ZFP%q`AqQ#nI;6_kYxDJ9JF3wtAt7Yoy3h3dljCmg;nC zpX&zN8;dL{W7rGMt8cq7^dN1|w-Aze1~X8m>*J?UAA#4BK;t z+kY&lGdf^4U+JZBX~+6^Mah%#K%qSu zf@m!pxjJ(l#X4Khev(sDa{}&rckY`Tq`v3p{ diff --git a/docs/py-modindex.html b/docs/py-modindex.html index 6205a61..1763c1e 100644 --- a/docs/py-modindex.html +++ b/docs/py-modindex.html @@ -162,6 +162,8 @@
  • Approval
  • Tree
  • Core
    • +
  • Constants
    • +
  • Input Validators
    • @@ -323,6 +325,11 @@

    Python Module Index

    		    prefsampling.core.filters
        + prefsampling.inputvalidators +
        diff --git a/docs/quickstart.html b/docs/quickstart.html index 66148f5..5a9a11d 100644 --- a/docs/quickstart.html +++ b/docs/quickstart.html @@ -160,6 +160,8 @@
  • Approval
  • Tree
  • Core
    • +
  • Constants
    • +
  • Input Validators
    • @@ -666,7 +668,7 @@

    ConstantsEuclideanSpace and -constants are not the same enumeration so direct comparison will fail. +CONSTANTS are not the same enumeration so direct comparison will fail. Indeed, CONSTANTS.BALL == EuclideanSpace.BALL is evaluated to False. However, the values are the same so CONSTANTS.BALL.value == EuclideanSpace.BALL.value is evaluated to True.

    diff --git a/docs/reference/constants.html b/docs/reference/constants.html new file mode 100644 index 0000000..8abd244 --- /dev/null +++ b/docs/reference/constants.html @@ -0,0 +1,452 @@ + + + + + + + + + + + Constants — PrefSampling + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + +
    +
    +
    +
    + + + Ctrl+K +
    +
    + +
    +
    + + +
    +
    + + + +
    + + + +
    + + + + +
    + +
    +
    + + + +
    +
    + +
    +
    +
    + + +
    +
    + + + + +
    + +
    + + + +
    + +
    +
    + +
    +
    + +
    + +
    + +
    + + +
    + +
    + +
    + + + + + + + + + + + + + + + + +
    + + +
    + + + + + + + + + + + + + +
    + +
    + +
    +
    + + + +
    +

    Constants

    + +
    +
    + +
    +

    Contents

    +
    + +
    +
    +
    + + + + +
    + +
    +

    Constants#

    +
    +
    +class CONSTANTS(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]#
    +

    All constants of the package

    +
    + +
    + + +
    + + + + + + + + +
    + + + +
    + + +
    +
    + Contents +
    +
    + +
    + + +
    +
    + +
    + +
    + +

    +By Simon Rey and Stanisław Szufa +

    + +
    + +
    + + +

    + + © Copyright 2023, Simon Rey and Stanisław Szufa. +
    + +

    + +
    + +
    + +
    + +
    + +
    + +
    +
    + + +
    +
    +
    + + + + + +
    +
    + + \ No newline at end of file diff --git a/docs/reference/index.html b/docs/reference/index.html index 270aa83..97d55b5 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -160,6 +160,8 @@
  • Approval
  • Tree
  • Core
    • +
  • Constants
    • +
  • Input Validators
    • @@ -380,6 +382,15 @@

    ReferenceModule core.euclidean +
  • Constants +
    • +
  • Input Validators +
    • diff --git a/docs/reference/inputvalidators.html b/docs/reference/inputvalidators.html new file mode 100644 index 0000000..28319ce --- /dev/null +++ b/docs/reference/inputvalidators.html @@ -0,0 +1,474 @@ + + + + + + + + + + + Input Validators — PrefSampling + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + +
    +
    +
    +
    + + + Ctrl+K +
    +
    + +
    +
    + + +
    +
    + + + +
    + + + +
    + + + + +
    + +
    +
    + + + +
    +
    + +
    +
    +
    + + +
    +
    + + + + +
    + +
    + + + +
    + +
    +
    + +
    +
    + +
    + +
    + +
    + + +
    + +
    + +
    + + + + + + + + + + + + + + + + +
    + + +
    + + + + + + + + + + + + + +
    + +
    + +
    +
    + + + +
    +

    Input Validators

    + +
    +
    + +
    +

    Contents

    +
    + +
    +
    +
    + + + + +
    + +
    +

    Input Validators#

    +
    +
    +validate_int(value, value_descr: str = 'value', lower_bound: int = None, upper_bound: int = None)[source]#
    +

    Validates that the input value is an int. Lower and upper bounds on the value of the int can be +provided.

    +
    +
    Parameters:
    +
      +

    • value – The value to validate

      • +

    • value_descr (str, default: "value") – A description of the value used in the message of the exceptions raised when the value +is not a valid input.

      • +

    • lower_bound (int, default: None) – A lower bound on the value.

      • +

    • upper_bound (int, default: None) – An upper bound on the value.

      • +
    +
    +
    Raises:
    +
      +

    • TypeError – When the value is not an int or cannot be cast as an int.

      • +

    • ValueError – When the value is either strictly smaller than the lower bound or strictly greater than + the upper bound.

      • +
    +
    +
    +
    + +
    +
    +validate_num_voters_candidates(func)[source]#
    +

    Decorator that tests that the first two arguments of the function are integers larger than 0.

    +
    +
    Parameters:
    +

    func (Callable) – The decorated function

    +
    +
    +
    + +
    + + +
    + + + + + + + + +
    + + + +
    + + +
    +
    + Contents +
    +
    + +
    + + +
    +
    + +
    + +
    + +

    +By Simon Rey and Stanisław Szufa +

    + +
    + +
    + + +

    + + © Copyright 2023, Simon Rey and Stanisław Szufa. +
    + +

    + +
    + +
    + +
    + +
    + +
    + +
    +
    + + +
    +
    +
    + + + + + +
    +
    + + \ No newline at end of file diff --git a/docs/search.html b/docs/search.html index 6640bb3..9dcc884 100644 --- a/docs/search.html +++ b/docs/search.html @@ -161,6 +161,8 @@
  • Approval
  • Tree
  • Core
    • +
  • Constants
    • +
  • Input Validators
    • diff --git a/docs/searchindex.js b/docs/searchindex.js index 8a34091..0bd032f 100644 --- a/docs/searchindex.js +++ b/docs/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["index", "installation", "quickstart", "reference/approval/index", "reference/core/index", "reference/index", "reference/ordinal/index", "reference/tree/index", "validation/approval", "validation/index", "validation/ordinal", "validation/tree"], "filenames": ["index.rst", "installation.rst", "quickstart.rst", "reference/approval/index.rst", "reference/core/index.rst", "reference/index.rst", "reference/ordinal/index.rst", "reference/tree/index.rst", "validation/approval.rst", "validation/index.rst", "validation/ordinal.rst", "validation/tree.rst"], "titles": ["PrefSampling", "Installation", "Quick Start", "Approval", "Core", "Reference", "Ordinal", "Tree", "Approval Samplers", "Validation", "Ordinal Samplers", "Tree Samplers"], "terms": {"i": [0, 1, 2, 3, 4, 6, 7, 8, 9, 10, 11], "lightweight": 0, "python": [0, 2, 9], "librari": 0, "provid": [0, 2, 4, 7, 9], "prefer": [0, 2, 3, 6], "sampler": [0, 3, 5, 6, 7], "These": [0, 2, 3], "ar": [0, 2, 3, 4, 6, 7, 9, 10], "algorithm": [0, 6, 7], "gener": [0, 3, 4, 6, 7, 8, 9, 10], "random": [0, 2, 3, 4, 6, 7], "base": [0, 2, 4, 8], "precis": 0, "defin": [0, 2, 3, 4, 6], "statist": 0, "cultur": [0, 3, 6, 10], "we": [0, 2, 4, 6, 8, 9, 10, 11], "consid": [0, 2, 3, 4, 6], "differ": [0, 2, 3, 4, 6, 10], "type": [0, 3, 4, 6, 7], "ordin": [0, 3, 4, 5, 9], "express": 0, "rank": [0, 2, 6, 10], "candid": [0, 2, 3, 4, 6, 8, 10], "approv": [0, 4, 5, 9], "indic": [0, 6], "set": [0, 2, 3, 4, 6], "prefsampl": [1, 2, 8, 10, 11], "host": 1, "pypi": 1, "you": [1, 2, 3, 4, 6], "can": [1, 2, 3, 4, 6, 10], "thu": [1, 8, 10, 11], "easili": 1, "us": [1, 2, 3, 4, 6, 10], "pip3": 1, "The": [1, 2, 3, 4, 6, 7, 8, 10], "sourc": [1, 3, 4, 6, 7], "code": [1, 4], "github": [1, 7], "repositori": [1, 7], "well": [1, 10], "format": [2, 4], "thei": [2, 10], "produc": [2, 10, 11], "modul": [2, 3, 5, 6], "contain": [2, 6], "ones": [2, 3], "To": [2, 6, 9], "make": [2, 9], "easi": 2, "emb": 2, "all": [2, 3, 4, 6, 7, 10, 11], "kind": 2, "tool": 2, "basic": 2, "return": [2, 3, 4, 6, 7], "collect": [2, 3, 4, 6], "np": [2, 4, 6], "ndarrai": [2, 4, 6], "numpi": [2, 3, 4, 6, 7], "arrai": 2, "where": [2, 3, 6, 10], "most": [2, 6], "posit": [2, 3, 4, 6], "0": [2, 3, 6, 10], "next": [2, 6], "one": [2, 4, 6, 7, 10], "1": [2, 3, 4, 6, 10], "so": [2, 6], "forth": 2, "each": [2, 3, 4, 6, 7, 9], "In": [2, 3, 6, 8, 10], "case": [2, 4, 6, 10], "name": [2, 3, 4, 6], "2": [2, 3, 6, 10], "have": [2, 6, 10], "same": [2, 3, 4, 8, 10], "signatur": 2, "num_vot": [2, 3, 4, 6], "num_candid": [2, 3, 4, 6], "arg": 2, "seed": [2, 3, 4, 6, 7], "none": [2, 3, 4, 6, 7], "kwarg": 2, "paramet": [2, 3, 4, 6, 7, 8], "repres": [2, 3, 4, 6], "number": [2, 3, 4, 6, 7, 10, 11], "pass": [2, 3, 4], "give": [2, 7], "more": [2, 6, 8, 9, 10], "control": [2, 6], "need": [2, 4], "replic": 2, "instanc": [2, 4, 6, 10], "other": [2, 3, 4, 6, 10], "specif": [2, 4, 6, 7], "refer": 2, "ident": [2, 3, 5, 6, 9], "imparti": [2, 3, 5, 6, 9], "impartial_anonym": [2, 5, 6, 10], "mallow": [2, 5, 6, 9], "phi": [2, 3, 6, 10], "central_vot": [2, 3, 4, 6], "default": [2, 3, 6, 7], "normalise_phi": [2, 6], "fals": [2, 3, 6], "norm_mallow": [2, 5, 6], "norm_phi": [2, 6], "euclidean": [2, 3, 5, 6, 9], "space": [2, 3, 4, 6], "uniform": [2, 3, 4, 6, 7, 9, 10], "dimens": [2, 3, 4, 6], "plackett_luc": [2, 5, 6, 10], "alpha": [2, 3, 6, 10], "didi": [2, 5, 6, 9], "urn": [2, 3, 5, 6, 9], "stratif": [2, 5, 6, 9], "weight": [2, 4, 6, 10], "single_peaked_conitz": [2, 5, 6, 10], "single_peaked_walsh": [2, 5, 6, 10], "single_peaked_circl": [2, 5, 6, 10], "single_cross": [2, 5, 6, 10], "group_separ": [2, 5, 6, 10], "tree_sampl": [2, 6], "schroeder": [2, 6], "p": [2, 3, 8], "empti": [2, 3, 5, 6], "full": [2, 3, 5], "resampl": [2, 3, 4, 5, 9], "disjoint_resampl": [2, 3, 5, 8], "g": [2, 3, 4], "moving_resampl": [2, 3, 5], "num_leg": [2, 3], "radiu": [2, 3], "5": [2, 3, 6], "nois": [2, 3, 5, 9], "noise_typ": [2, 3], "ham": [2, 3, 8], "truncated_ordin": [2, 3, 5], "ordinal_sampl": [2, 3], "ordinal_sampler_paramet": [2, 3], "urn_partylist": [2, 3, 5], "parti": [2, 3], "It": [2, 4], "often": 2, "abl": 2, "compos": 2, "mixtur": [2, 4], "function": [2, 3, 4, 6], "concaten": [2, 4], "do": [2, 6], "being": [2, 3, 4, 6, 8], "given": [2, 3, 4, 6, 7, 10], "probabl": [2, 3, 4, 6, 7, 8, 10, 11], "from": [2, 3, 4, 6, 7, 9, 10], "core": [2, 5], "import": [2, 4], "creat": 2, "100": 2, "voter": [2, 3, 4, 6, 10], "10": 2, "singl": [2, 3, 6, 8, 9], "peak": [2, 6, 9], "conitz": [2, 6, 10], "6": 2, "walsh": [2, 6, 10], "4": [2, 6], "list": [2, 3, 4, 6, 7], "model": [2, 3, 6, 8, 10], "3": [2, 6], "9": 2, "23": 2, "simpli": 2, "vote": [2, 3, 4, 6, 10], "60": 2, "40": 2, "per": [2, 3, 6], "oper": [2, 4], "appli": [2, 3, 4, 6], "some": [2, 4], "them": [2, 4, 6, 7], "implement": [2, 6, 9], "effect": 2, "permute_vot": [2, 4], "randomli": [2, 4, 6], "permut": [2, 4, 6], "rename_candid": [2, 4], "renam": [2, 4], "resample_as_central_vot": [2, 4], "central": [2, 3, 4, 6], "whose": 2, "definit": [2, 6], "includ": [2, 6], "e": [2, 3, 4, 6, 10], "below": [2, 8, 10, 11], "an": [2, 4, 6, 8, 10], "exampl": [2, 10], "how": 2, "initial_vot": 2, "855": 2, "argument": [2, 3, 4], "sampl": [3, 4, 6, 7, 8, 9], "which": [3, 4, 6], "either": [3, 6], "disapprov": 3, "class": [3, 4, 6, 10], "noisetyp": [2, 3, 5], "valu": [2, 3, 4, 6, 10], "qualnam": [3, 4, 6], "start": [3, 4, 6], "boundari": [3, 4, 6], "constant": [3, 4, 6], "bunke_shear": [2, 3], "bunk": 3, "shearer": 3, "jaccard": 3, "zelinka": 3, "int": [3, 4, 6, 7], "float": [3, 4, 6], "disjoint": [3, 9], "denot": 3, "length": [3, 8, 10], "group": [3, 6, 9], "rais": [3, 6], "valueerror": [3, 6], "when": [3, 6, 10], "interv": 3, "euclideanspac": [2, 3, 4, 6], "accord": [3, 6], "assign": [3, 6], "A": [3, 6], "within": [3, 4, 6], "certain": 3, "word": 3, "distanc": [3, 6, 8, 10], "sever": [3, 6], "possibl": [3, 6, 7], "enumer": [2, 3, 6, 7, 11], "also": [2, 3, 6, 9, 10], "chang": [3, 6], "independ": [3, 4, 6], "follow": [3, 4, 6, 7, 8], "process": [3, 4, 6], "describ": [3, 6, 10], "abov": [3, 6], "should": [3, 4, 6], "simpl": 3, "onli": [3, 4, 6, 8, 10], "proport": [3, 6, 7], "under": [3, 6, 10], "ha": [3, 4, 8, 10, 11], "thi": [3, 4, 6, 7, 8, 9, 10, 11], "ensur": [3, 6, 7, 9, 10], "averag": 3, "ani": [3, 4, 6], "move": 3, "leg": 3, "callabl": [3, 4], "dict": [3, 4], "truncat": 3, "wai": 3, "consist": 3, "first": [3, 6, 9], "ratio": 3, "ot": 3, "overriden": 3, "those": 3, "partylist": 3, "fraction": 3, "size": [3, 6], "ballot": [3, 4, 8], "num_voters_per_sampl": 4, "sampler_paramet": 4, "togeth": [4, 6, 9], "form": 4, "final": [4, 6], "note": [4, 6, 10], "after": [4, 6], "onc": [4, 10], "assum": 4, "about": [4, 10], "If": [3, 4, 6, 7], "don": 4, "t": 4, "fail": [2, 4], "dictionari": 4, "keyword": 4, "taken": [4, 7], "account": 4, "work": [4, 6, 8], "distribut": [4, 6, 8, 9, 10, 11], "correspond": [2, 4, 6, 7], "over": [3, 4, 6, 10], "k": [4, 6, 8], "want": [4, 9], "particular": 4, "mutablesequ": 4, "order": [4, 6], "incomplet": 4, "input": 4, "largest": 4, "integ": 4, "appear": [4, 10], "accept": 4, "copi": [4, 6], "befor": [4, 6], "avoid": 4, "loss": 4, "data": 4, "ball": [2, 4], "gaussian": 4, "sphere": 4, "spheric": 4, "election_posit": 4, "rng": 4, "_gener": [], "respect": [2, 4, 6], "treesampl": [5, 6], "tree": [5, 6, 9, 10], "all_schroeder_tre": [5, 7], "caterpillar_tre": [5, 7], "schroeder_tre": [5, 7, 11], "schroeder_tree_brute_forc": [5, 7, 11], "schroeder_tree_lescann": [5, 7, 11], "composit": 5, "filter": 5, "unanim": 6, "equal": [6, 10], "like": [6, 10], "occur": [6, 10], "get": 6, "anonym": [6, 9], "everi": [6, 8, 10], "multi": 6, "For": [6, 10], "observ": [6, 8, 10], "b": 6, "wa": [6, 7], "8": 6, "see": [2, 6, 8, 10], "lepellei": 6, "valogn": 6, "2003": 6, "here": [6, 8, 10], "bool": [3, 6], "1957": 6, "parameteris": 6, "decreas": 6, "exponenti": 6, "between": [6, 9], "dispers": 6, "coeffici": 6, "kendal": 6, "tau": 6, "consider": 6, "close": 6, "render": 6, "far": 6, "awai": 6, "unlik": 6, "opposit": 6, "depend": 6, "applic": 6, "advis": 6, "normalis": 6, "especi": 6, "compar": 6, "boehmer": 6, "faliszewski": 6, "kraiczi": 6, "2023": 6, "detail": [6, 8], "true": [2, 3, 6], "option": [], "whether": 6, "arrang": 6, "shortcut": 6, "increas": 6, "closest": 6, "etc": 6, "plackett": [6, 9], "luce": [6, 9], "vector": 6, "intuit": 6, "qualiti": [6, 10], "m": [6, 10], "step": 6, "fill": 6, "up": 6, "least": 6, "initi": 6, "draw": 6, "select": [3, 6, 7], "its": 6, "Then": 6, "remov": 6, "re": 6, "similar": 6, "dirichlet": 6, "moreov": 6, "higher": 6, "sum": 6, "correl": 6, "concentr": 6, "point": 6, "veri": 6, "spirit": 6, "param": 6, "len": 6, "p\u00f3lya": 6, "eggenberg": 6, "turn": 6, "happen": 6, "With": [6, 10], "urn_siz": 6, "uniformli": [3, 6, 7], "both": 6, "put": 6, "back": [6, 10], "must": 6, "non": [6, 10], "neg": 6, "split": 6, "two": [6, 9], "second": 6, "rel": 6, "upper": 6, "2009": [6, 10], "axi": [6, 10], "left": 6, "right": 6, "come": 6, "method": 6, "iter": 6, "oppos": 6, "dist_peak_to_end": [6, 10], "minimum": [6, 10], "end": [6, 10], "2015": [6, 10], "leftmost": 6, "rightmost": 6, "yet": 6, "been": [6, 10], "circl": [6, 10], "inspir": 6, "peaked": 6, "line": 6, "determin": 6, "done": 6, "subsequ": 6, "take": 6, "avail": [6, 7], "term": 6, "circular": 6, "cross": [6, 9], "elkind": 6, "lackner": 6, "peter": 6, "2022": [6, 7, 8, 9], "domain": 6, "alwai": 6, "valid": [6, 8, 10, 11], "swap": 6, "consecut": 6, "had": 6, "alreadi": 6, "previou": 6, "One": 6, "perform": 6, "admit": 6, "importantli": [6, 9], "success": 6, "further": 6, "down": 6, "than": 6, "previous": 6, "latter": 6, "neutral": 6, "mean": 6, "lexicograph": 6, "obtain": [6, 10], "szufa": [6, 8], "skowron": 6, "slinko": 6, "talmon": 6, "2020": 6, "profil": [6, 10], "yield": [6, 10, 11], "procedur": [6, 7], "unknown": [6, 10, 11], "outcom": [6, 10], "single_crossing_imparti": 6, "becom": 6, "slow": [6, 11], "difficulti": 6, "li": 6, "comput": 6, "instead": 6, "separ": [6, 9], "seprabl": 6, "present": [6, 7, 8, 10, 11], "karpov": 6, "obraztsova": 6, "decomposit": 6, "intern": [6, 7], "node": [6, 7], "children": 6, "revers": 6, "label": 6, "leav": [6, 7, 11], "read": 6, "meant": 6, "howev": [2, 6, 10], "our": 6, "analysi": 6, "impact": 6, "balanc": 6, "caterpillar": [6, 7], "schr\u00f6der": [6, 7, 9], "alonso": [6, 7, 9], "r\u00e9my": [6, 7, 9], "schott": [6, 7, 9], "1997": [6, 9], "schroeder_lescann": 6, "lescann": [6, 7, 9], "schroeder_uniform": 6, "via": 6, "complet": 6, "num_leav": 7, "num_internal_nod": 7, "rerun": 7, "root": 7, "sch\u00f6der": 7, "suitabl": 7, "1997a": 7, "build": 7, "1997b": 7, "schro\u00f6der": 7, "particularli": 7, "ineffici": 7, "directcli": 7, "licenc": 7, "until": 7, "requir": 7, "achiev": 7, "reject": 7, "test": [8, 9, 10, 11], "ran": [8, 10, 11], "binomi": 8, "et": 8, "al": 8, "what": [8, 9], "correct": 9, "packag": 9, "variou": 9, "typic": 9, "sure": 9, "develop": 9, "featur": 9, "program": 9, "perspect": 9, "But": 9, "actual": 9, "displai": 9, "theoret": 9, "allow": 9, "u": 9, "ass": 9, "adequ": 9, "multiset": 10, "discuss": 10, "stratifi": 10, "fall": 10, "interest": 10, "govern": 10, "document": 10, "http": 10, "www": 10, "jstor": 10, "org": 10, "stabl": 10, "30024551": 10, "again": 10, "known": 10, "jmlr": 10, "paper": 10, "v15": 10, "lu14a": 10, "html": 10, "properti": 10, "proceed": 10, "mlr": 10, "press": 10, "v48": 10, "zhaob16": 10, "otherwis": 10, "know": 10, "littl": 10, "propos": 10, "design": 10, "isomorph": 10, "effici": [10, 11], "suppos": [10, 11], "doe": [10, 11], "practic": 11, "larg": 11, "impartial_central_vot": [2, 3, 6], "ignor": [3, 6], "partial": [], "impartial_constant_s": [2, 3, 5], "num_approv": [], "typeerror": [], "rel_num_approv": [2, 3], "gather": 2, "shape": 4, "scr\u00f6der": 6, "alsonso": 6, "brute": 6, "forc": 6, "Not": 2, "direct": 2, "comparison": 2, "inde": 2, "evalu": 2}, "objects": {"prefsampling": [[3, 0, 0, "-", "approval"], [4, 0, 0, "-", "core"], [6, 0, 0, "-", "ordinal"], [7, 0, 0, "-", "tree"]], "prefsampling.approval": [[3, 1, 1, "", "NoiseType"], [3, 3, 1, "", "disjoint_resampling"], [3, 3, 1, "", "empty"], [3, 3, 1, "", "euclidean"], [3, 3, 1, "", "full"], [3, 3, 1, "", "identity"], [3, 3, 1, "", "impartial"], [3, 3, 1, "", "impartial_constant_size"], [3, 3, 1, "", "moving_resampling"], [3, 3, 1, "", "noise"], [3, 3, 1, "", "resampling"], [3, 3, 1, "", "truncated_ordinal"], [3, 3, 1, "", "urn_partylist"]], "prefsampling.approval.NoiseType": [[3, 2, 1, "", "BUNKE_SHEARER"], [3, 2, 1, "", "HAMMING"], [3, 2, 1, "", "JACCARD"], [3, 2, 1, "", "ZELINKA"]], "prefsampling.core": [[4, 0, 0, "-", "composition"], [4, 0, 0, "-", "euclidean"], [4, 0, 0, "-", "filters"]], "prefsampling.core.composition": [[4, 3, 1, "", "concatenation"], [4, 3, 1, "", "mixture"]], "prefsampling.core.euclidean": [[4, 1, 1, "", "EuclideanSpace"], [4, 3, 1, "", "election_positions"]], "prefsampling.core.euclidean.EuclideanSpace": [[4, 2, 1, "", "BALL"], [4, 2, 1, "", "GAUSSIAN"], [4, 2, 1, "", "SPHERE"], [4, 2, 1, "", "UNIFORM"]], "prefsampling.core.filters": [[4, 3, 1, "", "permute_voters"], [4, 3, 1, "", "rename_candidates"], [4, 3, 1, "", "resample_as_central_vote"]], "prefsampling.ordinal": [[6, 1, 1, "", "TreeSampler"], [6, 3, 1, "", "didi"], [6, 3, 1, "", "euclidean"], [6, 3, 1, "", "group_separable"], [6, 3, 1, "", "identity"], [6, 3, 1, "", "impartial"], [6, 3, 1, "", "impartial_anonymous"], [6, 3, 1, "", "mallows"], [6, 3, 1, "", "norm_mallows"], [6, 3, 1, "", "plackett_luce"], [6, 3, 1, "", "single_crossing"], [6, 3, 1, "", "single_peaked_circle"], [6, 3, 1, "", "single_peaked_conitzer"], [6, 3, 1, "", "single_peaked_walsh"], [6, 3, 1, "", "stratification"], [6, 3, 1, "", "urn"]], "prefsampling.ordinal.TreeSampler": [[6, 2, 1, "", "BALANCED"], [6, 2, 1, "", "CATERPILLAR"], [6, 2, 1, "", "SCHROEDER"], [6, 2, 1, "", "SCHROEDER_LESCANNE"], [6, 2, 1, "", "SCHROEDER_UNIFORM"]], "prefsampling.tree": [[7, 3, 1, "", "all_schroeder_tree"], [7, 3, 1, "", "caterpillar_tree"], [7, 3, 1, "", "schroeder_tree"], [7, 3, 1, "", "schroeder_tree_brute_force"], [7, 3, 1, "", "schroeder_tree_lescanne"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:attribute", "3": "py:function"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "attribute", "Python attribute"], "3": ["py", "function", "Python function"]}, "titleterms": {"prefsampl": 0, "instal": 1, "quick": 2, "start": 2, "organis": 2, "packag": 2, "sampl": 2, "type": 2, "gener": 2, "syntax": 2, "ordin": [2, 6, 10], "sampler": [2, 4, 8, 9, 10, 11], "approv": [2, 3, 8], "composit": [2, 4], "filter": [2, 4], "core": 4, "modul": 4, "euclidean": [4, 10], "refer": 5, "tree": [7, 11], "imparti": [8, 10], "resampl": 8, "disjoint": 8, "nois": 8, "ident": 8, "valid": 9, "procedur": 9, "anonym": 10, "stratif": 10, "urn": 10, "mallow": 10, "plackett": 10, "luce": 10, "didi": 10, "singl": 10, "peak": 10, "cross": 10, "group": 10, "separ": 10, "schr\u00f6der": 11, "alonso": 11, "r\u00e9my": 11, "schott": 11, "1997": 11, "lescann": 11, "2022": 11, "uniform": 11, "constant": 2}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx": 60}, "alltitles": {"PrefSampling": [[0, "prefsampling"]], "Installation": [[1, "installation"]], "Reference": [[5, "reference"]], "Tree": [[7, "module-prefsampling.tree"]], "Approval Samplers": [[8, "approval-samplers"], [2, "approval-samplers"]], "Impartial": [[8, "impartial"], [10, "impartial"]], "Resampling": [[8, "resampling"]], "Disjoint Resampling": [[8, "disjoint-resampling"]], "Noise": [[8, "noise"]], "Identity": [[8, "identity"]], "Validation": [[9, "validation"]], "Procedure": [[9, "procedure"]], "Validated Samplers": [[9, "validated-samplers"]], "Ordinal Samplers": [[10, "ordinal-samplers"], [2, "ordinal-samplers"]], "Impartial Anonymous": [[10, "impartial-anonymous"]], "Stratification": [[10, "stratification"]], "Urn": [[10, "urn"]], "Mallows": [[10, "mallows"]], "Plackett-Luce": [[10, "plackett-luce"]], "Didi": [[10, "didi"]], "Euclidean": [[10, "euclidean"]], "Single-Peaked": [[10, "single-peaked"]], "Single-Crossing": [[10, "single-crossing"]], "Group-Separable": [[10, "group-separable"]], "Tree Samplers": [[11, "tree-samplers"]], "Schr\u00f6der Trees by Alonso, R\u00e9my, Schott (1997)": [[11, "schroder-trees-by-alonso-remy-schott-1997"]], "Schr\u00f6der Trees by Lescanne (2022)": [[11, "schroder-trees-by-lescanne-2022"]], "Uniform Schr\u00f6der Trees": [[11, "uniform-schroder-trees"]], "Quick Start": [[2, "quick-start"]], "Organisation of the package": [[2, "organisation-of-the-package"]], "Sample Types": [[2, "sample-types"]], "General Syntax": [[2, "general-syntax"]], "Composition of Samplers": [[2, "composition-of-samplers"], [4, "module-prefsampling.core.composition"]], "Filters": [[2, "filters"], [4, "module-prefsampling.core.filters"]], "Constants": [[2, "constants"]], "Approval": [[3, "module-prefsampling.approval"]], "Core": [[4, "module-prefsampling.core"]], "Module core.euclidean": [[4, "module-prefsampling.core.euclidean"]], "Ordinal": [[6, "module-prefsampling.ordinal"]]}, "indexentries": {"bunke_shearer (noisetype attribute)": [[3, "prefsampling.approval.NoiseType.BUNKE_SHEARER"]], "hamming (noisetype attribute)": [[3, "prefsampling.approval.NoiseType.HAMMING"]], "jaccard (noisetype attribute)": [[3, "prefsampling.approval.NoiseType.JACCARD"]], "noisetype (class in prefsampling.approval)": [[3, "prefsampling.approval.NoiseType"]], "zelinka (noisetype attribute)": [[3, "prefsampling.approval.NoiseType.ZELINKA"]], "disjoint_resampling() (in module prefsampling.approval)": [[3, "prefsampling.approval.disjoint_resampling"]], "empty() (in module prefsampling.approval)": [[3, "prefsampling.approval.empty"]], "euclidean() (in module prefsampling.approval)": [[3, "prefsampling.approval.euclidean"]], "full() (in module prefsampling.approval)": [[3, "prefsampling.approval.full"]], "identity() (in module prefsampling.approval)": [[3, "prefsampling.approval.identity"]], "impartial() (in module prefsampling.approval)": [[3, "prefsampling.approval.impartial"]], "impartial_constant_size() (in module prefsampling.approval)": [[3, "prefsampling.approval.impartial_constant_size"]], "module": [[3, "module-prefsampling.approval"], [4, "module-prefsampling.core"], [4, "module-prefsampling.core.composition"], [4, "module-prefsampling.core.euclidean"], [4, "module-prefsampling.core.filters"], [6, "module-prefsampling.ordinal"]], "moving_resampling() (in module prefsampling.approval)": [[3, "prefsampling.approval.moving_resampling"]], "noise() (in module prefsampling.approval)": [[3, "prefsampling.approval.noise"]], "prefsampling.approval": [[3, "module-prefsampling.approval"]], "resampling() (in module prefsampling.approval)": [[3, "prefsampling.approval.resampling"]], "truncated_ordinal() (in module prefsampling.approval)": [[3, "prefsampling.approval.truncated_ordinal"]], "urn_partylist() (in module prefsampling.approval)": [[3, "prefsampling.approval.urn_partylist"]], "ball (euclideanspace attribute)": [[4, "prefsampling.core.euclidean.EuclideanSpace.BALL"]], "euclideanspace (class in prefsampling.core.euclidean)": [[4, "prefsampling.core.euclidean.EuclideanSpace"]], "gaussian (euclideanspace attribute)": [[4, "prefsampling.core.euclidean.EuclideanSpace.GAUSSIAN"]], "sphere (euclideanspace attribute)": [[4, "prefsampling.core.euclidean.EuclideanSpace.SPHERE"]], "uniform (euclideanspace attribute)": [[4, "prefsampling.core.euclidean.EuclideanSpace.UNIFORM"]], "concatenation() (in module prefsampling.core.composition)": [[4, "prefsampling.core.composition.concatenation"]], "election_positions() (in module prefsampling.core.euclidean)": [[4, "prefsampling.core.euclidean.election_positions"]], "mixture() (in module prefsampling.core.composition)": [[4, "prefsampling.core.composition.mixture"]], "permute_voters() (in module prefsampling.core.filters)": [[4, "prefsampling.core.filters.permute_voters"]], "prefsampling.core": [[4, "module-prefsampling.core"]], "prefsampling.core.composition": [[4, "module-prefsampling.core.composition"]], "prefsampling.core.euclidean": [[4, "module-prefsampling.core.euclidean"]], "prefsampling.core.filters": [[4, "module-prefsampling.core.filters"]], "rename_candidates() (in module prefsampling.core.filters)": [[4, "prefsampling.core.filters.rename_candidates"]], "resample_as_central_vote() (in module prefsampling.core.filters)": [[4, "prefsampling.core.filters.resample_as_central_vote"]], "balanced (treesampler attribute)": [[6, "prefsampling.ordinal.TreeSampler.BALANCED"]], "caterpillar (treesampler attribute)": [[6, "prefsampling.ordinal.TreeSampler.CATERPILLAR"]], "schroeder (treesampler attribute)": [[6, "prefsampling.ordinal.TreeSampler.SCHROEDER"]], "schroeder_lescanne (treesampler attribute)": [[6, "prefsampling.ordinal.TreeSampler.SCHROEDER_LESCANNE"]], "schroeder_uniform (treesampler attribute)": [[6, "prefsampling.ordinal.TreeSampler.SCHROEDER_UNIFORM"]], "treesampler (class in prefsampling.ordinal)": [[6, "prefsampling.ordinal.TreeSampler"]], "didi() (in module prefsampling.ordinal)": [[6, "prefsampling.ordinal.didi"]], "euclidean() (in module prefsampling.ordinal)": [[6, "prefsampling.ordinal.euclidean"]], "group_separable() (in module prefsampling.ordinal)": [[6, "prefsampling.ordinal.group_separable"]], "identity() (in module prefsampling.ordinal)": [[6, "prefsampling.ordinal.identity"]], "impartial() (in module prefsampling.ordinal)": [[6, "prefsampling.ordinal.impartial"]], "impartial_anonymous() (in module prefsampling.ordinal)": [[6, "prefsampling.ordinal.impartial_anonymous"]], "mallows() (in module prefsampling.ordinal)": [[6, "prefsampling.ordinal.mallows"]], "norm_mallows() (in module prefsampling.ordinal)": [[6, "prefsampling.ordinal.norm_mallows"]], "plackett_luce() (in module prefsampling.ordinal)": [[6, "prefsampling.ordinal.plackett_luce"]], "prefsampling.ordinal": [[6, "module-prefsampling.ordinal"]], "single_crossing() (in module prefsampling.ordinal)": [[6, "prefsampling.ordinal.single_crossing"]], "single_peaked_circle() (in module prefsampling.ordinal)": [[6, "prefsampling.ordinal.single_peaked_circle"]], "single_peaked_conitzer() (in module prefsampling.ordinal)": [[6, "prefsampling.ordinal.single_peaked_conitzer"]], "single_peaked_walsh() (in module prefsampling.ordinal)": [[6, "prefsampling.ordinal.single_peaked_walsh"]], "stratification() (in module prefsampling.ordinal)": [[6, "prefsampling.ordinal.stratification"]], "urn() (in module prefsampling.ordinal)": [[6, "prefsampling.ordinal.urn"]]}}) \ No newline at end of file +Search.setIndex({"docnames": ["index", "installation", "quickstart", "reference/approval/index", "reference/constants", "reference/core/index", "reference/index", "reference/inputvalidators", "reference/ordinal/index", "reference/tree/index", "validation/approval", "validation/index", "validation/ordinal", "validation/tree"], "filenames": ["index.rst", "installation.rst", "quickstart.rst", "reference/approval/index.rst", "reference/constants.rst", "reference/core/index.rst", "reference/index.rst", "reference/inputvalidators.rst", "reference/ordinal/index.rst", "reference/tree/index.rst", "validation/approval.rst", "validation/index.rst", "validation/ordinal.rst", "validation/tree.rst"], "titles": ["PrefSampling", "Installation", "Quick Start", "Approval", "Constants", "Core", "Reference", "Input Validators", "Ordinal", "Tree", "Approval Samplers", "Validation", "Ordinal Samplers", "Tree Samplers"], "terms": {"i": [0, 1, 2, 3, 5, 7, 8, 9, 10, 11, 12, 13], "lightweight": 0, "python": [0, 2, 11], "librari": 0, "provid": [0, 2, 5, 7, 9, 11], "prefer": [0, 2, 3, 8], "sampler": [0, 3, 6, 8, 9], "These": [0, 2, 3], "ar": [0, 2, 3, 5, 7, 8, 9, 11, 12], "algorithm": [0, 8, 9], "gener": [0, 3, 5, 8, 9, 10, 11, 12], "random": [0, 2, 3, 5, 8, 9], "base": [0, 2, 5, 10], "precis": 0, "defin": [0, 2, 3, 5, 8], "statist": 0, "cultur": [0, 3, 8, 12], "we": [0, 2, 5, 8, 10, 11, 12, 13], "consid": [0, 2, 3, 5, 8], "differ": [0, 2, 3, 5, 8, 12], "type": [0, 3, 4, 5, 8, 9], "ordin": [0, 3, 5, 6, 11], "express": 0, "rank": [0, 2, 8, 12], "candid": [0, 2, 3, 5, 8, 10, 12], "approv": [0, 5, 6, 11], "indic": [0, 8], "set": [0, 2, 3, 5, 8], "prefsampl": [1, 2, 10, 12, 13], "host": 1, "pypi": 1, "you": [1, 2, 3, 5, 8], "can": [1, 2, 3, 5, 7, 8, 12], "thu": [1, 10, 12, 13], "easili": 1, "us": [1, 2, 3, 5, 7, 8, 12], "pip3": 1, "The": [1, 2, 3, 5, 7, 8, 9, 10, 12], "sourc": [1, 3, 4, 5, 7, 8, 9], "code": [1, 5], "github": [1, 9], "repositori": [1, 9], "well": [1, 12], "format": [2, 5], "thei": [2, 12], "produc": [2, 12, 13], "modul": [2, 3, 4, 6, 8], "contain": [2, 8], "ones": [2, 3], "To": [2, 8, 11], "make": [2, 11], "easi": 2, "emb": 2, "all": [2, 3, 4, 5, 8, 9, 12, 13], "kind": 2, "tool": 2, "basic": 2, "return": [2, 3, 5, 8, 9], "collect": [2, 3, 5, 8], "np": [2, 5, 8], "ndarrai": [2, 5, 8], "numpi": [2, 3, 5, 8, 9], "arrai": 2, "where": [2, 3, 8, 12], "most": [2, 8], "posit": [2, 3, 5, 8], "0": [2, 3, 7, 8, 12], "next": [2, 8], "one": [2, 5, 8, 9, 12], "1": [2, 3, 4, 5, 8, 12], "so": [2, 8], "forth": 2, "each": [2, 3, 5, 8, 9, 11], "In": [2, 3, 8, 10, 12], "case": [2, 5, 8, 12], "name": [2, 3, 4, 5, 8], "2": [2, 3, 8, 12], "have": [2, 8, 12], "same": [2, 3, 5, 10, 12], "signatur": 2, "num_vot": [2, 3, 5, 8], "num_candid": [2, 3, 5, 8], "arg": 2, "seed": [2, 3, 5, 8, 9], "none": [2, 3, 4, 5, 7, 8, 9], "kwarg": 2, "paramet": [2, 3, 5, 7, 8, 9, 10], "repres": [2, 3, 5, 8], "number": [2, 3, 5, 8, 9, 12, 13], "pass": [2, 3, 5], "give": [2, 9], "more": [2, 8, 10, 11, 12], "control": [2, 8], "need": [2, 5], "replic": 2, "instanc": [2, 5, 8, 12], "other": [2, 3, 5, 8, 12], "specif": [2, 5, 8, 9], "refer": 2, "ident": [2, 3, 6, 8, 11], "imparti": [2, 3, 6, 8, 11], "impartial_anonym": [2, 6, 8, 12], "mallow": [2, 6, 8, 11], "phi": [2, 3, 8, 12], "central_vot": [2, 3, 5, 8], "default": [2, 3, 7, 8, 9], "normalise_phi": [2, 8], "fals": [2, 3, 8], "norm_mallow": [2, 6, 8], "norm_phi": [2, 8], "euclidean": [2, 3, 6, 8, 11], "space": [2, 3, 5, 8], "uniform": [2, 3, 5, 8, 9, 11, 12], "dimens": [2, 3, 5, 8], "plackett_luc": [2, 6, 8, 12], "alpha": [2, 3, 8, 12], "didi": [2, 6, 8, 11], "urn": [2, 3, 6, 8, 11], "stratif": [2, 6, 8, 11], "weight": [2, 5, 8, 12], "single_peaked_conitz": [2, 6, 8, 12], "single_peaked_walsh": [2, 6, 8, 12], "single_peaked_circl": [2, 6, 8, 12], "single_cross": [2, 6, 8, 12], "group_separ": [2, 6, 8, 12], "tree_sampl": [2, 8], "schroeder": [2, 8], "p": [2, 3, 10], "empti": [2, 3, 6, 8], "full": [2, 3, 6], "resampl": [2, 3, 5, 6, 11], "disjoint_resampl": [2, 3, 6, 10], "g": [2, 3, 5], "moving_resampl": [2, 3, 6], "num_leg": [2, 3], "radiu": [2, 3], "5": [2, 3, 8], "nois": [2, 3, 6, 11], "noise_typ": [2, 3], "ham": [2, 3, 10], "truncated_ordin": [2, 3, 6], "ordinal_sampl": [2, 3], "ordinal_sampler_paramet": [2, 3], "urn_partylist": [2, 3, 6], "parti": [2, 3], "It": [2, 5], "often": 2, "abl": 2, "compos": 2, "mixtur": [2, 5], "function": [2, 3, 5, 7, 8], "concaten": [2, 5], "do": [2, 8], "being": [2, 3, 5, 8, 10], "given": [2, 3, 5, 8, 9, 12], "probabl": [2, 3, 5, 8, 9, 10, 12, 13], "from": [2, 3, 5, 8, 9, 11, 12], "core": [2, 6], "import": [2, 5], "creat": 2, "100": 2, "voter": [2, 3, 5, 8, 12], "10": 2, "singl": [2, 3, 8, 10, 11], "peak": [2, 8, 11], "conitz": [2, 8, 12], "6": 2, "walsh": [2, 8, 12], "4": [2, 8], "list": [2, 3, 5, 8, 9], "model": [2, 3, 8, 10, 12], "3": [2, 8], "9": 2, "23": 2, "simpli": 2, "vote": [2, 3, 5, 8, 12], "60": 2, "40": 2, "per": [2, 3, 8], "oper": [2, 5], "appli": [2, 3, 5, 8], "some": [2, 5], "them": [2, 5, 8, 9], "implement": [2, 8, 11], "effect": 2, "permute_vot": [2, 5], "randomli": [2, 5, 8], "permut": [2, 5, 8], "rename_candid": [2, 5], "renam": [2, 5], "resample_as_central_vot": [2, 5], "central": [2, 3, 5, 8], "whose": 2, "definit": [2, 8], "includ": [2, 8], "e": [2, 3, 5, 8, 12], "below": [2, 10, 12, 13], "an": [2, 5, 7, 8, 10, 12], "exampl": [2, 12], "how": 2, "initial_vot": 2, "855": 2, "argument": [2, 3, 5, 7], "sampl": [3, 5, 8, 9, 10, 11], "which": [3, 5, 8], "either": [3, 7, 8], "disapprov": 3, "class": [3, 4, 5, 8, 12], "noisetyp": [2, 3, 6], "valu": [2, 3, 4, 5, 7, 8, 12], "qualnam": [3, 4, 5, 8], "start": [3, 4, 5, 8], "boundari": [3, 4, 5, 8], "constant": [3, 5, 6, 8], "bunke_shear": [2, 3], "bunk": 3, "shearer": 3, "jaccard": 3, "zelinka": 3, "int": [3, 5, 7, 8, 9], "float": [3, 5, 8], "disjoint": [3, 11], "denot": 3, "length": [3, 10, 12], "group": [3, 8, 11], "rais": [3, 7, 8], "valueerror": [3, 7, 8], "when": [3, 7, 8, 12], "interv": 3, "euclideanspac": [2, 3, 5, 8], "accord": [3, 8], "assign": [3, 8], "A": [3, 7, 8], "within": [3, 5, 8], "certain": 3, "word": 3, "distanc": [3, 8, 10, 12], "sever": [3, 8], "possibl": [3, 8, 9], "enumer": [2, 3, 8, 9, 13], "also": [2, 3, 8, 11, 12], "chang": [3, 8], "independ": [3, 5, 8], "follow": [3, 5, 8, 9, 10], "process": [3, 5, 8], "describ": [3, 8, 12], "abov": [3, 8], "should": [3, 5, 8], "simpl": 3, "onli": [3, 5, 8, 10, 12], "proport": [3, 8, 9], "under": [3, 8, 12], "ha": [3, 5, 10, 12, 13], "thi": [3, 5, 8, 9, 10, 11, 12, 13], "ensur": [3, 8, 9, 11, 12], "averag": 3, "ani": [3, 5, 8], "move": 3, "leg": 3, "callabl": [3, 5, 7], "dict": [3, 5], "truncat": 3, "wai": 3, "consist": 3, "first": [3, 7, 8, 11], "ratio": 3, "ot": 3, "overriden": 3, "those": 3, "partylist": 3, "fraction": 3, "size": [3, 8], "ballot": [3, 5, 10], "num_voters_per_sampl": 5, "sampler_paramet": 5, "togeth": [5, 8, 11], "form": 5, "final": [5, 8], "note": [5, 8, 12], "after": [5, 8], "onc": [5, 12], "assum": 5, "about": [5, 12], "If": [3, 5, 8, 9], "don": 5, "t": 5, "fail": [2, 5], "dictionari": 5, "keyword": 5, "taken": [5, 9], "account": 5, "work": [5, 8, 10], "distribut": [5, 8, 10, 11, 12, 13], "correspond": [2, 5, 8, 9], "over": [3, 5, 8, 12], "k": [5, 8, 10], "want": [5, 11], "particular": 5, "mutablesequ": 5, "order": [5, 8], "incomplet": 5, "input": [5, 6], "largest": 5, "integ": [5, 7], "appear": [5, 12], "accept": 5, "copi": [5, 8], "befor": [5, 8], "avoid": 5, "loss": 5, "data": 5, "ball": [2, 5], "gaussian": 5, "sphere": 5, "spheric": 5, "election_posit": 5, "rng": 5, "_gener": [], "respect": [2, 5, 8], "treesampl": [6, 8], "tree": [6, 8, 11, 12], "all_schroeder_tre": [6, 9], "caterpillar_tre": [6, 9], "schroeder_tre": [6, 9, 13], "schroeder_tree_brute_forc": [6, 9, 13], "schroeder_tree_lescann": [6, 9, 13], "composit": 6, "filter": 6, "unanim": 8, "equal": [8, 12], "like": [8, 12], "occur": [8, 12], "get": 8, "anonym": [8, 11], "everi": [8, 10, 12], "multi": 8, "For": [8, 12], "observ": [8, 10, 12], "b": 8, "wa": [8, 9], "8": 8, "see": [2, 8, 10, 12], "lepellei": 8, "valogn": 8, "2003": 8, "here": [8, 10, 12], "bool": [3, 8], "1957": 8, "parameteris": 8, "decreas": 8, "exponenti": 8, "between": [8, 11], "dispers": 8, "coeffici": 8, "kendal": 8, "tau": 8, "consider": 8, "close": 8, "render": 8, "far": 8, "awai": 8, "unlik": 8, "opposit": 8, "depend": 8, "applic": 8, "advis": 8, "normalis": 8, "especi": 8, "compar": 8, "boehmer": 8, "faliszewski": 8, "kraiczi": 8, "2023": 8, "detail": [8, 10], "true": [2, 3, 8], "option": [], "whether": 8, "arrang": 8, "shortcut": 8, "increas": 8, "closest": 8, "etc": 8, "plackett": [8, 11], "luce": [8, 11], "vector": 8, "intuit": 8, "qualiti": [8, 12], "m": [8, 12], "step": 8, "fill": 8, "up": 8, "least": 8, "initi": 8, "draw": 8, "select": [3, 8, 9], "its": 8, "Then": 8, "remov": 8, "re": 8, "similar": 8, "dirichlet": 8, "moreov": 8, "higher": 8, "sum": 8, "correl": 8, "concentr": 8, "point": 8, "veri": 8, "spirit": 8, "param": 8, "len": 8, "p\u00f3lya": 8, "eggenberg": 8, "turn": 8, "happen": 8, "With": [8, 12], "urn_siz": 8, "uniformli": [3, 8, 9], "both": 8, "put": 8, "back": [8, 12], "must": 8, "non": [8, 12], "neg": 8, "split": 8, "two": [7, 8, 11], "second": 8, "rel": 8, "upper": [7, 8], "2009": [8, 12], "axi": [8, 12], "left": 8, "right": 8, "come": 8, "method": 8, "iter": 8, "oppos": 8, "dist_peak_to_end": [8, 12], "minimum": [8, 12], "end": [8, 12], "2015": [8, 12], "leftmost": 8, "rightmost": 8, "yet": 8, "been": [8, 12], "circl": [8, 12], "inspir": 8, "peaked": 8, "line": 8, "determin": 8, "done": 8, "subsequ": 8, "take": 8, "avail": [8, 9], "term": 8, "circular": 8, "cross": [8, 11], "elkind": 8, "lackner": 8, "peter": 8, "2022": [8, 9, 10, 11], "domain": 8, "alwai": 8, "valid": [6, 8, 10, 12, 13], "swap": 8, "consecut": 8, "had": 8, "alreadi": 8, "previou": 8, "One": 8, "perform": 8, "admit": 8, "importantli": [8, 11], "success": 8, "further": 8, "down": 8, "than": [7, 8], "previous": 8, "latter": 8, "neutral": 8, "mean": 8, "lexicograph": 8, "obtain": [8, 12], "szufa": [8, 10], "skowron": 8, "slinko": 8, "talmon": 8, "2020": 8, "profil": [8, 12], "yield": [8, 12, 13], "procedur": [8, 9], "unknown": [8, 12, 13], "outcom": [8, 12], "single_crossing_imparti": 8, "becom": 8, "slow": [8, 13], "difficulti": 8, "li": 8, "comput": 8, "instead": 8, "separ": [8, 11], "seprabl": 8, "present": [8, 9, 10, 12, 13], "karpov": 8, "obraztsova": 8, "decomposit": 8, "intern": [8, 9], "node": [8, 9], "children": 8, "revers": 8, "label": 8, "leav": [8, 9, 13], "read": 8, "meant": 8, "howev": [2, 8, 12], "our": 8, "analysi": 8, "impact": 8, "balanc": 8, "caterpillar": [8, 9], "schr\u00f6der": [8, 9, 11], "alonso": [8, 9, 11], "r\u00e9my": [8, 9, 11], "schott": [8, 9, 11], "1997": [8, 11], "schroeder_lescann": 8, "lescann": [8, 9, 11], "schroeder_uniform": 8, "via": 8, "complet": 8, "num_leav": 9, "num_internal_nod": 9, "rerun": 9, "root": 9, "sch\u00f6der": 9, "suitabl": 9, "1997a": 9, "build": 9, "1997b": 9, "schro\u00f6der": 9, "particularli": 9, "ineffici": 9, "directcli": 9, "licenc": 9, "until": 9, "requir": 9, "achiev": 9, "reject": 9, "test": [7, 10, 11, 12, 13], "ran": [10, 12, 13], "binomi": 10, "et": 10, "al": 10, "what": [10, 11], "correct": 11, "packag": [4, 11], "variou": 11, "typic": 11, "sure": 11, "develop": 11, "featur": 11, "program": 11, "perspect": 11, "But": 11, "actual": 11, "displai": 11, "theoret": 11, "allow": 11, "u": 11, "ass": 11, "adequ": 11, "multiset": 12, "discuss": 12, "stratifi": 12, "fall": 12, "interest": 12, "govern": 12, "document": 12, "http": 12, "www": 12, "jstor": 12, "org": 12, "stabl": 12, "30024551": 12, "again": 12, "known": 12, "jmlr": 12, "paper": 12, "v15": 12, "lu14a": 12, "html": 12, "properti": 12, "proceed": 12, "mlr": 12, "press": 12, "v48": 12, "zhaob16": 12, "otherwis": 12, "know": 12, "littl": 12, "propos": 12, "design": 12, "isomorph": 12, "effici": [12, 13], "suppos": [12, 13], "doe": [12, 13], "practic": 13, "larg": 13, "impartial_central_vot": [2, 3, 8], "ignor": [3, 8], "partial": [], "impartial_constant_s": [2, 3, 6], "num_approv": [], "typeerror": 7, "rel_num_approv": [2, 3], "gather": 2, "shape": 5, "scr\u00f6der": 8, "alsonso": 8, "brute": 8, "forc": 8, "Not": 2, "direct": 2, "comparison": 2, "inde": 2, "evalu": 2, "validate_int": [6, 7], "validate_num_voters_candid": [6, 7], "value_descr": 7, "str": 7, "lower_bound": 7, "upper_bound": 7, "lower": 7, "bound": 7, "descript": 7, "messag": 7, "except": 7, "cannot": 7, "cast": 7, "strictli": 7, "smaller": 7, "greater": 7, "func": 7, "decor": 7, "larger": 7}, "objects": {"prefsampling": [[4, 0, 1, "", "CONSTANTS"], [3, 1, 0, "-", "approval"], [5, 1, 0, "-", "core"], [7, 1, 0, "-", "inputvalidators"], [8, 1, 0, "-", "ordinal"], [9, 1, 0, "-", "tree"]], "prefsampling.approval": [[3, 0, 1, "", "NoiseType"], [3, 3, 1, "", "disjoint_resampling"], [3, 3, 1, "", "empty"], [3, 3, 1, "", "euclidean"], [3, 3, 1, "", "full"], [3, 3, 1, "", "identity"], [3, 3, 1, "", "impartial"], [3, 3, 1, "", "impartial_constant_size"], [3, 3, 1, "", "moving_resampling"], [3, 3, 1, "", "noise"], [3, 3, 1, "", "resampling"], [3, 3, 1, "", "truncated_ordinal"], [3, 3, 1, "", "urn_partylist"]], "prefsampling.approval.NoiseType": [[3, 2, 1, "", "BUNKE_SHEARER"], [3, 2, 1, "", "HAMMING"], [3, 2, 1, "", "JACCARD"], [3, 2, 1, "", "ZELINKA"]], "prefsampling.core": [[5, 1, 0, "-", "composition"], [5, 1, 0, "-", "euclidean"], [5, 1, 0, "-", "filters"]], "prefsampling.core.composition": [[5, 3, 1, "", "concatenation"], [5, 3, 1, "", "mixture"]], "prefsampling.core.euclidean": [[5, 0, 1, "", "EuclideanSpace"], [5, 3, 1, "", "election_positions"]], "prefsampling.core.euclidean.EuclideanSpace": [[5, 2, 1, "", "BALL"], [5, 2, 1, "", "GAUSSIAN"], [5, 2, 1, "", "SPHERE"], [5, 2, 1, "", "UNIFORM"]], "prefsampling.core.filters": [[5, 3, 1, "", "permute_voters"], [5, 3, 1, "", "rename_candidates"], [5, 3, 1, "", "resample_as_central_vote"]], "prefsampling.inputvalidators": [[7, 3, 1, "", "validate_int"], [7, 3, 1, "", "validate_num_voters_candidates"]], "prefsampling.ordinal": [[8, 0, 1, "", "TreeSampler"], [8, 3, 1, "", "didi"], [8, 3, 1, "", "euclidean"], [8, 3, 1, "", "group_separable"], [8, 3, 1, "", "identity"], [8, 3, 1, "", "impartial"], [8, 3, 1, "", "impartial_anonymous"], [8, 3, 1, "", "mallows"], [8, 3, 1, "", "norm_mallows"], [8, 3, 1, "", "plackett_luce"], [8, 3, 1, "", "single_crossing"], [8, 3, 1, "", "single_peaked_circle"], [8, 3, 1, "", "single_peaked_conitzer"], [8, 3, 1, "", "single_peaked_walsh"], [8, 3, 1, "", "stratification"], [8, 3, 1, "", "urn"]], "prefsampling.ordinal.TreeSampler": [[8, 2, 1, "", "BALANCED"], [8, 2, 1, "", "CATERPILLAR"], [8, 2, 1, "", "SCHROEDER"], [8, 2, 1, "", "SCHROEDER_LESCANNE"], [8, 2, 1, "", "SCHROEDER_UNIFORM"]], "prefsampling.tree": [[9, 3, 1, "", "all_schroeder_tree"], [9, 3, 1, "", "caterpillar_tree"], [9, 3, 1, "", "schroeder_tree"], [9, 3, 1, "", "schroeder_tree_brute_force"], [9, 3, 1, "", "schroeder_tree_lescanne"]]}, "objtypes": {"0": "py:class", "1": "py:module", "2": "py:attribute", "3": "py:function"}, "objnames": {"0": ["py", "class", "Python class"], "1": ["py", "module", "Python module"], "2": ["py", "attribute", "Python attribute"], "3": ["py", "function", "Python function"]}, "titleterms": {"prefsampl": 0, "instal": 1, "quick": 2, "start": 2, "organis": 2, "packag": 2, "sampl": 2, "type": 2, "gener": 2, "syntax": 2, "ordin": [2, 8, 12], "sampler": [2, 5, 10, 11, 12, 13], "approv": [2, 3, 10], "composit": [2, 5], "filter": [2, 5], "core": 5, "modul": 5, "euclidean": [5, 12], "refer": 6, "tree": [9, 13], "imparti": [10, 12], "resampl": 10, "disjoint": 10, "nois": 10, "ident": 10, "valid": [7, 11], "procedur": 11, "anonym": 12, "stratif": 12, "urn": 12, "mallow": 12, "plackett": 12, "luce": 12, "didi": 12, "singl": 12, "peak": 12, "cross": 12, "group": 12, "separ": 12, "schr\u00f6der": 13, "alonso": 13, "r\u00e9my": 13, "schott": 13, "1997": 13, "lescann": 13, "2022": 13, "uniform": 13, "constant": [2, 4], "input": 7}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx": 60}, "alltitles": {"PrefSampling": [[0, "prefsampling"]], "Installation": [[1, "installation"]], "Tree": [[9, "module-prefsampling.tree"]], "Approval Samplers": [[10, "approval-samplers"], [2, "approval-samplers"]], "Impartial": [[10, "impartial"], [12, "impartial"]], "Resampling": [[10, "resampling"]], "Disjoint Resampling": [[10, "disjoint-resampling"]], "Noise": [[10, "noise"]], "Identity": [[10, "identity"]], "Validation": [[11, "validation"]], "Procedure": [[11, "procedure"]], "Validated Samplers": [[11, "validated-samplers"]], "Ordinal Samplers": [[12, "ordinal-samplers"], [2, "ordinal-samplers"]], "Impartial Anonymous": [[12, "impartial-anonymous"]], "Stratification": [[12, "stratification"]], "Urn": [[12, "urn"]], "Mallows": [[12, "mallows"]], "Plackett-Luce": [[12, "plackett-luce"]], "Didi": [[12, "didi"]], "Euclidean": [[12, "euclidean"]], "Single-Peaked": [[12, "single-peaked"]], "Single-Crossing": [[12, "single-crossing"]], "Group-Separable": [[12, "group-separable"]], "Tree Samplers": [[13, "tree-samplers"]], "Schr\u00f6der Trees by Alonso, R\u00e9my, Schott (1997)": [[13, "schroder-trees-by-alonso-remy-schott-1997"]], "Schr\u00f6der Trees by Lescanne (2022)": [[13, "schroder-trees-by-lescanne-2022"]], "Uniform Schr\u00f6der Trees": [[13, "uniform-schroder-trees"]], "Approval": [[3, "module-prefsampling.approval"]], "Composition of Samplers": [[5, "module-prefsampling.core.composition"], [2, "composition-of-samplers"]], "Filters": [[5, "module-prefsampling.core.filters"], [2, "filters"]], "Core": [[5, "module-prefsampling.core"]], "Module core.euclidean": [[5, "module-prefsampling.core.euclidean"]], "Ordinal": [[8, "module-prefsampling.ordinal"]], "Quick Start": [[2, "quick-start"]], "Organisation of the package": [[2, "organisation-of-the-package"]], "Sample Types": [[2, "sample-types"]], "General Syntax": [[2, "general-syntax"]], "Constants": [[2, "constants"], [4, "constants"]], "Reference": [[6, "reference"]], "Input Validators": [[7, "module-prefsampling.inputvalidators"]]}, "indexentries": {"constants (class in prefsampling)": [[4, "prefsampling.CONSTANTS"]], "module": [[7, "module-prefsampling.inputvalidators"]], "prefsampling.inputvalidators": [[7, "module-prefsampling.inputvalidators"]], "validate_int() (in module prefsampling.inputvalidators)": [[7, "prefsampling.inputvalidators.validate_int"]], "validate_num_voters_candidates() (in module prefsampling.inputvalidators)": [[7, "prefsampling.inputvalidators.validate_num_voters_candidates"]]}}) \ No newline at end of file