001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.geometry.core.partitioning;
018
019import org.apache.commons.geometry.core.Point;
020import org.apache.commons.geometry.core.Transform;
021
022/** Extension of the {@link HyperplaneSubset} interface with the additional restriction
023 * that instances represent convex regions of space.
024 * @param <P> Point implementation type
025 */
026public interface HyperplaneConvexSubset<P extends Point<P>> extends HyperplaneSubset<P> {
027
028    /** Reverse the orientation of the hyperplane for this instance, returning the result as
029     * a new instance. The returned subset contains the same points but has a reversed orientation.
030     * @return a hyperplane convex subset representing the same region but with the
031     *      opposite orientation.
032     */
033    HyperplaneConvexSubset<P> reverse();
034
035    /** {@inheritDoc}
036     *
037     * <p>The parts resulting from a split operation with a convex subset
038     * are guaranteed to also be convex.</p>
039     */
040    @Override
041    Split<? extends HyperplaneConvexSubset<P>> split(Hyperplane<P> splitter);
042
043    /** {@inheritDoc}
044     *
045     * <p>Hyperplane convex subsets subjected to affine transformations remain
046     * convex.</p>
047     */
048    @Override
049    HyperplaneConvexSubset<P> transform(Transform<P> transform);
050}