de.lmu.ifi.dbs.elki.utilities.optionhandling.constraints

Class IntervalConstraint

java.lang.Object

de.lmu.ifi.dbs.elki.utilities.optionhandling.constraints.IntervalConstraint

All Implemented Interfaces:

ParameterConstraint<Number>

Deprecated.

Use two constraints instead.

@Deprecated
public class IntervalConstraint
extends Object
implements ParameterConstraint<Number>

Represents an interval parameter constraint testing if a given value lies within the specified interval. The value of the number parameter ( NumberParameter ) tested has to be greater than (or equal to, if specified) than the specified low constraint value and less than (or equal to, if specified) than the specified high constraint value.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IntervalConstraint.IntervalBoundary Deprecated. Available interval boundary types types: IntervalConstraint.IntervalBoundary.OPEN denotes an open interval, i.e. less than (or greater than) comparison IntervalConstraint.IntervalBoundary.CLOSE denotes a closed interval, i.e. an equal to or less than (or equal to or greater than) comparison

Field Summary

Fields

Modifier and Type	Field and Description
private IntervalConstraint.IntervalBoundary	highBoundary Deprecated. The interval boundary for the high constraint value.
private Number	highConstraintValue Deprecated. The high constraint value (right interval boundary).
private IntervalConstraint.IntervalBoundary	lowBoundary Deprecated. The interval boundary for the low constraint value.
private Number	lowConstraintValue Deprecated. The low constraint value (left interval boundary).

Constructor Summary

Constructors

Constructor and Description
IntervalConstraint(double lowConstraintValue, IntervalConstraint.IntervalBoundary lowBoundary, double highConstraintValue, IntervalConstraint.IntervalBoundary highBoundary) Deprecated. Creates an IntervalConstraint parameter constraint.
IntervalConstraint(int lowConstraintValue, IntervalConstraint.IntervalBoundary lowBoundary, int highConstraintValue, IntervalConstraint.IntervalBoundary highBoundary) Deprecated. Creates an IntervalConstraint parameter constraint.
IntervalConstraint(Number lowConstraintValue, IntervalConstraint.IntervalBoundary lowBoundary, Number highConstraintValue, IntervalConstraint.IntervalBoundary highBoundary) Deprecated. Creates an IntervalConstraint parameter constraint.

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription(String parameterName) Deprecated. Returns a description of this constraint.
void	test(Number t) Deprecated. Checks if the number value given by the number parameter is greater equal than the constraint value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

lowConstraintValue

private final Number lowConstraintValue

Deprecated.

The low constraint value (left interval boundary).

lowBoundary

private final IntervalConstraint.IntervalBoundary lowBoundary

Deprecated.

The interval boundary for the low constraint value.

See Also:

IntervalConstraint.IntervalBoundary

highConstraintValue

private final Number highConstraintValue

Deprecated.

The high constraint value (right interval boundary).

highBoundary

private final IntervalConstraint.IntervalBoundary highBoundary

Deprecated.

The interval boundary for the high constraint value.

See Also:

IntervalConstraint.IntervalBoundary

Constructor Detail

IntervalConstraint

public IntervalConstraint(Number lowConstraintValue,
                  IntervalConstraint.IntervalBoundary lowBoundary,
                  Number highConstraintValue,
                  IntervalConstraint.IntervalBoundary highBoundary)

Deprecated.

Creates an IntervalConstraint parameter constraint.

That is, the value of the number parameter given has to be greater than (or equal to, if specified) than the specified low constraint value and less than (or equal to, if specified) than the specified high constraint value.

Parameters:

lowConstraintValue - the low constraint value (left interval boundary)

lowBoundary - the interval boundary for the low constraint value (see IntervalConstraint.IntervalBoundary)

highConstraintValue - the high constraint value (right interval boundary)

highBoundary - the interval boundary for the high constraint value (see IntervalConstraint.IntervalBoundary)

IntervalConstraint

public IntervalConstraint(int lowConstraintValue,
                  IntervalConstraint.IntervalBoundary lowBoundary,
                  int highConstraintValue,
                  IntervalConstraint.IntervalBoundary highBoundary)

Deprecated.

Creates an IntervalConstraint parameter constraint.

That is, the value of the number parameter given has to be greater than (or equal to, if specified) than the specified low constraint value and less than (or equal to, if specified) than the specified high constraint value.

Parameters:

lowConstraintValue - the low constraint value (left interval boundary)

lowBoundary - the interval boundary for the low constraint value (see IntervalConstraint.IntervalBoundary)

highConstraintValue - the high constraint value (right interval boundary)

highBoundary - the interval boundary for the high constraint value (see IntervalConstraint.IntervalBoundary)

IntervalConstraint

public IntervalConstraint(double lowConstraintValue,
                  IntervalConstraint.IntervalBoundary lowBoundary,
                  double highConstraintValue,
                  IntervalConstraint.IntervalBoundary highBoundary)

Deprecated.

Creates an IntervalConstraint parameter constraint.

That is, the value of the number parameter given has to be greater than (or equal to, if specified) than the specified low constraint value and less than (or equal to, if specified) than the specified high constraint value.

Parameters:

lowConstraintValue - the low constraint value (left interval boundary)

lowBoundary - the interval boundary for the low constraint value (see IntervalConstraint.IntervalBoundary)

highConstraintValue - the high constraint value (right interval boundary)

highBoundary - the interval boundary for the high constraint value (see IntervalConstraint.IntervalBoundary)

Method Detail

test

public void test(Number t)
          throws ParameterException

Deprecated.

Checks if the number value given by the number parameter is greater equal than the constraint value. If not, a parameter exception is thrown.

Specified by:

test in interface ParameterConstraint<Number>

Parameters:

t - Value to be checked whether or not it fulfills the underlying parameter constraint.

Throws:

ParameterException - if the parameter to be tested does not fulfill the parameter constraint

getDescription

public String getDescription(String parameterName)

Deprecated.

Description copied from interface: ParameterConstraint

Returns a description of this constraint.

Specified by:

getDescription in interface ParameterConstraint<Number>

Parameters:

parameterName - the name of the parameter this constraint is used for

Returns:

a description of this constraint