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 java.util.stream.Stream;
020
021import org.apache.commons.geometry.core.Point;
022
023/** Interface representing an object that can produce region boundaries as a stream
024 * of hyperplane convex subsets.
025 * @param <C> Hyperplane convex subset implementation type
026 */
027@FunctionalInterface
028public interface BoundarySource<C extends HyperplaneConvexSubset<? extends Point<?>>> {
029
030    /** Return a stream containing the boundaries for this instance.
031     * @return a stream containing the boundaries for this instance
032     */
033    Stream<C> boundaryStream();
034}