summaryrefslogtreecommitdiff
path: root/src/de/lmu/ifi/dbs/elki/utilities/datastructures/histogram/AbstractObjStaticHistogram.java
blob: 4a1649af888f87a47f872b31d331d8d04a5d90fe (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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
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) 2013
 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 class storing double values.
 * 
 * The histogram will start with "bin" bins, but it can grow dynamicall to the
 * left and right.
 * 
 * @author Erich Schubert
 * 
 * @param <T> Data type
 */
public abstract class AbstractObjStaticHistogram<T> extends AbstractStaticHistogram implements ObjHistogram<T> {
  /**
   * Data store
   */
  Object[] data;

  /**
   * Special value storage: infinity, NaN
   */
  Object[] special = null;

  /**
   * Constructor.
   * 
   * @param bins Number of bins
   * @param min Cover minimum
   * @param max Cover maximum
   */
  public AbstractObjStaticHistogram(int bins, double min, double max) {
    super(bins, min, max);
    if (bins >= 0) {
      // -1 will be used by FlexiHistogram to delay initialization.
      data = new Object[bins];
      for (int i = 0; i < bins; i++) {
        data[i] = makeObject();
      }
    }
  }

  /**
   * Access the value of a bin with new data.
   * 
   * @param coord Coordinate
   * @return bin contents
   */
  @SuppressWarnings("unchecked")
  public T get(double coord) {
    if (coord == Double.NEGATIVE_INFINITY) {
      return getSpecial(0);
    }
    if (coord == Double.POSITIVE_INFINITY) {
      return getSpecial(1);
    }
    if (Double.isNaN(coord)) {
      return getSpecial(2);
    }
    int bin = getBinNr(coord);
    if (bin < 0) {
      if (size - bin > data.length) {
        // Reallocate. TODO: use an arraylist-like grow strategy!
        Object[] tmpdata = new Object[growSize(data.length, size - bin)];
        System.arraycopy(data, 0, tmpdata, -bin, size);
        data = tmpdata;
      } else {
        // Shift in place
        System.arraycopy(data, 0, data, -bin, size);
      }
      for (int i = 0; i < -bin; i++) {
        data[i] = makeObject();
      }
      // Note that bin is negative, -bin is the shift offset!
      offset -= bin;
      size -= bin;
      // TODO: modCounter++; and have iterators fast-fail
      // Unset max value when resizing
      max = Double.MAX_VALUE;
      return (T) data[0];
    } else if (bin >= size) {
      if (bin >= data.length) {
        Object[] tmpdata = new Object[growSize(data.length, bin + 1)];
        System.arraycopy(data, 0, tmpdata, 0, size);
        data = tmpdata;
      }
      for (int i = size; i <= bin; i++) {
        data[i] = makeObject();
      }
      size = bin + 1;
      // TODO: modCounter++; and have iterators fast-fail
      // Unset max value when resizing
      max = Double.MAX_VALUE;
      return (T) data[bin];
    } else {
      return (T) data[bin];
    }
  }

  /**
   * Ensure that we have storage for special values (infinity, NaN)
   * 
   * @param idx Index to return.
   */
  @SuppressWarnings("unchecked")
  protected T getSpecial(int idx) {
    if (special == null) {
      special = new Object[] { makeObject(), makeObject(), makeObject() };
    }
    return (T) special[idx];
  }

  /**
   * Class to make a new object for the data store.
   * 
   * @return New instance.
   */
  protected abstract T makeObject();

  @Override
  public Iter iter() {
    return new Iter();
  }

  /**
   * Iterator class.
   * 
   * @author Erich Schubert
   */
  public class Iter extends AbstractStaticHistogram.Iter implements ObjHistogram.Iter<T> {
    @SuppressWarnings("unchecked")
    @Override
    public T getValue() {
      return (T) data[bin];
    }
  }
}