Diff of /src/modules/glm/samplers/AuxMixNormal.h [01a998] .. [081fbe]  Maximize  Restore

Switch to side-by-side view

--- a/src/modules/glm/samplers/AuxMixNormal.h
+++ b/src/modules/glm/samplers/AuxMixNormal.h
@@ -6,7 +6,10 @@
 namespace glm {
 
     /**
-     * Normal distribution as a trivial auxiliary mixture
+     * @short Normal distribution as a trivial auxiliary mixture
+     *
+     * In order to allow GLMs with heterogeneous outcomes, we provide
+     * a trivial AuxMix wrapper for normal random variables.
      */
     class AuxMixNormal : public AuxMix
     {
@@ -20,8 +23,19 @@
 	 * @param y Value of normal random variable
 	 */
 	AuxMixNormal(double const &tau, double const &y);
+	/**
+	 * This does nothing, as there is no approximation to update.
+	 */
 	void update(RNG *rng);
+	/**
+	 * Returns the value of the normal random variable (y in the
+	 * constructor)
+	 */
 	double value() const;
+	/**
+	 * Returns the precision of the normal random variable (tau
+	 * in the constructor)
+	 */
 	double precision() const;
     };