summaryrefslogtreecommitdiff
path: root/src/de/lmu/ifi/dbs/elki/distance/distancevalue/NumberDistance.java
blob: b5b534eee53e1f48946383ad41831305490d7cba (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
package de.lmu.ifi.dbs.elki.distance.distancevalue;

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

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


/**
 * Provides a Distance for a number-valued distance.
 * 
 * @author Elke Achtert
 * 
 * @apiviz.landmark
 * @apiviz.composedOf Number
 * 
 * @param <D> the (final) type of NumberDistance used
 * @param <N> the type of Number used (e.g. Double, Integer, Float, etc.)
 */
public abstract class NumberDistance<D extends NumberDistance<D, N>, N extends Number> extends AbstractDistance<D> {
  /**
   * Constructs a new NumberDistance object that represents the value argument.
   */
  public NumberDistance() {
    super();
  }
  
  /**
   * Build a new instance from a double value.
   * 
   * @param val Value
   * @return Distance
   */
  public abstract D fromDouble(double val);

  /**
   * Returns the hash code for this NumberDistance, which is the hash code of
   * its value.
   * 
   * @return the hash code of the value
   */
  @Override
  public int hashCode() {
    return getValue().hashCode();
  }

  /**
   * Compares this NumberDistance with the given NumberDistance wrt the
   * represented value.
   * <p/>
   * <code>d1.compareTo(d2)</code> is the same as
   * {@link Double#compare(double,double) Double.compare(d1.value.doubleValue(),
   * d2.value.doubleValue())}. Subclasses may need to overwrite this method if
   * necessary.
   * 
   * @param other Other object
   * @return a negative integer, zero, or a positive integer as the value of
   *         this NumberDistance is less than, equal to, or greater than the
   *         value of the specified NumberDistance.
   */
  @Override
  public int compareTo(D other) {
    return Double.compare(this.doubleValue(), other.doubleValue());
  }

  /**
   * Returns a string representation of this NumberDistance.
   * 
   * @return the value of this NumberDistance.
   */
  @Override
  public final String toString() {
    return getValue().toString();
  }

  /**
   * Returns the value of this NumberDistance.
   * 
   * @return the value of this NumberDistance
   */
  public abstract N getValue();

  /**
   * Sets the value of this NumberDistance.
   * 
   * @param value the value to be set
   */
  abstract void setValue(N value);
  
  /**
   * Get the value as double.
   * 
   * @return same result as getValue().doubleValue() but may be more efficient.
   */
  public abstract double doubleValue();
  
  /**
   * Get the value as float.
   * 
   * @return same result as getValue().floatValue() but may be more efficient.
   */
  public float floatValue() {
    return (float) doubleValue();
  }
  
  /**
   * Get the value as int.
   * 
   * @return same result as getValue().intValue() but may be more efficient.
   */
  public int intValue() {
    return (int) longValue();
  }
  
  /**
   * Get the value as long.
   * 
   * @return same result as getValue().longValue() but may be more efficient.
   */
  public abstract long longValue();
  
  /**
   * Get the value as short.
   * 
   * @return same result as getValue().shortValue() but may be more efficient.
   */
  public short shortValue() {
    return (short) longValue();
  }
  
  /**
   * Get the value as byte.
   * 
   * @return same result as getValue().byteValue() but may be more efficient.
   */
  public byte byteValue() {
    return (byte) longValue();
  }
}