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;
020
021/** Interface representing objects that can be split by {@link Hyperplane}s.
022 * @param <P> Point implementation type
023 * @param <S> Split type
024 */
025public interface Splittable<P extends Point<P>, S extends Splittable<P, S>> {
026
027    /** Split this instance with the given hyperplane.
028     * @param splitter the hyperplane to split this object with.
029     * @return result of the split operation
030     */
031    Split<? extends S> split(Hyperplane<P> splitter);
032}