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.util;
18
19 import org.hipparchus.exception.MathIllegalArgumentException;
20
21 /**
22 * Interface representing classes that can blend with other instances of themselves using a given blending value.
23 * <p> The blending value is commonly given from a
24 * {@link org.hipparchus.analysis.polynomials.SmoothStepFactory.SmoothStepFunction smoothstep function}.
25 *
26 * @param <B> blendable class
27 */
28 public interface Blendable<B> {
29
30 /**
31 * Blend arithmetically this instance with another one.
32 *
33 * @param other other instance to blend arithmetically with
34 * @param blendingValue value from smoothstep function B(x). It is expected to be between [0:1] and will
35 * throw an exception otherwise.
36 * @return this * (1 - B(x)) + other * B(x)
37 * @throws MathIllegalArgumentException if blending value is not within [0:1]
38 */
39 B blendArithmeticallyWith(B other, double blendingValue) throws MathIllegalArgumentException;
40 }