betanalpha / jamon Goto Github PK

Jamón: An Implementation of Constrained Hamiltonian Monte Carlo
A suite of classes facilitating generalized Hamiltonian 
Monte Carlo (both constrained and unconstrainted).
For details see http://arxiv.org/abs/1112.4118 

baseHamiltonian defines the interface for the
target distribution, in particular the kinetic
energy, the potential energy, the evolution
of the position and momentum, and any constraints.
chainBundle provides a container of baseHamiltonians,
including the functionality to perform HMC transitions,
diagnose convergence, and analyse samples.

Specifically, the code implements Hamiltonians defined
on Euclidean and Riemannian manifolds (i.e. with
kinetic energies given by quadratic forms):

    - constMetric (Euclidean Metrics)
        - diagConstMetric  (Diagonal)
        - denseConstMetric (Dense)

    - dynamMetric (Riemannian Metrics)

        - denseFisherMetric (Dense Fisher-Rao)
        - softAbsMetric (Dense SoftAbs)

            - Approximations to the SoftAbs Metric
                - diagSoftAbsMetric (Diagonal)
                - outerSoftAbsMetric (Outer-Product)
                - diagOuterSoftAbsMetric (Diagonal Outer-Product)

Example implementations include a multivariate Gaussian
and Neal's "funnel" distribution.


Matrix operations are performed with the Eigen
template library: http://eigen.tuxfamily.org/

Random number generation is handled with the
randomlib library: http://randomlib.sourceforge.net/

Option plotting available with gnuplot:
http://www.gnuplot.info/

Copyright Michael Betancourt 2012
[email protected]

Permission is hereby granted, free of charge, to any person obtaining a 
copy of this software and associated documentation files (the "Software"), 
to deal in the Software without restriction, including without limitation 
the rights to use, copy, modify, merge, publish, distribute, sublicense, 
and/or sell copies of the Software, and to permit persons to whom the 
Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be 
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES 
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, 
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR 
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE 
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.