/*
 * 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 Region.getTree(includeBoundaryAttributes) when the boolean includeBoundaryAttributes parameter is set to true. 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.
Type parameters:
<S> – Type of the space.
See Also:
Region.getTree
Since:
3.0/** Class holding boundary attributes.
 * <p>This class is used for the attributes associated with the
 * nodes of region boundary shell trees returned by the {@link
 * Region#getTree(boolean) Region.getTree(includeBoundaryAttributes)}
 * when the boolean {@code includeBoundaryAttributes} parameter is
 * set to {@code true}. It contains the parts of the node cut
 * sub-hyperplane that belong to the boundary.</p>
 * <p>This class is a simple placeholder, it does not provide any
 * processing methods.</p>
 * @param <S> Type of the space.
 * @see Region#getTree
 * @since 3.0
 */
public class BoundaryAttribute<S extends Space> {

    
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).
/** 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<S> 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).
/** 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<S> plusInside;

    
Sub-hyperplanes that were used to split the boundary part. /** Sub-hyperplanes that were used to split the boundary part. */
    private final NodesSet<S> splitters;

    
Simple constructor.
Params:
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)
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)
Deprecated:
as of 3.4, the constructor has been replaced by a new one which is not public anymore, as it is intended to be used only by BoundaryBuilder/** 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)
     * @deprecated as of 3.4, the constructor has been replaced by a new one
     * which is not public anymore, as it is intended to be used only by
     * {@link BoundaryBuilder}
     */
    @Deprecated
    public BoundaryAttribute(final SubHyperplane<S> plusOutside,
                             final SubHyperplane<S> plusInside) {
        this(plusOutside, plusInside, null);
    }

    
Simple constructor.
Params:
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)
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)
splitters – sub-hyperplanes that were used to
split the boundary part (may be null)
Since:
3.4/** 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)
     * @param splitters sub-hyperplanes that were used to
     * split the boundary part (may be null)
     * @since 3.4
     */
    BoundaryAttribute(final SubHyperplane<S> plusOutside,
                      final SubHyperplane<S> plusInside,
                      final NodesSet<S> splitters) {
        this.plusOutside = plusOutside;
        this.plusInside  = plusInside;
        this.splitters   = splitters;
    }

    
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.
Returns:
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/** 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<S> 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.
Returns:
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/** 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<S> getPlusInside() {
        return plusInside;
    }

    
Get the sub-hyperplanes that were used to split the boundary part.
Returns:
sub-hyperplanes that were used to split the boundary part/** Get the sub-hyperplanes that were used to split the boundary part.
     * @return sub-hyperplanes that were used to split the boundary part
     */
    public NodesSet<S> getSplitters() {
        return splitters;
    }

}