Skip to content

Commit

Permalink
Merge pull request #197 from lcgraham/v2_master
Browse files Browse the repository at this point in the history
fixed docstring
  • Loading branch information
lcgraham committed May 24, 2016
2 parents db61624 + 728e7cc commit 30347bf
Showing 1 changed file with 13 additions and 6 deletions.
19 changes: 13 additions & 6 deletions bet/sample.py
Original file line number Diff line number Diff line change
Expand Up @@ -865,15 +865,22 @@ def estimate_local_volume(self, num_l_emulate_local=100,
max_num_l_emulate=1e3):
r"""
Exactly calculates the volume fraction of the Voronoice cells associated
with ``samples``. Specifically we are calculating
:math:`\mu_\Lambda(\mathcal(V)_{i,N} \cap A)/\mu_\Lambda(\Lambda)`. Here
all of the samples are drawn from the generalized Lp uniform distribution.
Estimates the volume fraction of the Voronoice cells associated
with ``samples``. Specifically we are calculating
:math:`\mu_\Lambda(\mathcal(V)_{i,N} \cap A)/\mu_\Lambda(\Lambda)`.
Here all of the samples are drawn from the generalized Lp uniform
distribution.
.. note ::
Estimated radii of the Voronoi cell associated with each sample.
WARNING: The ``input_domain`` MUST be scaled to the unit square.
If this :class:`~bet.sample.voronoi_sample_set` has exact/estimated
radii of the Voronoi cell associated with each sample for a domain
normalized to the unit hypercube (``_normalized_radii``).
.. todo ::
When we move away from domains defined on hypercubes this will need
to be updated to use whatever ``_in_domain`` method exists.
Volume of the L-p ball is obtained from Wang, X.. (2005). Volumes of
Generalized Unit Balls. Mathematics Magazine, 78(5), 390-395.
Expand Down

0 comments on commit 30347bf

Please sign in to comment.