io.jenetics.util.DoubleRange Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jenetics Show documentation
Jenetics - Java Genetic Algorithm Library
There is a newer version: 8.1.0
/*
 * Java Genetic Algorithm Library (jenetics-4.0.0).
 * Copyright (c) 2007-2017 Franz Wilhelmstötter
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * Author:
 *    Franz Wilhelmstötter ([email protected])
 */
package io.jenetics.util;

import static java.lang.Double.doubleToLongBits;
import static java.lang.String.format;

import java.io.Serializable;

/**
 * Double range class.
 *
 * @author Franz Wilhelmstötter
 * @version 3.2
 * @since 3.2
 */
public final class DoubleRange implements Serializable {

	private static final long serialVersionUID = 1L;

	private final double _min;
	private final double _max;

	private DoubleRange(final double min, final double max) {
		if (min > max) {
			throw new IllegalArgumentException(format(
				"Min greater than max: %s > %s", min, max
			));
		}

		_min = min;
		_max = max;
	}

	/**
	 * Return the minimum value of the double range.
	 *
	 * @return the minimum value of the double range
	 */
	public double getMin() {
		return _min;
	}

	/**
	 * Return the maximum value of the double range.
	 *
	 * @return the maximum value of the double range
	 */
	public double getMax() {
		return _max;
	}

	/**
	 * Create a new {@code DoubleRange} object with the given {@code min} and
	 * {@code max} values.
	 *
	 * @param min the lower bound of the double range
	 * @param max the upper bound of the double range
	 * @return a new {@code DoubleRange} object
	 * @throws IllegalArgumentException if {@code min > max}
	 */
	public static DoubleRange of(final double min, final double max) {
		return new DoubleRange(min, max);
	}

	@Override
	public int hashCode() {
		return (int)(doubleToLongBits(_min) + 31*doubleToLongBits(_max));
	}

	@Override
	public boolean equals(final Object other) {
		return other instanceof DoubleRange &&
			Double.compare(_min, ((DoubleRange)other)._min) == 0 &&
			Double.compare(_max, ((DoubleRange)other)._max) == 0;
	}

	@Override
	public String toString() {
		return "[" + _min + ", " + _max + "]";
	}

}