lucene/spatial3d/src/java/org/apache/lucene/spatial3d/geom/GeoWideNorthRectangle.java - lucene-solr - Git at Google

 /*
  * Licensed to the Apache Software Foundation (ASF) under one or more
  * contributor license agreements.  See the NOTICE file distributed with
  * this work for additional information regarding copyright ownership.
  * The ASF licenses this file to You 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 org.apache.lucene.spatial3d.geom;

 import java.io.InputStream;
 import java.io.OutputStream;
 import java.io.IOException;

 /**
  * Bounding box wider than PI but limited on three sides (
  * bottom lat, left lon, right lon).
  *
  * @lucene.internal
  */
 class GeoWideNorthRectangle extends GeoBaseBBox {
   /** Bottom latitude */
   protected final double bottomLat;
   /** Left longitude */
   protected final double leftLon;
   /** Right longitude */
   protected final double rightLon;

   /** The cosine of the middle latitude */
   protected final double cosMiddleLat;

   /** The lower right hand corner point */
   protected final GeoPoint LRHC;
   /** The lower left hand corner point */
   protected final GeoPoint LLHC;

   /** The bottom plane */
   protected final SidedPlane bottomPlane;
   /** The left plane */
   protected final SidedPlane leftPlane;
   /** The right plane */
   protected final SidedPlane rightPlane;

   /** Notable points for the bottom plane */
   protected final GeoPoint[] bottomPlanePoints;
   /** Notable points for the left plane */
   protected final GeoPoint[] leftPlanePoints;
   /** Notable points for the right plane */
   protected final GeoPoint[] rightPlanePoints;

   /** Center point */
   protected final GeoPoint centerPoint;

   /** Composite left/right bounds */
   protected final EitherBound eitherBound;

   /** A point on the edge */
   protected final GeoPoint[] edgePoints;

   /**
    * Accepts only values in the following ranges: lat: {@code -PI/2 -> PI/2}, lon: {@code -PI -> PI}.
    * Horizontal angle must be greater than or equal to PI.
    * @param planetModel is the planet model.
    * @param bottomLat is the bottom latitude.
    * @param leftLon is the left longitude.
    * @param rightLon is the right longitude.
    */
   public GeoWideNorthRectangle(final PlanetModel planetModel, final double bottomLat, final double leftLon, double rightLon) {
     super(planetModel);
     // Argument checking
     if (bottomLat > Math.PI * 0.5 || bottomLat < -Math.PI * 0.5)
       throw new IllegalArgumentException("Bottom latitude out of range");
     if (leftLon < -Math.PI || leftLon > Math.PI)
       throw new IllegalArgumentException("Left longitude out of range");
     if (rightLon < -Math.PI || rightLon > Math.PI)
       throw new IllegalArgumentException("Right longitude out of range");
     double extent = rightLon - leftLon;
     if (extent < 0.0) {
       extent += 2.0 * Math.PI;
     }
     if (extent < Math.PI)
       throw new IllegalArgumentException("Width of rectangle too small");

     this.bottomLat = bottomLat;
     this.leftLon = leftLon;
     this.rightLon = rightLon;

     final double sinBottomLat = Math.sin(bottomLat);
     final double cosBottomLat = Math.cos(bottomLat);
     final double sinLeftLon = Math.sin(leftLon);
     final double cosLeftLon = Math.cos(leftLon);
     final double sinRightLon = Math.sin(rightLon);
     final double cosRightLon = Math.cos(rightLon);

     // Now build the four points
     this.LRHC = new GeoPoint(planetModel, sinBottomLat, sinRightLon, cosBottomLat, cosRightLon, bottomLat, rightLon);
     this.LLHC = new GeoPoint(planetModel, sinBottomLat, sinLeftLon, cosBottomLat, cosLeftLon, bottomLat, leftLon);

     final double middleLat = (Math.PI * 0.5 + bottomLat) * 0.5;
     final double sinMiddleLat = Math.sin(middleLat);
     this.cosMiddleLat = Math.cos(middleLat);
     // Normalize
     while (leftLon > rightLon) {
       rightLon += Math.PI * 2.0;
     }
     final double middleLon = (leftLon + rightLon) * 0.5;
     final double sinMiddleLon = Math.sin(middleLon);
     final double cosMiddleLon = Math.cos(middleLon);

     this.centerPoint = new GeoPoint(planetModel, sinMiddleLat, sinMiddleLon, cosMiddleLat, cosMiddleLon);

     this.bottomPlane = new SidedPlane(centerPoint, planetModel, sinBottomLat);
     this.leftPlane = new SidedPlane(centerPoint, cosLeftLon, sinLeftLon);
     this.rightPlane = new SidedPlane(centerPoint, cosRightLon, sinRightLon);

     this.bottomPlanePoints = new GeoPoint[]{LLHC, LRHC};
     this.leftPlanePoints = new GeoPoint[]{planetModel.NORTH_POLE, LLHC};
     this.rightPlanePoints = new GeoPoint[]{planetModel.NORTH_POLE, LRHC};

     this.eitherBound = new EitherBound();
     this.edgePoints = new GeoPoint[]{planetModel.NORTH_POLE};
   }

   /**
    * Constructor for deserialization.
    * @param planetModel is the planet model.
    * @param inputStream is the input stream.
    */
   public GeoWideNorthRectangle(final PlanetModel planetModel, final InputStream inputStream) throws IOException {
     this(planetModel, SerializableObject.readDouble(inputStream), SerializableObject.readDouble(inputStream), SerializableObject.readDouble(inputStream));
   }

   @Override
   public void write(final OutputStream outputStream) throws IOException {
     SerializableObject.writeDouble(outputStream, bottomLat);
     SerializableObject.writeDouble(outputStream, leftLon);
     SerializableObject.writeDouble(outputStream, rightLon);
   }

   @Override
   public GeoBBox expand(final double angle) {
     final double newTopLat = Math.PI * 0.5;
     final double newBottomLat = bottomLat - angle;
     // Figuring out when we escalate to a special case requires some prefiguring
     double currentLonSpan = rightLon - leftLon;
     if (currentLonSpan < 0.0)
       currentLonSpan += Math.PI * 2.0;
     double newLeftLon = leftLon - angle;
     double newRightLon = rightLon + angle;
     if (currentLonSpan + 2.0 * angle >= Math.PI * 2.0) {
       newLeftLon = -Math.PI;
       newRightLon = Math.PI;
     }
     return GeoBBoxFactory.makeGeoBBox(planetModel, newTopLat, newBottomLat, newLeftLon, newRightLon);
   }

   @Override
   public boolean isWithin(final double x, final double y, final double z) {
     return
         bottomPlane.isWithin(x, y, z) &&
             (leftPlane.isWithin(x, y, z) ||
                 rightPlane.isWithin(x, y, z));
   }

   @Override
   public double getRadius() {
     // Here we compute the distance from the middle point to one of the corners.  However, we need to be careful
     // to use the longest of three distances: the distance to a corner on the top; the distnace to a corner on the bottom, and
     // the distance to the right or left edge from the center.
     final double centerAngle = (rightLon - (rightLon + leftLon) * 0.5) * cosMiddleLat;
     final double bottomAngle = centerPoint.arcDistance(LLHC);
     return Math.max(centerAngle, bottomAngle);
   }

   @Override
   public GeoPoint getCenter() {
     return centerPoint;
   }

   @Override
   public GeoPoint[] getEdgePoints() {
     return edgePoints;
   }

   @Override
   public boolean intersects(final Plane p, final GeoPoint[] notablePoints, final Membership... bounds) {
     // Right and left bounds are essentially independent hemispheres; crossing into the wrong part of one
     // requires crossing into the right part of the other.  So intersection can ignore the left/right bounds.
     return
         p.intersects(planetModel, bottomPlane, notablePoints, bottomPlanePoints, bounds, eitherBound) ||
             p.intersects(planetModel, leftPlane, notablePoints, leftPlanePoints, bounds, bottomPlane) ||
             p.intersects(planetModel, rightPlane, notablePoints, rightPlanePoints, bounds, bottomPlane);
   }

   @Override
   public boolean intersects(final GeoShape geoShape) {
     // Right and left bounds are essentially independent hemispheres; crossing into the wrong part of one
     // requires crossing into the right part of the other.  So intersection can ignore the left/right bounds.
     return
         geoShape.intersects(bottomPlane, bottomPlanePoints, eitherBound) ||
             geoShape.intersects(leftPlane, leftPlanePoints, bottomPlane) ||
             geoShape.intersects(rightPlane, rightPlanePoints, bottomPlane);
   }

   @Override
   public void getBounds(Bounds bounds) {
     super.getBounds(bounds);
     bounds.isWide()
       .addHorizontalPlane(planetModel, bottomLat, bottomPlane, eitherBound)
       .addVerticalPlane(planetModel, leftLon, leftPlane, bottomPlane)
       .addVerticalPlane(planetModel, rightLon, rightPlane, bottomPlane)
       .addIntersection(planetModel, leftPlane, rightPlane, bottomPlane)
       .addPoint(LLHC).addPoint(LRHC).addPoint(planetModel.NORTH_POLE);
   }

   @Override
   protected double outsideDistance(final DistanceStyle distanceStyle, final double x, final double y, final double z) {
     final double bottomDistance = distanceStyle.computeDistance(planetModel, bottomPlane, x,y,z, eitherBound);
     // Because the rectangle exceeds 180 degrees, it is safe to compute the horizontally
     // unbounded distance to both the left and the right and only take the minimum of the two.
     final double leftDistance = distanceStyle.computeDistance(planetModel, leftPlane, x,y,z, bottomPlane);
     final double rightDistance = distanceStyle.computeDistance(planetModel, rightPlane, x,y,z, bottomPlane);

     final double LRHCDistance = distanceStyle.computeDistance(LRHC, x,y,z);
     final double LLHCDistance = distanceStyle.computeDistance(LLHC, x,y,z);

     return Math.min(
       Math.min(
         bottomDistance,
         Math.min(leftDistance, rightDistance)),
       Math.min(LRHCDistance, LLHCDistance));
   }

   @Override
   public boolean equals(Object o) {
     if (!(o instanceof GeoWideNorthRectangle))
       return false;
     GeoWideNorthRectangle other = (GeoWideNorthRectangle) o;
     return super.equals(other) && other.LLHC.equals(LLHC) && other.LRHC.equals(LRHC);
   }

   @Override
   public int hashCode() {
     int result = super.hashCode();
     result = 31 * result + LLHC.hashCode();
     result = 31 * result + LRHC.hashCode();
     return result;
   }

   @Override
   public String toString() {
     return "GeoWideNorthRectangle: {planetmodel="+planetModel+", bottomlat=" + bottomLat + "(" + bottomLat * 180.0 / Math.PI + "), leftlon=" + leftLon + "(" + leftLon * 180.0 / Math.PI + "), rightlon=" + rightLon + "(" + rightLon * 180.0 / Math.PI + ")}";
   }

   /** Membership implementation representing a wide (more than 180 degree) bound.
    */
   protected class EitherBound implements Membership {
     /** Constructor.
      */
     public EitherBound() {
     }

     @Override
     public boolean isWithin(final Vector v) {
       return leftPlane.isWithin(v) || rightPlane.isWithin(v);
     }

     @Override
     public boolean isWithin(final double x, final double y, final double z) {
       return leftPlane.isWithin(x, y, z) || rightPlane.isWithin(x, y, z);
     }
   }
 }
	/*
	* Licensed to the Apache Software Foundation (ASF) under one or more
	* contributor license agreements. See the NOTICE file distributed with
	* this work for additional information regarding copyright ownership.
	* The ASF licenses this file to You 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 org.apache.lucene.spatial3d.geom;

	import java.io.InputStream;
	import java.io.OutputStream;
	import java.io.IOException;

	/**
	* Bounding box wider than PI but limited on three sides (
	* bottom lat, left lon, right lon).
	*
	* @lucene.internal
	*/
	class GeoWideNorthRectangle extends GeoBaseBBox {
	/** Bottom latitude */
	protected final double bottomLat;
	/** Left longitude */
	protected final double leftLon;
	/** Right longitude */
	protected final double rightLon;

	/** The cosine of the middle latitude */
	protected final double cosMiddleLat;

	/** The lower right hand corner point */
	protected final GeoPoint LRHC;
	/** The lower left hand corner point */
	protected final GeoPoint LLHC;

	/** The bottom plane */
	protected final SidedPlane bottomPlane;
	/** The left plane */
	protected final SidedPlane leftPlane;
	/** The right plane */
	protected final SidedPlane rightPlane;

	/** Notable points for the bottom plane */
	protected final GeoPoint[] bottomPlanePoints;
	/** Notable points for the left plane */
	protected final GeoPoint[] leftPlanePoints;
	/** Notable points for the right plane */
	protected final GeoPoint[] rightPlanePoints;

	/** Center point */
	protected final GeoPoint centerPoint;

	/** Composite left/right bounds */
	protected final EitherBound eitherBound;

	/** A point on the edge */
	protected final GeoPoint[] edgePoints;

	/**
	* Accepts only values in the following ranges: lat: {@code -PI/2 -> PI/2}, lon: {@code -PI -> PI}.
	* Horizontal angle must be greater than or equal to PI.
	* @param planetModel is the planet model.
	* @param bottomLat is the bottom latitude.
	* @param leftLon is the left longitude.
	* @param rightLon is the right longitude.
	*/
	public GeoWideNorthRectangle(final PlanetModel planetModel, final double bottomLat, final double leftLon, double rightLon) {
	super(planetModel);
	// Argument checking
	if (bottomLat > Math.PI * 0.5 \|\| bottomLat < -Math.PI * 0.5)
	throw new IllegalArgumentException("Bottom latitude out of range");
	if (leftLon < -Math.PI \|\| leftLon > Math.PI)
	throw new IllegalArgumentException("Left longitude out of range");
	if (rightLon < -Math.PI \|\| rightLon > Math.PI)
	throw new IllegalArgumentException("Right longitude out of range");
	double extent = rightLon - leftLon;
	if (extent < 0.0) {
	extent += 2.0 * Math.PI;
	}
	if (extent < Math.PI)
	throw new IllegalArgumentException("Width of rectangle too small");

	this.bottomLat = bottomLat;
	this.leftLon = leftLon;
	this.rightLon = rightLon;

	final double sinBottomLat = Math.sin(bottomLat);
	final double cosBottomLat = Math.cos(bottomLat);
	final double sinLeftLon = Math.sin(leftLon);
	final double cosLeftLon = Math.cos(leftLon);
	final double sinRightLon = Math.sin(rightLon);
	final double cosRightLon = Math.cos(rightLon);

	// Now build the four points
	this.LRHC = new GeoPoint(planetModel, sinBottomLat, sinRightLon, cosBottomLat, cosRightLon, bottomLat, rightLon);
	this.LLHC = new GeoPoint(planetModel, sinBottomLat, sinLeftLon, cosBottomLat, cosLeftLon, bottomLat, leftLon);

	final double middleLat = (Math.PI * 0.5 + bottomLat) * 0.5;
	final double sinMiddleLat = Math.sin(middleLat);
	this.cosMiddleLat = Math.cos(middleLat);
	// Normalize
	while (leftLon > rightLon) {
	rightLon += Math.PI * 2.0;
	}
	final double middleLon = (leftLon + rightLon) * 0.5;
	final double sinMiddleLon = Math.sin(middleLon);
	final double cosMiddleLon = Math.cos(middleLon);

	this.centerPoint = new GeoPoint(planetModel, sinMiddleLat, sinMiddleLon, cosMiddleLat, cosMiddleLon);

	this.bottomPlane = new SidedPlane(centerPoint, planetModel, sinBottomLat);
	this.leftPlane = new SidedPlane(centerPoint, cosLeftLon, sinLeftLon);
	this.rightPlane = new SidedPlane(centerPoint, cosRightLon, sinRightLon);

	this.bottomPlanePoints = new GeoPoint[]{LLHC, LRHC};
	this.leftPlanePoints = new GeoPoint[]{planetModel.NORTH_POLE, LLHC};
	this.rightPlanePoints = new GeoPoint[]{planetModel.NORTH_POLE, LRHC};

	this.eitherBound = new EitherBound();
	this.edgePoints = new GeoPoint[]{planetModel.NORTH_POLE};
	}

	/**
	* Constructor for deserialization.
	* @param planetModel is the planet model.
	* @param inputStream is the input stream.
	*/
	public GeoWideNorthRectangle(final PlanetModel planetModel, final InputStream inputStream) throws IOException {
	this(planetModel, SerializableObject.readDouble(inputStream), SerializableObject.readDouble(inputStream), SerializableObject.readDouble(inputStream));
	}

	@Override
	public void write(final OutputStream outputStream) throws IOException {
	SerializableObject.writeDouble(outputStream, bottomLat);
	SerializableObject.writeDouble(outputStream, leftLon);
	SerializableObject.writeDouble(outputStream, rightLon);
	}

	@Override
	public GeoBBox expand(final double angle) {
	final double newTopLat = Math.PI * 0.5;
	final double newBottomLat = bottomLat - angle;
	// Figuring out when we escalate to a special case requires some prefiguring
	double currentLonSpan = rightLon - leftLon;
	if (currentLonSpan < 0.0)
	currentLonSpan += Math.PI * 2.0;
	double newLeftLon = leftLon - angle;
	double newRightLon = rightLon + angle;
	if (currentLonSpan + 2.0 * angle >= Math.PI * 2.0) {
	newLeftLon = -Math.PI;
	newRightLon = Math.PI;
	}
	return GeoBBoxFactory.makeGeoBBox(planetModel, newTopLat, newBottomLat, newLeftLon, newRightLon);
	}

	@Override
	public boolean isWithin(final double x, final double y, final double z) {
	return
	bottomPlane.isWithin(x, y, z) &&
	(leftPlane.isWithin(x, y, z) \|\|
	rightPlane.isWithin(x, y, z));
	}

	@Override
	public double getRadius() {
	// Here we compute the distance from the middle point to one of the corners. However, we need to be careful
	// to use the longest of three distances: the distance to a corner on the top; the distnace to a corner on the bottom, and
	// the distance to the right or left edge from the center.
	final double centerAngle = (rightLon - (rightLon + leftLon) * 0.5) * cosMiddleLat;
	final double bottomAngle = centerPoint.arcDistance(LLHC);
	return Math.max(centerAngle, bottomAngle);
	}

	@Override
	public GeoPoint getCenter() {
	return centerPoint;
	}

	@Override
	public GeoPoint[] getEdgePoints() {
	return edgePoints;
	}

	@Override
	public boolean intersects(final Plane p, final GeoPoint[] notablePoints, final Membership... bounds) {
	// Right and left bounds are essentially independent hemispheres; crossing into the wrong part of one
	// requires crossing into the right part of the other. So intersection can ignore the left/right bounds.
	return
	p.intersects(planetModel, bottomPlane, notablePoints, bottomPlanePoints, bounds, eitherBound) \|\|
	p.intersects(planetModel, leftPlane, notablePoints, leftPlanePoints, bounds, bottomPlane) \|\|
	p.intersects(planetModel, rightPlane, notablePoints, rightPlanePoints, bounds, bottomPlane);
	}

	@Override
	public boolean intersects(final GeoShape geoShape) {
	// Right and left bounds are essentially independent hemispheres; crossing into the wrong part of one
	// requires crossing into the right part of the other. So intersection can ignore the left/right bounds.
	return
	geoShape.intersects(bottomPlane, bottomPlanePoints, eitherBound) \|\|
	geoShape.intersects(leftPlane, leftPlanePoints, bottomPlane) \|\|
	geoShape.intersects(rightPlane, rightPlanePoints, bottomPlane);
	}

	@Override
	public void getBounds(Bounds bounds) {
	super.getBounds(bounds);
	bounds.isWide()
	.addHorizontalPlane(planetModel, bottomLat, bottomPlane, eitherBound)
	.addVerticalPlane(planetModel, leftLon, leftPlane, bottomPlane)
	.addVerticalPlane(planetModel, rightLon, rightPlane, bottomPlane)
	.addIntersection(planetModel, leftPlane, rightPlane, bottomPlane)
	.addPoint(LLHC).addPoint(LRHC).addPoint(planetModel.NORTH_POLE);
	}

	@Override
	protected double outsideDistance(final DistanceStyle distanceStyle, final double x, final double y, final double z) {
	final double bottomDistance = distanceStyle.computeDistance(planetModel, bottomPlane, x,y,z, eitherBound);
	// Because the rectangle exceeds 180 degrees, it is safe to compute the horizontally
	// unbounded distance to both the left and the right and only take the minimum of the two.
	final double leftDistance = distanceStyle.computeDistance(planetModel, leftPlane, x,y,z, bottomPlane);
	final double rightDistance = distanceStyle.computeDistance(planetModel, rightPlane, x,y,z, bottomPlane);

	final double LRHCDistance = distanceStyle.computeDistance(LRHC, x,y,z);
	final double LLHCDistance = distanceStyle.computeDistance(LLHC, x,y,z);

	return Math.min(
	Math.min(
	bottomDistance,
	Math.min(leftDistance, rightDistance)),
	Math.min(LRHCDistance, LLHCDistance));
	}

	@Override
	public boolean equals(Object o) {
	if (!(o instanceof GeoWideNorthRectangle))
	return false;
	GeoWideNorthRectangle other = (GeoWideNorthRectangle) o;
	return super.equals(other) && other.LLHC.equals(LLHC) && other.LRHC.equals(LRHC);
	}

	@Override
	public int hashCode() {
	int result = super.hashCode();
	result = 31 * result + LLHC.hashCode();
	result = 31 * result + LRHC.hashCode();
	return result;
	}

	@Override
	public String toString() {
	return "GeoWideNorthRectangle: {planetmodel="+planetModel+", bottomlat=" + bottomLat + "(" + bottomLat * 180.0 / Math.PI + "), leftlon=" + leftLon + "(" + leftLon * 180.0 / Math.PI + "), rightlon=" + rightLon + "(" + rightLon * 180.0 / Math.PI + ")}";
	}

	/** Membership implementation representing a wide (more than 180 degree) bound.
	*/
	protected class EitherBound implements Membership {
	/** Constructor.
	*/
	public EitherBound() {
	}

	@Override
	public boolean isWithin(final Vector v) {
	return leftPlane.isWithin(v) \|\| rightPlane.isWithin(v);
	}

	@Override
	public boolean isWithin(final double x, final double y, final double z) {
	return leftPlane.isWithin(x, y, z) \|\| rightPlane.isWithin(x, y, z);
	}
	}
	}