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