viff

changeset 1403:aa82aa9b79aa

doc: shorten links by showing only the final part
author Martin Geisler <mg@cs.au.dk>
date Thu, 10 Dec 2009 13:21:18 +0100
parents 8fc8a6057bcd
children 0504115641a3
files doc/bibliography.txt doc/preprocessing.txt doc/program-counters.txt viff/aes.py viff/prss.py
diffstat 5 files changed, 11 insertions(+), 11 deletions(-) [+]
line diff
     1.1 --- a/doc/bibliography.txt	Thu Dec 10 10:07:35 2009 +0100
     1.2 +++ b/doc/bibliography.txt	Thu Dec 10 13:21:18 2009 +0100
     1.3 @@ -30,7 +30,7 @@
     1.4  
     1.5  * The pseudo-random secret sharing (PRSS) in ``viff.prss`` is
     1.6    described in [CDI05]_. The
     1.7 -  :meth:`viff.runtime.Runtime.prss_share_bit_double` method uses a
     1.8 +  :meth:`~viff.runtime.Runtime.prss_share_bit_double` method uses a
     1.9    protocol described in [Damgård08]_.
    1.10  
    1.11  * The protocol for equality testing with secret shared result is from
     2.1 --- a/doc/preprocessing.txt	Thu Dec 10 10:07:35 2009 +0100
     2.2 +++ b/doc/preprocessing.txt	Thu Dec 10 13:21:18 2009 +0100
     2.3 @@ -73,7 +73,7 @@
     2.4  --------------------------
     2.5  
     2.6  Preprocessing is implemented using two tools: the
     2.7 -:func:`viff.runtime.preprocess` decorator is used on methods that
     2.8 +:func:`~viff.runtime.preprocess` decorator is used on methods that
     2.9  produce data which can be preprocessed. It replaces the methods with
    2.10  proxies which will attempt to return preprocessed data. If the data
    2.11  could not be satisfied from the pool of preprocessed data, then the
    2.12 @@ -81,7 +81,7 @@
    2.13  to calculating the data online using the original method.
    2.14  
    2.15  To generate preprocessed data based on a trace of program counters one
    2.16 -must call the :meth:`viff.runtime.BasicRuntime.preprocess` method. It
    2.17 +must call the :meth:`~viff.runtime.BasicRuntime.preprocess` method. It
    2.18  returns a :class:`Deferred` which triggers when all preprocessed data
    2.19  is ready which means that the online part of the computation can
    2.20  begin.
     3.1 --- a/doc/program-counters.txt	Thu Dec 10 10:07:35 2009 +0100
     3.2 +++ b/doc/program-counters.txt	Thu Dec 10 13:21:18 2009 +0100
     3.3 @@ -78,7 +78,7 @@
     3.4  The solution used now in VIFF has two ingredients. First, callbacks
     3.5  that depend on the program counter (like `func`:shamir_share in our
     3.6  example above) are not added with :meth:`addCallback` but instead with
     3.7 -the special :meth:`viff.runtime.BasicRuntime.schedule_callback`
     3.8 +the special :meth:`~viff.runtime.BasicRuntime.schedule_callback`
     3.9  method. This method saves the program counter in effect at the time of
    3.10  the its call, and ensures that the saved program counter is
    3.11  temporarily made active when the callback is called.
    3.12 @@ -92,7 +92,7 @@
    3.13  cases:
    3.14  
    3.15  * when a callback is scheduled using
    3.16 -  :meth:`viff.runtime.BasicRuntime.schedule_callback`, a new
    3.17 +  :meth:`~viff.runtime.BasicRuntime.schedule_callback`, a new
    3.18    sub-program counter is allocated. A sub-program counter is simply a
    3.19    program counter with another digit. Because of the asynchronous
    3.20    network, the callback will be invoked at an unknown later time. When
    3.21 @@ -143,8 +143,8 @@
    3.22  
    3.23  The problem with this idea is that we sometimes need to assign a
    3.24  history to a variable that depends on no other variables. An example
    3.25 -of this is the result of a call to :meth:`prss_share
    3.26 -<viff.runtime.Runtime.prss_share>` which takes no useful arguments. A
    3.27 +of this is the result of a call to
    3.28 +:meth:`~viff.runtime.Runtime.prss_share` which takes no useful arguments. A
    3.29  possible solution would be to add some dummy arguments on which the
    3.30  history could be based, even though they wont be used by the method.
    3.31  So if you would normally call the function :func:`hat` with no
     4.1 --- a/viff/aes.py	Thu Dec 10 10:07:35 2009 +0100
     4.2 +++ b/viff/aes.py	Thu Dec 10 13:21:18 2009 +0100
     4.3 @@ -56,7 +56,7 @@
     4.4  class AES:
     4.5      """AES instantiation.
     4.6  
     4.7 -    This class is used together with a :class:`viff.runtime.Runtime`
     4.8 +    This class is used together with a :class:`~viff.runtime.Runtime`
     4.9      object::
    4.10  
    4.11          aes = AES(runtime, 192)
     5.1 --- a/viff/prss.py	Thu Dec 10 10:07:35 2009 +0100
     5.2 +++ b/viff/prss.py	Thu Dec 10 13:21:18 2009 +0100
     5.3 @@ -25,9 +25,9 @@
     5.4  PRSS relies on each player having access to a set of previously
     5.5  distributed pseudo-random functions (PRFs) --- or rather the seeds for
     5.6  such functions. In VIFF, such seeds are generated by
     5.7 -:func:`viff.config.generate_configs`. The
     5.8 -:meth:`viff.config.Player.prfs` and
     5.9 -:meth:`viff.config.Player.dealer_prfs` methods give access to the
    5.10 +:func:`~viff.config.generate_configs`. The
    5.11 +:meth:`~viff.config.Player.prfs` and
    5.12 +:meth:`~viff.config.Player.dealer_prfs` methods give access to the
    5.13  PRFs.
    5.14  
    5.15  In this module the function :func:`prss` is used to calculate shares