stat/distuv: improve interface documentation
package distuv
+// LogProber wraps the LogProb method.
type LogProber interface {
- LogProb(float64) float64
+ // LogProb returns the natural logarithm of the
+ // value of the probability density or probability
+ // mass function at x.
+ LogProb(x float64) float64
}
+// Rander wraps the Rand method.
type Rander interface {
+ // Rand returns a random sample drawn from the distribution.
Rand() float64
}
+// RandLogProber is the interface that groups the Rander and LogProber methods.
type RandLogProber interface {
Rander
LogProber
}
+// Quantiler wraps the Quantile method.
type Quantiler interface {
+ // Quantile returns the minimum value of x from amongst
+ // all those values whose CDF value exceeds or equals p.
Quantile(p float64) float64
}
