Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Copyright (C) 2011-2015 Rinde van Lon, iMinds-DistriNet, KU Leuven
*
* 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.
*/
package com.github.rinde.rinsim.scenario.generator;
import static com.github.rinde.rinsim.util.StochasticSuppliers.uniformDouble;
import static com.google.common.base.Preconditions.checkArgument;
import java.util.Collections;
import org.apache.commons.math3.random.MersenneTwister;
import org.apache.commons.math3.random.RandomGenerator;
import com.github.rinde.rinsim.geom.Point;
import com.github.rinde.rinsim.util.StochasticSupplier;
import com.github.rinde.rinsim.util.StochasticSuppliers;
import com.google.common.base.Optional;
import com.google.common.collect.Collections2;
import com.google.common.collect.ImmutableList;
import com.google.common.math.DoubleMath;
/**
* Utility class for creating {@link LocationGenerator}s.
* @author Rinde van Lon
*/
public final class Locations {
private Locations() {}
/**
* @return A {@link Builder} for creating {@link LocationGenerator}s.
*/
public static Builder builder() {
return new Builder();
}
/**
* A location generator generates locations for orders (aka tasks).
* @author Rinde van Lon
*/
public interface LocationGenerator {
/**
* Should generate locations for the specified number of orders (aka tasks).
* There should be enough locations for each order. Typically this is
* predefined as a ratio, e.g. 1:2 in case origin and
* destination is required for each order.
* @param seed The random seed.
* @param numLocations The number of locations that is required.
* @return A list of locations for the orders of size
* numLocations.
*/
ImmutableList generate(long seed, int numLocations);
/**
* @return The expected center of all generated locations.
*/
Point getCenter();
/**
* @return A position representing the lowest possible coordinates.
*/
Point getMin();
/**
* @return A position representing the highest possible coordinates.
*/
Point getMax();
}
/**
* A builder for creating {@link LocationGenerator}s.
* @author Rinde van Lon
*/
public static class Builder {
Optional xMin;
Optional yMin;
Optional xMax;
Optional yMax;
Optional xMean;
Optional yMean;
Optional xSd;
Optional ySd;
Optional redraw;
Builder() {
xMin = Optional.absent();
yMin = Optional.absent();
xMax = Optional.absent();
yMax = Optional.absent();
xMean = Optional.absent();
yMean = Optional.absent();
xSd = Optional.absent();
ySd = Optional.absent();
redraw = Optional.absent();
}
/**
* Sets the borders of the location generator such that it spans the
* specified area. The min position is (0,0), and max is
* (sqrt(area),sqrt(area)).
* @param area The area to use.
* @return This, as per the builder pattern.
*/
public Builder squareByArea(double area) {
return square(Math.sqrt(area));
}
/**
* Sets the borders of the location generator such that the min position is
* (0,0) and the max position is (side,side).
* @param side The side of a square.
* @return This, as per the builder pattern.
*/
public Builder square(double side) {
return xMin(0d).yMin(0d).xMax(side).yMax(side);
}
/**
* Sets the minimum x value that the location generator will generate.
* @param x The minimum x value.
* @return This, as per the builder pattern.
*/
public Builder xMin(double x) {
xMin = Optional.of(Double.valueOf(x));
return this;
}
/**
* Sets the minimum y value that the location generator will generate.
* @param y The minimum y value.
* @return This, as per the builder pattern.
*/
public Builder yMin(double y) {
yMin = Optional.of(Double.valueOf(y));
return this;
}
/**
* Sets the minimum x and y values that the location generator will
* generate.
* @param min The minimum x and y value.
* @return This, as per the builder pattern.
*/
public Builder min(double min) {
return xMin(min).yMin(min);
}
/**
* Sets the minimum position the the location generator will generate.
* @param p The minimum position.
* @return This, as per the builder pattern.
*/
public Builder min(Point p) {
return xMin(p.x).yMin(p.y);
}
/**
* Sets the maximum x value that the location generator will generate.
* @param x The maximum x value.
* @return This, as per the builder pattern.
*/
public Builder xMax(double x) {
xMax = Optional.of(Double.valueOf(x));
return this;
}
/**
* Sets the maximum y value that the location generator will generate.
* @param y The maximum y value.
* @return This, as per the builder pattern.
*/
public Builder yMax(double y) {
yMax = Optional.of(Double.valueOf(y));
return this;
}
/**
* Sets the maximum x and y values the location generator will generate.
* @param max The maximum x and y values.
* @return This, as per the builder pattern.
*/
public Builder max(double max) {
return xMax(max).yMax(max);
}
/**
* Sets the maximum position the the location generator will generate.
* @param max The maximum position.
* @return This, as per the builder pattern.
*/
public Builder max(Point max) {
return xMax(max.x).yMax(max.y);
}
/**
* Sets the position that the location generator will use as mean.
* @param mean The mean position.
* @return This, as per the builder pattern.
*/
public Builder mean(Point mean) {
return xMean(mean.x).yMean(mean.y);
}
/**
* Sets the mean position that the location generator will use as mean.
* @param m The x and y value of the mean position.
* @return This, as per the builder pattern.
*/
public Builder mean(double m) {
return xMean(m).yMean(m);
}
/**
* Sets the x mean that the location generator will use.
* @param x The x mean.
* @return This, as per the builder pattern.
*/
public Builder xMean(double x) {
xMean = Optional.of(Double.valueOf(x));
return this;
}
/**
* Sets the y mean that the location generator will use.
* @param y The y mean.
* @return This, as per the builder pattern.
*/
public Builder yMean(double y) {
yMean = Optional.of(Double.valueOf(y));
return this;
}
/**
* Sets the standard deviation that the location generator will use.
* @param s The standard deviation.
* @return This, as per the builder pattern.
*/
public Builder std(double s) {
return xStd(s).yStd(s);
}
/**
* Sets the standard deviations for x and y that the location generator will
* use.
* @param p A point indicating the x and y standard deviations.
* @return This, as per the builder pattern.
*/
public Builder std(Point p) {
return xStd(p.x).yStd(p.y);
}
/**
* Sets the x standard deviation that the location generator will use.
* @param x The x standard deviation.
* @return This, as per the builder pattern.
*/
public Builder xStd(double x) {
xSd = Optional.of(Double.valueOf(x));
return this;
}
/**
* Sets the y standard deviation that the location generator will use.
* @param y The y standard deviation.
* @return This, as per the builder pattern.
*/
public Builder yStd(double y) {
ySd = Optional.of(Double.valueOf(y));
return this;
}
/**
* When this option is used and a normal distributed location generator is
* used it will draw a new random number in case the previous is out of
* bounds.
* @return This, as per the builder pattern.
*/
public Builder redrawWhenOutOfBounds() {
redraw = Optional.of(Boolean.TRUE);
return this;
}
/**
* When this option is used and a normal distributed location generator is
* used it will round all random numbers such that they fit in the bounds.
* @return This, as per the builder pattern.
*/
public Builder roundWhenOutOfBounds() {
redraw = Optional.of(Boolean.FALSE);
return this;
}
/**
* Create a uniform distributed {@link LocationGenerator}. The min and max
* values set to this builder take precedence over the mean and standard
* deviations. In case the boundaries were set any specified means and
* standard deviations are ignored when generating the locations. However,
* the mean as supplied to this builder will be returned in the
* {@link LocationGenerator#getCenter()} method.
* @return A uniform distributed generator.
*/
public LocationGenerator buildUniform() {
final Point xMinMax = getUniformMinMax(xMin, xMax, xMean, xSd);
final Point yMinMax = getUniformMinMax(yMin, yMax, yMean, ySd);
final Point min = new Point(xMinMax.x, yMinMax.x);
final Point max = new Point(xMinMax.y, yMinMax.y);
final double xCenter = getUniformCenter(xMean, min.x, max.x);
final double yCenter = getUniformCenter(yMean, min.y, max.y);
return new SupplierLocGen(
min, max, new Point(xCenter, yCenter),
uniformDouble(min.x, max.x),
uniformDouble(min.y, max.y));
}
/**
* Create a normal distributed {@link LocationGenerator}.
* @return A normal distributed generator.
*/
public LocationGenerator buildNormal() {
final StochasticSupplier xSup = normalVar(xMin, xMax, xMean, xSd,
redraw);
final StochasticSupplier ySup = normalVar(yMin, yMax, yMean, ySd,
redraw);
return new SupplierLocGen(
new Point(xMin.get(), yMin.get()),
new Point(xMax.get(), yMax.get()),
new Point(xMean.get(), yMean.get()),
xSup, ySup);
}
/**
* Creates a fixed {@link LocationGenerator} that will always return the
* same list of locations. Note that if the number of requested locations is
* different from the number of locations in this list, the
* {@link LocationGenerator} will throw an {@link IllegalArgumentException}.
* If no previous min, max or center values were supplied these will be
* computed from the specified locations.
* @param locations The locations that will always be returned by the
* {@link LocationGenerator}.
* @return A new fixed {@link LocationGenerator}.
*/
public LocationGenerator buildFixed(Iterable locations) {
final ImmutableList locs = ImmutableList.copyOf(locations);
if (!xMin.isPresent()) {
xMin = Optional.of(Collections.min(locs, Point.Comparators.X).x);
}
if (!yMin.isPresent()) {
yMin = Optional.of(Collections.min(locs, Point.Comparators.Y).y);
}
if (!xMax.isPresent()) {
xMax = Optional.of(Collections.max(locs, Point.Comparators.X).x);
}
if (!yMax.isPresent()) {
yMax = Optional.of(Collections.max(locs, Point.Comparators.Y).y);
}
if (!xMean.isPresent()) {
xMean = Optional.of(DoubleMath.mean(
Collections2.transform(locs, Point.Transformers.X)));
}
if (!yMean.isPresent()) {
yMean = Optional.of(DoubleMath.mean(
Collections2.transform(locs, Point.Transformers.Y)));
}
return new FixedLocGen(new Point(xMin.get(), yMin.get()),
new Point(xMax.get(), yMax.get()),
new Point(xMean.get(), yMean.get()),
locs);
}
private static double getUniformCenter(Optional mean, double min,
double max) {
if (mean.isPresent()) {
return mean.get();
}
return (max - min) / 2d;
}
private static Point getUniformMinMax(Optional min,
Optional max, Optional mean, Optional std) {
if (min.isPresent() && max.isPresent()) {
checkArgument(min.get() < max.get());
return new Point(min.get(), max.get());
} else if (mean.isPresent() && std.isPresent()) {
final double length = Math.sqrt(12) * std.get();
final double minn = mean.get() - length;
final double maxx = mean.get() + length;
return new Point(minn, maxx);
} else {
throw new IllegalArgumentException();
}
}
private static StochasticSupplier normalVar(Optional min,
Optional max, Optional mean, Optional std,
Optional redraw) {
checkArgument(min.isPresent());
checkArgument(max.isPresent());
checkArgument(mean.isPresent());
checkArgument(std.isPresent());
checkArgument(redraw.isPresent());
final StochasticSuppliers.Builder builder = StochasticSuppliers.normal()
.mean(mean.get())
.std(std.get())
.lowerBound(min.get())
.upperBound(max.get());
if (redraw.get()) {
builder.redrawWhenOutOfBounds();
} else {
builder.roundWhenOutOfBounds();
}
return builder.buildDouble();
}
}
private abstract static class AbstractLocGen implements LocationGenerator {
final Point min;
final Point max;
final Point center;
AbstractLocGen(Point mi, Point ma, Point ce) {
min = mi;
max = ma;
center = ce;
}
@Override
public Point getMin() {
return min;
}
@Override
public Point getMax() {
return max;
}
@Override
public Point getCenter() {
return center;
}
}
private static class SupplierLocGen extends AbstractLocGen {
private final StochasticSupplier xSupplier;
private final StochasticSupplier ySupplier;
private final RandomGenerator rng;
SupplierLocGen(Point mi, Point ma, Point ce,
StochasticSupplier xSup,
StochasticSupplier ySup) {
super(mi, ma, ce);
xSupplier = xSup;
ySupplier = ySup;
rng = new MersenneTwister();
}
@Override
public ImmutableList generate(long seed, int numOrders) {
rng.setSeed(seed);
final ImmutableList.Builder locs = ImmutableList.builder();
for (int i = 0; i < numOrders; i++) {
locs.add(new Point(
xSupplier.get(rng.nextLong()),
ySupplier.get(rng.nextLong())));
}
return locs.build();
}
}
private static class FixedLocGen extends AbstractLocGen {
private final ImmutableList fixedPoints;
FixedLocGen(Point mi, Point ma, Point ce, Iterable points) {
super(mi, ma, ce);
fixedPoints = ImmutableList.copyOf(points);
}
@Override
public ImmutableList generate(long seed, int numOrders) {
checkArgument(
fixedPoints.size() == numOrders,
"This fixed LocationGenerator can only output %s locations while %s locations were requested.",
fixedPoints.size(), numOrders);
return fixedPoints;
}
}
}
