Skip to content

Commit ef337bc

Browse files
committed
Fix javadoc for module "statistics" (#396)
1 parent aa39675 commit ef337bc

File tree

2 files changed

+15
-0
lines changed

2 files changed

+15
-0
lines changed

metafacture-statistics/src/main/java/org/metafacture/statistics/CooccurrenceMetricCalculator.java

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,13 +98,23 @@ enum Metric {
9898

9999
private final List<Metric> metrics = new ArrayList<Metric>();
100100

101+
/**
102+
* Constructs a CooccurrenceMetricCalculator with given metrics.
103+
*
104+
* @param allMetrics the Metrics as a comma separated String
105+
*/
101106
public CooccurrenceMetricCalculator(final String allMetrics) {
102107
setMinCount(MIN_COUNT);
103108
for (final String metric : allMetrics.split("\\s*,\\s*")) {
104109
metrics.add(Metric.valueOf(metric));
105110
}
106111
}
107112

113+
/**
114+
* Constructs a CooccurrenceMetricCalculator with given metrics.
115+
*
116+
* @param metrics the Metrics as an array
117+
*/
108118
public CooccurrenceMetricCalculator(final Metric... metrics) {
109119
setMinCount(MIN_COUNT);
110120
for (final Metric metric : metrics) {

metafacture-statistics/src/main/java/org/metafacture/statistics/UniformSampler.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,11 @@ public final class UniformSampler<T> extends
4949

5050
private long count;
5151

52+
/**
53+
* Constructs a UniformSampler with a given sample size.
54+
*
55+
* @param sampleSize the size of the sample
56+
*/
5257
public UniformSampler(final int sampleSize) {
5358
this.sampleSize = sampleSize;
5459
sample = new ArrayList<T>(sampleSize);

0 commit comments

Comments
 (0)