View Javadoc
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.analysis.integration.gauss;
18  
19  import org.hipparchus.exception.MathIllegalArgumentException;
20  import org.hipparchus.util.Pair;
21  
22  /** Interface for rules that determines the integration nodes and their weights.
23   * @since 2.0
24   */
25  @FunctionalInterface
26  public interface RuleFactory {
27  
28      /**
29       * Gets a copy of the quadrature rule with the given number of integration
30       * points.
31       * The number of points is arbitrarily limited to 1000. It prevents resources
32       * exhaustion. In practice the number of points is often much lower.
33       *
34       * @param numberOfPoints Number of integration points.
35       * @return a copy of the integration rule.
36       * @throws MathIllegalArgumentException if {@code numberOfPoints < 1}.
37       * @throws MathIllegalArgumentException if {@code numberOfPoints > 1000}.
38       * @throws MathIllegalArgumentException if the elements of the rule pair do not
39       * have the same length.
40       */
41      Pair<double[], double[]> getRule(int numberOfPoints) throws MathIllegalArgumentException;
42  
43  }