View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.commons.geometry.core.partitioning;
18  
19  import java.util.stream.Stream;
20  
21  import org.apache.commons.geometry.core.Point;
22  
23  /** Interface representing an object that can produce region boundaries as a stream
24   * of hyperplane convex subsets.
25   * @param <C> Hyperplane convex subset implementation type
26   */
27  @FunctionalInterface
28  public interface BoundarySource<C extends HyperplaneConvexSubset<? extends Point<?>>> {
29  
30      /** Return a stream containing the boundaries for this instance.
31       * @return a stream containing the boundaries for this instance
32       */
33      Stream<C> boundaryStream();
34  }