1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
|
/*
* 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.
* <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).
*/
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).
*/
private final SubHyperplane<S> plusInside;
/** Sub-hyperplanes that were used to split the boundary part. */
private final NodesSet<S> splitters;
/** 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.
* @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.
* @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.
* @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.
* @return sub-hyperplanes that were used to split the boundary part
*/
public NodesSet<S> getSplitters() {
return splitters;
}
}
|
