summaryrefslogtreecommitdiff
path: root/src/de/lmu/ifi/dbs/elki/utilities/datastructures/histogram/DoubleArrayStaticHistogram.java
blob: aeba3c4b6052d00008985caed59897767131a3b9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
package de.lmu.ifi.dbs.elki.utilities.datastructures.histogram;

/*
This file is part of ELKI:
Environment for Developing KDD-Applications Supported by Index-Structures

Copyright (C) 2012
Ludwig-Maximilians-Universität München
Lehr- und Forschungseinheit für Datenbanksysteme
ELKI Development Team

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

/**
 * Histogram containing an array of doubles (i.e. {@code double[]}). This is
 * actually one of the simpler specializations, as arrays are objects not
 * primitive in Java.
 * 
 * @author Erich Schubert
 */
public final class DoubleArrayStaticHistogram extends AbstractObjStaticHistogram<double[]> {
  /**
   * Desired number of columns in each bin.
   */
  private final int cols;

  /**
   * Constructor.
   * 
   * @param bins Number of bins
   * @param min Minimum value for the coordinates
   * @param max Maximum value for the coordinates
   * @param cols Number of columns in each bin.
   */
  public DoubleArrayStaticHistogram(int bins, double min, double max, int cols) {
    super(bins, min, max);
    this.cols = cols;
    for (int i = 0; i < bins; i++) {
      data[i] = new double[cols];
    }
  }

  /**
   * Increment histogram by a double[].
   * 
   * @param coord Coordinate
   * @param data Data to increment by.
   */
  public void increment(double coord, double[] data) {
    double[] existing = get(coord);
    for (int i = 0; i < existing.length; i++) {
      existing[i] += data[i];
    }
  }

  /**
   * {@inheritDoc}
   * 
   * Data is combined by incrementing.
   * 
   * @deprecated use the explicit {@link #increment} instead.
   */
  @Deprecated
  @Override
  public void putData(double coord, double[] data) {
    increment(coord, data);
  }

  @Override
  protected double[] makeObject() {
    return new double[cols];
  }
}