All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.apache.commons.math3.geometry.partitioning.BoundaryAttribute Maven / Gradle / Ivy

Go to download

The Apache Commons Math project is a library of lightweight, self-contained mathematics and statistics components addressing the most common practical problems not immediately available in the Java programming language or commons-lang.

There is a newer version: 3.6.1
Show newest version
/*
 * 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.partitioning;

import org.apache.commons.math3.geometry.Space;

/** Class holding boundary attributes.
 * 

This class is used for the attributes associated with the * nodes of region boundary shell trees returned by the {@link * Region#getTree Region.getTree}. It contains the * parts of the node cut sub-hyperplane that belong to the * boundary.

*

This class is a simple placeholder, it does not provide any * processing methods.

* @param Type of the space. * @see Region#getTree * @version $Id: BoundaryAttribute.java 1244107 2012-02-14 16:17:55Z erans $ * @since 3.0 */ public class BoundaryAttribute { /** Part of the node cut sub-hyperplane that belongs to the * boundary and has the outside of the region on the plus side of * its underlying hyperplane (may be null). */ private final SubHyperplane plusOutside; /** Part of the node cut sub-hyperplane that belongs to the * boundary and has the inside of the region on the plus side of * its underlying hyperplane (may be null). */ private final SubHyperplane plusInside; /** Simple constructor. * @param plusOutside part of the node cut sub-hyperplane that * belongs to the boundary and has the outside of the region on * the plus side of its underlying hyperplane (may be null) * @param plusInside part of the node cut sub-hyperplane that * belongs to the boundary and has the inside of the region on the * plus side of its underlying hyperplane (may be null) */ public BoundaryAttribute(final SubHyperplane plusOutside, final SubHyperplane plusInside) { this.plusOutside = plusOutside; this.plusInside = plusInside; } /** Get the part of the node cut sub-hyperplane that belongs to the * boundary and has the outside of the region on the plus side of * its underlying hyperplane. * @return part of the node cut sub-hyperplane that belongs to the * boundary and has the outside of the region on the plus side of * its underlying hyperplane */ public SubHyperplane getPlusOutside() { return plusOutside; } /** Get the part of the node cut sub-hyperplane that belongs to the * boundary and has the inside of the region on the plus side of * its underlying hyperplane. * @return part of the node cut sub-hyperplane that belongs to the * boundary and has the inside of the region on the plus side of * its underlying hyperplane */ public SubHyperplane getPlusInside() { return plusInside; } }