home | career | drupal | java | mac | mysql | perl | scala | uml | unix  

Java example source code file (LimitAngle.java)

This example Java source code file (LimitAngle.java) is included in the alvinalexander.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.

Learn more about this Java project at its project page.

Java - Java tags/keywords

arcsset, hyperplane, limitangle, s1point, sublimitangle

The LimitAngle.java Java example source code

 * 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,
 * See the License for the specific language governing permissions and
 * limitations under the License.
package org.apache.commons.math3.geometry.spherical.oned;

import org.apache.commons.math3.geometry.Point;
import org.apache.commons.math3.geometry.partitioning.Hyperplane;

/** This class represents a 1D oriented hyperplane on the circle.
 * <p>An hyperplane on the 1-sphere is an angle with an orientation.

* <p>Instances of this class are guaranteed to be immutable.

* @since 3.3 */ public class LimitAngle implements Hyperplane<Sphere1D> { /** Angle location. */ private S1Point location; /** Orientation. */ private boolean direct; /** Tolerance below which angles are considered identical. */ private final double tolerance; /** Simple constructor. * @param location location of the hyperplane * @param direct if true, the plus side of the hyperplane is towards * angles greater than {@code location} * @param tolerance tolerance below which angles are considered identical */ public LimitAngle(final S1Point location, final boolean direct, final double tolerance) { this.location = location; this.direct = direct; this.tolerance = tolerance; } /** Copy the instance. * <p>Since instances are immutable, this method directly returns * the instance.</p> * @return the instance itself */ public LimitAngle copySelf() { return this; } /** {@inheritDoc} */ public double getOffset(final Point<Sphere1D> point) { final double delta = ((S1Point) point).getAlpha() - location.getAlpha(); return direct ? delta : -delta; } /** Check if the hyperplane orientation is direct. * @return true if the plus side of the hyperplane is towards * angles greater than hyperplane location */ public boolean isDirect() { return direct; } /** Get the reverse of the instance. * <p>Get a limit angle with reversed orientation with respect to the * instance. A new object is built, the instance is untouched.</p> * @return a new limit angle, with orientation opposite to the instance orientation */ public LimitAngle getReverse() { return new LimitAngle(location, !direct, tolerance); } /** Build a region covering the whole hyperplane. * <p>Since this class represent zero dimension spaces which does * not have lower dimension sub-spaces, this method returns a dummy * implementation of a {@link * org.apache.commons.math3.geometry.partitioning.SubHyperplane SubHyperplane}. * This implementation is only used to allow the {@link * org.apache.commons.math3.geometry.partitioning.SubHyperplane * SubHyperplane} class implementation to work properly, it should * <em>not be used otherwise.

* @return a dummy sub hyperplane */ public SubLimitAngle wholeHyperplane() { return new SubLimitAngle(this, null); } /** Build a region covering the whole space. * @return a region containing the instance (really an {@link * ArcsSet IntervalsSet} instance) */ public ArcsSet wholeSpace() { return new ArcsSet(tolerance); } /** {@inheritDoc} */ public boolean sameOrientationAs(final Hyperplane<Sphere1D> other) { return !(direct ^ ((LimitAngle) other).direct); } /** Get the hyperplane location on the circle. * @return the hyperplane location */ public S1Point getLocation() { return location; } /** {@inheritDoc} */ public Point<Sphere1D> project(Point point) { return location; } /** {@inheritDoc} */ public double getTolerance() { return tolerance; } }

Other Java examples (source code examples)

Here is a short list of links related to this Java LimitAngle.java source code file:

my book on functional programming


new blog posts


Copyright 1998-2021 Alvin Alexander, alvinalexander.com
All Rights Reserved.

A percentage of advertising revenue from
pages under the /java/jwarehouse URI on this website is
paid back to open source projects.