SingleBound.java
package org.opentrafficsim.base.parameters.constraint;
import org.djunits.value.vdouble.scalar.AbstractDoubleScalar;
import nl.tudelft.simulation.language.Throw;
/**
* Continuous constraints with a single bound. To allow both {@code Double} and {@code AbstractDoubleScalar<?, ?>} constraints,
* the generic type is restricted to {@code Number}. However, that also allows other subclasses of {@code Number}, e.g.
* {@code Integer}. Due to rounding and value limits from the type (e.g. {@code Integer.MAX_VALEU}), bounds may not function
* correctly after a call to {@code Number.doubleValue()}. To restrict the usage, the constructor is private and static factory
* methods for {@code Double} and {@code AbstractDoubleScalar<?, ?>} are supplied.
* <p>
* Copyright (c) 2013-2018 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. <br>
* BSD-style license. See <a href="http://opentrafficsim.org/node/13">OpenTrafficSim License</a>.
* <p>
* @version $Revision$, $LastChangedDate$, by $Author$, initial version Aug 14, 2017 <br>
* @author <a href="http://www.tbm.tudelft.nl/averbraeck">Alexander Verbraeck</a>
* @author <a href="http://www.tudelft.nl/pknoppers">Peter Knoppers</a>
* @author <a href="http://www.transport.citg.tudelft.nl">Wouter Schakel</a>
* @param <T> value type
*/
public class SingleBound<T extends Number> implements Constraint<T>
{
/** The bound. */
private final Bound bound;
/** Message about values that do not comply with the bound. */
private final String failMessage;
/**
* Creates a lower inclusive bound; {@code value >= bound}.
* @param bound double; bound value
* @return lower inclusive bound
*/
public static final SingleBound<Double> lowerInclusive(final double bound)
{
return createLowerInclusive(bound);
}
/**
* Creates a lower inclusive bound; {@code value >= bound}.
* @param bound AbstractDoubleScalar; bound value
* @param <T> value type
* @return lower inclusive bound
*/
public static final <T extends AbstractDoubleScalar<?, ?>> SingleBound<T> lowerInclusive(final T bound)
{
return createLowerInclusive(bound);
}
/**
* Creates a lower inclusive bound; {@code value >= bound}.
* @param bound T; bound value
* @param <T> value type
* @return lower inclusive bound
*/
private static <T extends Number> SingleBound<T> createLowerInclusive(final T bound)
{
return new SingleBound<>(new LowerBoundInclusive<>(bound),
String.format("Value is not greater than or equal to %s", bound));
}
/**
* Creates a lower exclusive bound; {@code value > bound}.
* @param bound double; bound value
* @return lower exclusive bound
*/
public static final SingleBound<Double> lowerExclusive(final double bound)
{
return createLowerExclusive(bound);
}
/**
* Creates a lower exclusive bound; {@code value > bound}.
* @param bound AbstractDoubleScalar; bound value
* @param <T> value type
* @return lower exclusive bound
*/
public static final <T extends AbstractDoubleScalar<?, ?>> SingleBound<T> lowerExclusive(final T bound)
{
return createLowerExclusive(bound);
}
/**
* Creates a lower exclusive bound; {@code value > bound}.
* @param bound T; bound value
* @param <T> value type
* @return lower exclusive bound
*/
private static <T extends Number> SingleBound<T> createLowerExclusive(final T bound)
{
return new SingleBound<>(new LowerBoundExclusive<>(bound), String.format("Value is not greater than %s", bound));
}
/**
* Creates an upper inclusive bound; {@code value <= bound}.
* @param bound double; bound value
* @return upper inclusive bound
*/
public static final SingleBound<Double> upperInclusive(final double bound)
{
return createUpperInclusive(bound);
}
/**
* Creates an upper inclusive bound; {@code value <= bound}.
* @param bound AbstractDoubleScalar; bound value
* @return upper inclusive bound
* @param <T> value type
*/
public static final <T extends AbstractDoubleScalar<?, ?>> SingleBound<T> upperInclusive(final T bound)
{
return createUpperInclusive(bound);
}
/**
* Creates an upper inclusive bound; {@code value <= bound}.
* @param bound T; bound value
* @param <T> value type
* @return upper inclusive bound
*/
private static <T extends Number> SingleBound<T> createUpperInclusive(final T bound)
{
return new SingleBound<>(new UpperBoundInclusive<>(bound),
String.format("Value is not smaller than or equal to %s", bound));
}
/**
* Creates an upper exclusive bound; {@code value < bound}.
* @param bound double; bound value
* @return upper exclusive bound
*/
public static final SingleBound<Double> upperExclusive(final double bound)
{
return createUpperExclusive(bound);
}
/**
* Creates an upper exclusive bound; {@code value < bound}.
* @param bound AbstractDoubleScalar; bound value
* @param <T> value type
* @return upper exclusive bound
*/
public static final <T extends AbstractDoubleScalar<?, ?>> SingleBound<T> upperExclusive(final T bound)
{
return createUpperExclusive(bound);
}
/**
* Creates an upper exclusive bound; {@code value < bound}.
* @param bound T; bound value
* @param <T> value type
* @return upper exclusive bound
*/
private static <T extends Number> SingleBound<T> createUpperExclusive(final T bound)
{
return new SingleBound<>(new UpperBoundExclusive<>(bound), String.format("Value is not smaller than %s", bound));
}
/**
* Constructor.
* @param bound Bound; bound
* @param failMessage String; message about values that do not comply with the bound
*/
SingleBound(final Bound bound, final String failMessage)
{
this.bound = bound;
this.failMessage = failMessage;
}
/** {@inheritDoc} */
@Override
public boolean accept(final T value)
{
return this.bound.accept(value);
}
/** {@inheritDoc} */
@Override
public String failMessage()
{
return this.failMessage;
}
/**
* @return bound.
*/
public Bound getBound()
{
return this.bound;
}
/**
* Super class for classes that implement a specific numeric check.
* <p>
* Copyright (c) 2013-2018 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
* <br>
* BSD-style license. See <a href="http://opentrafficsim.org/node/13">OpenTrafficSim License</a>.
* <p>
* @version $Revision$, $LastChangedDate$, by $Author$, initial version 8 sep. 2017 <br>
* @author <a href="http://www.tbm.tudelft.nl/averbraeck">Alexander Verbraeck</a>
* @author <a href="http://www.tudelft.nl/pknoppers">Peter Knoppers</a>
* @author <a href="http://www.transport.citg.tudelft.nl">Wouter Schakel</a>
*/
abstract static class Bound
{
/** Value of the bound. */
@SuppressWarnings("checkstyle:visibilitymodifier")
final Number bound;
/** Hashcode of the value class. */
@SuppressWarnings("checkstyle:visibilitymodifier")
final int classHashcode;
/** String representation of this bound with %s for the value. */
private final String stringFormat;
/**
* Constructor.
* @param bound Number; value of the bound
* @param stringFormat String; string representation of this bound with %s for the value
*/
Bound(final Number bound, final String stringFormat)
{
Throw.whenNull(bound, "Bound may not be null.");
Throw.whenNull(bound, "String format may not be null.");
Throw.when(Double.isNaN(bound.doubleValue()), IllegalArgumentException.class, "Bound value may not be NaN.");
this.bound = bound;
this.classHashcode = bound.getClass().hashCode();
this.stringFormat = stringFormat;
}
/**
* Returns true if the bound accepts the value.
* @param value Number; the value to check
* @return true if the bound accepts the value
*/
abstract boolean accept(Number value);
/** {@inheritDoc} */
@Override
public final String toString()
{
return String.format(this.stringFormat, this.bound);
}
}
/**
* Class implementing a lower inclusive bound; {@code value >= bound}.
* <p>
* Copyright (c) 2013-2018 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
* <br>
* BSD-style license. See <a href="http://opentrafficsim.org/node/13">OpenTrafficSim License</a>.
* <p>
* @version $Revision$, $LastChangedDate$, by $Author$, initial version 8 sep. 2017 <br>
* @author <a href="http://www.tbm.tudelft.nl/averbraeck">Alexander Verbraeck</a>
* @author <a href="http://www.tudelft.nl/pknoppers">Peter Knoppers</a>
* @author <a href="http://www.transport.citg.tudelft.nl">Wouter Schakel</a>
* @param <T> value type
*/
static class LowerBoundInclusive<T extends Number> extends Bound
{
/**
* Constructor.
* @param bound T; bound
*/
LowerBoundInclusive(final T bound)
{
super(bound, "%s <= value");
}
/** {@inheritDoc} */
protected boolean accept(final Number value)
{
return this.bound.doubleValue() <= value.doubleValue();
}
}
/**
* Class implementing a lower exclusive bound; {@code value > bound}.
* <p>
* Copyright (c) 2013-2018 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
* <br>
* BSD-style license. See <a href="http://opentrafficsim.org/node/13">OpenTrafficSim License</a>.
* <p>
* @version $Revision$, $LastChangedDate$, by $Author$, initial version 8 sep. 2017 <br>
* @author <a href="http://www.tbm.tudelft.nl/averbraeck">Alexander Verbraeck</a>
* @author <a href="http://www.tudelft.nl/pknoppers">Peter Knoppers</a>
* @author <a href="http://www.transport.citg.tudelft.nl">Wouter Schakel</a>
* @param <T> value type
*/
static class LowerBoundExclusive<T extends Number> extends Bound
{
/**
* Constructor.
* @param bound T; bound
*/
LowerBoundExclusive(final T bound)
{
super(bound, "%s < value");
}
/** {@inheritDoc} */
protected boolean accept(final Number value)
{
return this.bound.doubleValue() < value.doubleValue();
}
}
/**
* Class implementing an upper inclusive bound; {@code value <= bound}.
* <p>
* Copyright (c) 2013-2018 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
* <br>
* BSD-style license. See <a href="http://opentrafficsim.org/node/13">OpenTrafficSim License</a>.
* <p>
* @version $Revision$, $LastChangedDate$, by $Author$, initial version 8 sep. 2017 <br>
* @author <a href="http://www.tbm.tudelft.nl/averbraeck">Alexander Verbraeck</a>
* @author <a href="http://www.tudelft.nl/pknoppers">Peter Knoppers</a>
* @author <a href="http://www.transport.citg.tudelft.nl">Wouter Schakel</a>
* @param <T> value type
*/
static class UpperBoundInclusive<T extends Number> extends Bound
{
/**
* Constructor.
* @param bound T; bound
*/
UpperBoundInclusive(final T bound)
{
super(bound, "value <= %s");
}
/** {@inheritDoc} */
protected boolean accept(final Number value)
{
return this.bound.doubleValue() >= value.doubleValue();
}
}
/**
* Class implementing an upper exclusive bound; {@code value < bound}.
* <p>
* Copyright (c) 2013-2018 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
* <br>
* BSD-style license. See <a href="http://opentrafficsim.org/node/13">OpenTrafficSim License</a>.
* <p>
* @version $Revision$, $LastChangedDate$, by $Author$, initial version 8 sep. 2017 <br>
* @author <a href="http://www.tbm.tudelft.nl/averbraeck">Alexander Verbraeck</a>
* @author <a href="http://www.tudelft.nl/pknoppers">Peter Knoppers</a>
* @author <a href="http://www.transport.citg.tudelft.nl">Wouter Schakel</a>
* @param <T> value type
*/
static class UpperBoundExclusive<T extends Number> extends Bound
{
/**
* Constructor.
* @param bound T; bound
*/
UpperBoundExclusive(final T bound)
{
super(bound, "value < %s");
}
/** {@inheritDoc} */
protected boolean accept(final Number value)
{
return this.bound.doubleValue() > value.doubleValue();
}
}
/** {@inheritDoc} */
@Override
public String toString()
{
return "SingleBound [" + this.bound + "]";
}
}