PointConstraint

Specify local equality or bound constraints at one or more points.


Declaration

classdef PointConstraint

Overview

Use PointConstraint to declare values or derivative conditions at specific points in one or more dimensions. A single constraint object can represent many points at once, which makes it suitable for both simple one-dimensional constraints and large masked regions in tensor fits.

Basic usage

c1 = PointConstraint.equal((0:10)', D=2, value=0);
c2 = PointConstraint.lowerBound([X(mask), Y(mask)], D=[0 0], value=0);
c3 = PointConstraint.equalOnMask({x,y}, islandMask, D=[0 0], value=0);

Topics

  • Specify point constraints
    • PointConstraint Create a pointwise equality or bound constraint.
    • equal Create a pointwise equality constraint.
    • equalOnMask Create a pointwise equality constraint from a logical mask.
    • lowerBound Create a pointwise lower-bound constraint.
    • lowerBoundOnMask Create a pointwise lower-bound constraint from a logical mask.
    • upperBound Create a pointwise upper-bound constraint.
    • upperBoundOnMask Create a pointwise upper-bound constraint from a logical mask.
  • Inspect point constraint properties
    • D Derivative orders as an N-by-D matrix.
    • numConstraints Number of constrained points.
    • numDimensions Number of constrained dimensions.
    • points Constraint locations as an N-by-D point matrix.
    • relation Constraint relation: “==”, “>=”, or “<=”.
    • value Target values as an N-by-1 vector.