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
|
package de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters;
/*
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/>.
*/
import java.util.List;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.OptionID;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.WrongParameterValueException;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.constraints.ParameterConstraint;
/**
* Parameter class for a parameter specifying a double value.
*
* @author Steffi Wanka
* @author Erich Schubert
*/
public class DoubleParameter extends NumberParameter<Double> {
/**
* Constructs a double parameter with the given optionID, parameter
* constraints, and default value.
*
* @param optionID the unique optionID
* @param cons a list of parameter constraints for this double parameter
* @param defaultValue the default value for this double parameter
*/
public DoubleParameter(OptionID optionID, List<ParameterConstraint<Number>> cons, Double defaultValue) {
super(optionID, cons, defaultValue);
}
/**
* Constructs a double parameter with the given optionID, parameter
* constraints, and optional flag.
*
* @param optionID the unique optionID
* @param cons a list of parameter constraints for this double parameter
* @param optional specifies whether this parameter is an optional parameter
*/
public DoubleParameter(OptionID optionID, List<ParameterConstraint<Number>> cons, boolean optional) {
this(optionID, cons);
setOptional(optional);
}
/**
* Constructs a double parameter with the given optionID, and parameter
* constraints.
*
* @param optionID the unique optionID
* @param constraints a list of parameter constraints for this double
* parameter
*/
public DoubleParameter(OptionID optionID, List<ParameterConstraint<Number>> constraints) {
super(optionID, constraints);
}
/**
* Constructs a double parameter with the given optionID, parameter
* constraint, and default value.
*
* @param optionID the unique id of this parameter
* @param constraint the constraint of this parameter
* @param defaultValue the default value for this parameter
*/
public DoubleParameter(OptionID optionID, ParameterConstraint<Number> constraint, Double defaultValue) {
super(optionID, constraint, defaultValue);
}
/**
* Constructs a double parameter with the given optionID, parameter
* constraint, and optional flag.
*
* @param optionID the unique id of this parameter
* @param constraint the constraint of this parameter
* @param optional specifies whether this parameter is an optional parameter
*/
public DoubleParameter(OptionID optionID, ParameterConstraint<Number> constraint, boolean optional) {
super(optionID, constraint, optional);
}
/**
* Constructs a double parameter with the given optionID, and parameter
* constraint.
*
* @param optionID the unique id of this parameter
* @param constraint the constraint of this parameter
*/
public DoubleParameter(OptionID optionID, ParameterConstraint<Number> constraint) {
super(optionID, constraint);
}
/**
* Constructs a double parameter with the given optionID and default value.
*
* @param optionID the unique optionID
* @param defaultValue the default value for this double parameter
*/
public DoubleParameter(OptionID optionID, Double defaultValue) {
super(optionID, defaultValue);
}
/**
* Constructs a double parameter with the given optionID and optional flag.
*
* @param optionID the unique id of this parameter
* @param optional specifies whether this parameter is an optional parameter
*/
public DoubleParameter(OptionID optionID, boolean optional) {
super(optionID, optional);
}
/**
* Constructs a double parameter with the given optionID.
*
* @param optionID the unique id of this parameter
*/
public DoubleParameter(OptionID optionID) {
super(optionID);
}
/** {@inheritDoc} */
@Override
public String getValueAsString() {
return Double.toString(getValue());
}
/** {@inheritDoc} */
@Override
protected Double parseValue(Object obj) throws WrongParameterValueException {
if(obj instanceof Double) {
return (Double) obj;
}
try {
return Double.parseDouble(obj.toString());
}
catch(NullPointerException e) {
throw new WrongParameterValueException("Wrong parameter format! Parameter \"" + getName() + "\" requires a double value, read: " + obj + "!\n");
}
catch(NumberFormatException e) {
throw new WrongParameterValueException("Wrong parameter format! Parameter \"" + getName() + "\" requires a double value, read: " + obj + "!\n");
}
}
/**
* Indicates whether some other object is "equal to" this one.
*
* @param obj the reference object with which to compare.
* @return <code>true</code> if this double parameter has the same value as
* the specified object, <code>false</code> otherwise.
*/
// TODO: comparing the parameters doesn't make sense. REMOVE.
/*@Override
public boolean equals(Object obj) {
if(obj == this) {
return true;
}
if(!(obj instanceof DoubleParameter)) {
return false;
}
DoubleParameter oth = (DoubleParameter) obj;
if(this.getValue() == null) {
return (oth.getValue() == null);
}
return this.getValue().equals(oth.getValue());
}*/
/**
* Returns a string representation of the parameter's type.
*
* @return "<double>"
*/
@Override
public String getSyntax() {
return "<double>";
}
}
|
