Reference
=========

Helpers
"""""""""

.. autosummary::
   :caption: Helpers
   :toctree: generated/
   :template: ../_templates/autosummary/base.rst

   hopsy.compute_chebyshev_center
   hopsy.generate_unit_hypercube
   hopsy.generate_unit_simplex
   hopsy.is_polytope_empty
   hopsy.run_multiphase_sampling
   hopsy.simplify

.. autosummary::
   :toctree: generated/
   :template: ../_templates/autosummary/class.rst

   hopsy.BirkhoffPolytope
   hopsy.LP

Models
""""""

.. autosummary::
   :caption: Models
   :toctree: generated/
   :template: ../_templates/autosummary/class.rst

   hopsy.Model
   hopsy.Gaussian
   hopsy.Mixture
   hopsy.Rosenbrock

Problem
"""""""

.. autosummary::
   :caption: Problem
   :toctree: generated/
   :template: ../_templates/autosummary/class.rst

   hopsy.Problem

.. autosummary::
   :toctree: generated/
   :template: ../_templates/autosummary/base.rst

   hopsy.round
   hopsy.add_box_constraints
   hopsy.add_equality_constraints
   hopsy.back_transform
   hopsy.transform

Proposals
"""""""""

.. autosummary::
   :caption: Proposals
   :toctree: generated/
   :template: ../_templates/autosummary/class.rst

   hopsy.Proposal
   hopsy.AdaptiveMetropolisProposal
   hopsy.BallWalkProposal
   hopsy.BilliardWalkProposal
   hopsy.CSmMALAProposal
   hopsy.DikinWalkProposal
   hopsy.GaussianCoordinateHitAndRunProposal
   hopsy.GaussianHitAndRunProposal
   hopsy.GaussianProposal
   hopsy.ReversibleJumpProposal
   hopsy.UniformCoordinateHitAndRunProposal
   hopsy.UniformHitAndRunProposal
   hopsy.TruncatedGaussianProposal

Random
""""""

.. autosummary::
   :caption: Random
   :toctree: generated/
   :template: ../_templates/autosummary/random_class.rst

   hopsy.RandomNumberGenerator
   hopsy.Uniform
   hopsy.Normal

Sampling
""""""""

.. autosummary::
   :caption: Markov Chain
   :toctree: generated/
   :template: ../_templates/autosummary/class.rst

   hopsy.MarkovChain

.. autosummary::
   :toctree: generated/
   :template: ../_templates/autosummary/base.rst

   hopsy.setup
   hopsy.sample

Diagnostics
"""""""""""

.. autosummary::
   :caption: Diagnostics
   :toctree: generated/
   :template: ../_templates/autosummary/base.rst

   hopsy.ess
   hopsy.mcse
   hopsy.rhat

Tuning
""""""

.. autosummary::
   :toctree: generated/
   :template: ../_templates/autosummary/base.rst

   hopsy.tune