1 /*
2 * Licensed to the Hipparchus project 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 Hipparchus project 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 * https://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.hipparchus.optim.nonlinear.vector.constrained;
18
19 import org.hipparchus.linear.RealVector;
20 import org.hipparchus.optim.OptimizationData;
21
22 /** Generic constraint.
23 * @since 3.1
24 */
25 public interface Constraint extends VectorDifferentiableFunction, OptimizationData {
26
27 /** Get Lower Bound for {@link #value(RealVector) value(x)}.
28 * @return Lower Bound for {@link #value(RealVector) value(x)}
29 */
30 RealVector getLowerBound();
31
32 /** Get Upper Bound for {@link #value(RealVector) value(x)}.
33 * @return Upper Bound for {@link #value(RealVector) value(x)}
34 */
35 RealVector getUpperBound();
36
37 /** Check how much a point overshoots the constraint.
38 * <p>
39 * The overshoots is zero if the point fulfills the constraint, and
40 * positive if the {@link #value(RealVector) value} of the constraint
41 * is on the wrong side of {@link #getLowerBound() lower} or {@link
42 * #getUpperBound() upper} boundaries.
43 * </p>
44 * @param y constraint value (y = {@link #value(RealVector) value}(x))
45 * @return L¹-norm of constraint overshoot
46 */
47 double overshoot(RealVector y);
48
49 }