PlaneConstraint¶
A constraint projection forcing the given solution to lie on a plane in N-dimensional space (hyper-plane) or in a half-space bounded by the plane (on one side of the plane).
The plane is defined by a normal vector of same dimensionality sa N, and can be shifted along the normal away from the origin. Like all constraint nodes, this is normally used as part of an optimization problem formulation given to a (typically convex) solver node. Version 1.0.0
Ports/Properties¶
data¶
Data to process.
- verbose name: Data
- default value: None
- port type: DataPort
- value type: object (can be None)
- data direction: INOUT
normal¶
Normal vector of the plane.
- verbose name: Normal
- default value: None
- port type: DataPort
- value type: AnyNumeric (can be None)
- data direction: IN
offset¶
Offset or shift of the plane along the normal from the origin.
- verbose name: Offset
- default value: 0.0
- port type: FloatPort
- value type: float (can be None)
constraint¶
Whether the constraint is a half-space (upper bound) or a hyper-plane (equality). In the upper-bound case, values are constrained to lie on the negative side (opposite of the normal vector) of or on the plane.
- verbose name: Constraint
- default value: equality
- port type: EnumPort
- value type: str (can be None)
set_breakpoint¶
Set a breakpoint on this node. If this is enabled, your debugger (if one is attached) will trigger a breakpoint.
- verbose name: Set Breakpoint (Debug Only)
- default value: False
- port type: BoolPort
- value type: bool (can be None)
metadata¶
User-definable meta-data associated with the node. Usually reserved for technical purposes.
- verbose name: Metadata
- default value: {}
- port type: DictPort
- value type: dict (can be None)