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

Java example source code file (OrientedPoint.java)

This example Java source code file (OrientedPoint.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

default_tolerance, deprecated, hyperplane, intervalsset, orientedpoint, point, suborientedpoint, vector1d

The OrientedPoint.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,
 * 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.commons.math3.geometry.euclidean.oned;

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

/** This class represents a 1D oriented hyperplane.
 * <p>An hyperplane in 1D is a simple point, its orientation being a
 * boolean.</p>
 * <p>Instances of this class are guaranteed to be immutable.

* @since 3.0 */ public class OrientedPoint implements Hyperplane<Euclidean1D> { /** Default value for tolerance. */ private static final double DEFAULT_TOLERANCE = 1.0e-10; /** Vector location. */ private Vector1D location; /** Orientation. */ private boolean direct; /** Tolerance below which points are considered to belong to the hyperplane. */ private final double tolerance; /** Simple constructor. * @param location location of the hyperplane * @param direct if true, the plus side of the hyperplane is towards * abscissas greater than {@code location} * @param tolerance tolerance below which points are considered to belong to the hyperplane * @since 3.3 */ public OrientedPoint(final Vector1D location, final boolean direct, final double tolerance) { this.location = location; this.direct = direct; this.tolerance = tolerance; } /** Simple constructor. * @param location location of the hyperplane * @param direct if true, the plus side of the hyperplane is towards * abscissas greater than {@code location} * @deprecated as of 3.3, replaced with {@link #OrientedPoint(Vector1D, boolean, double)} */ @Deprecated public OrientedPoint(final Vector1D location, final boolean direct) { this(location, direct, DEFAULT_TOLERANCE); } /** Copy the instance. * <p>Since instances are immutable, this method directly returns * the instance.</p> * @return the instance itself */ public OrientedPoint copySelf() { return this; } /** Get the offset (oriented distance) of a vector. * @param vector vector to check * @return offset of the vector */ public double getOffset(Vector<Euclidean1D> vector) { return getOffset((Point<Euclidean1D>) vector); } /** {@inheritDoc} */ public double getOffset(final Point<Euclidean1D> point) { final double delta = ((Vector1D) point).getX() - location.getX(); return direct ? delta : -delta; } /** 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 SubOrientedPoint wholeHyperplane() { return new SubOrientedPoint(this, null); } /** Build a region covering the whole space. * @return a region containing the instance (really an {@link * IntervalsSet IntervalsSet} instance) */ public IntervalsSet wholeSpace() { return new IntervalsSet(tolerance); } /** {@inheritDoc} */ public boolean sameOrientationAs(final Hyperplane<Euclidean1D> other) { return !(direct ^ ((OrientedPoint) other).direct); } /** {@inheritDoc} * @since 3.3 */ public Point<Euclidean1D> project(Point point) { return location; } /** {@inheritDoc} * @since 3.3 */ public double getTolerance() { return tolerance; } /** Get the hyperplane location on the real line. * @return the hyperplane location */ public Vector1D getLocation() { return location; } /** Check if the hyperplane orientation is direct. * @return true if the plus side of the hyperplane is towards * abscissae greater than hyperplane location */ public boolean isDirect() { return direct; } /** Revert the instance. */ public void revertSelf() { direct = !direct; } }

Other Java examples (source code examples)

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



my book on functional programming

 

new blog posts

 

Copyright 1998-2019 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.