summaryrefslogtreecommitdiff
path: root/elki/src/main/java/de/lmu/ifi/dbs/elki/data/type/VectorFieldTypeInformation.java
blob: e6526c6160c4d823047a294955b44ca4e0188ea4 (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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
package de.lmu.ifi.dbs.elki.data.type;

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

 Copyright (C) 2015
 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/>.
 */

import de.lmu.ifi.dbs.elki.data.FeatureVector;
import de.lmu.ifi.dbs.elki.utilities.io.ByteBufferSerializer;

/**
 * Type information to specify that a type has a fixed dimensionality.
 *
 * @author Erich Schubert
 *
 * @param <V> Vector type
 */
public class VectorFieldTypeInformation<V extends FeatureVector<?>> extends VectorTypeInformation<V> implements FieldTypeInformation {
  /**
   * Constructor for a type request without dimensionality constraints.
   *
   * @param cls Class constraint
   * @param <V> vector type
   */
  public static <V extends FeatureVector<?>> VectorFieldTypeInformation<V> typeRequest(Class<? super V> cls) {
    return new VectorFieldTypeInformation<>(cls, -1, Integer.MAX_VALUE);
  }

  /**
   * Constructor for a type request with dimensionality constraints.
   *
   * @param cls Class constraint
   * @param mindim Minimum dimensionality
   * @param maxdim Maximum dimensionality
   * @param <V> vector type
   */
  public static <V extends FeatureVector<?>> VectorFieldTypeInformation<V> typeRequest(Class<? super V> cls, int mindim, int maxdim) {
    return new VectorFieldTypeInformation<>(cls, mindim, maxdim);
  }

  /**
   * Labels.
   */
  private String[] labels = null;

  /**
   * Constructor with given dimensionality and factory, so usually an instance.
   *
   * @param factory Factory class
   * @param dim Dimensionality
   * @param labels Labels
   * @param serializer Serializer
   */
  public VectorFieldTypeInformation(FeatureVector.Factory<V, ?> factory, int dim, String[] labels, ByteBufferSerializer<? super V> serializer) {
    super(factory, serializer, dim, dim);
    this.labels = labels;
    assert(labels == null || labels.length == dim) : "Created vector field with incomplete labels.";
  }

  /**
   * Constructor with given dimensionality and factory, so usually an instance.
   *
   * @param factory Factory class
   * @param mindim Minimum dimensionality
   * @param maxdim Maximum dimensionality
   * @param serializer Serializer
   */
  public VectorFieldTypeInformation(FeatureVector.Factory<V, ?> factory, int mindim, int maxdim, ByteBufferSerializer<? super V> serializer) {
    super(factory, serializer, mindim, maxdim);
  }

  /**
   * Constructor with given dimensionality and factory, so usually an instance.
   *
   * @param factory Factory class
   * @param dim Dimensionality
   * @param serializer Serializer
   */
  public VectorFieldTypeInformation(FeatureVector.Factory<V, ?> factory, int dim, ByteBufferSerializer<? super V> serializer) {
    super(factory, serializer, dim, dim);
  }

  /**
   * Constructor with given dimensionality and factory, so usually an instance.
   *
   * @param factory Factory class
   * @param dim Dimensionality
   * @param labels Labels
   */
  public VectorFieldTypeInformation(FeatureVector.Factory<V, ?> factory, int dim, String[] labels) {
    super(factory, factory.getDefaultSerializer(), dim, dim);
    this.labels = labels;
    assert(labels == null || labels.length == dim) : "Created vector field with incomplete labels.";
  }

  /**
   * Constructor for a request with minimum and maximum dimensionality.
   *
   * @param cls Vector restriction class.
   * @param mindim Minimum dimensionality request
   * @param maxdim Maximum dimensionality request
   */
  private VectorFieldTypeInformation(Class<? super V> cls, int mindim, int maxdim) {
    super(cls, mindim, maxdim);
  }

  /**
   * Constructor with given dimensionality and factory, so usually an instance.
   *
   * @param factory Factory class
   * @param dim Dimensionality
   */
  public VectorFieldTypeInformation(FeatureVector.Factory<V, ?> factory, int dim) {
    super(factory, factory.getDefaultSerializer(), dim, dim);
  }

  @Override
  public boolean isAssignableFromType(TypeInformation type) {
    if(this == type) {
      return true;
    }
    // Do all checks from superclass
    if(!super.isAssignableFromType(type)) {
      return false;
    }
    // Additionally check that mindim == maxdim.
    VectorTypeInformation<?> other = (VectorTypeInformation<?>) type;
    if(other.mindim != other.maxdim) {
      return false;
    }
    return true;
  }

  @Override
  public int getDimensionality() {
    if(mindim != maxdim) {
      throw new UnsupportedOperationException("Requesting dimensionality for a type request without defined dimensionality!");
    }
    return mindim;
  }

  @Override
  public String toString() {
    StringBuilder buf = new StringBuilder(getRestrictionClass().getSimpleName());
    if(mindim == maxdim) {
      buf.append(",dim=").append(mindim);
    }
    else {
      buf.append(",field");
      if(mindim >= 0) {
        buf.append(",mindim=").append(mindim);
      }
      if(maxdim < Integer.MAX_VALUE) {
        buf.append(",maxdim=").append(maxdim);
      }
    }
    return buf.toString();
  }

  /**
   * Get the column label.
   *
   * @param col Column number
   * @return Label
   */
  public String getLabel(int col) {
    if(labels == null) {
      return null;
    }
    return labels[col];
  }

  /**
   * Get the column labels.
   *
   * @return labels
   */
  protected String[] getLabels() {
    return labels;
  }
}