GaussIntegratorFactory (Apache Commons Math 3.6.1 API)

org.apache.commons.math3.analysis.integration.gauss

## Class GaussIntegratorFactory

- java.lang.Object
- - org.apache.commons.math3.analysis.integration.gauss.GaussIntegratorFactory

-     public class GaussIntegratorFactory
      extends Object

  Class that provides different ways to compute the nodes and weights to be used by the `Gaussian integration rule`.
  Since:
    3.1

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `GaussIntegratorFactory()`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `SymmetricGaussIntegrator` | `hermite(int numberOfPoints)` Creates a Gauss-Hermite integrator of the given order.
    `GaussIntegrator` | `legendre(int numberOfPoints)` Creates a Gauss-Legendre integrator of the given order.
    `GaussIntegrator` | `legendre(int numberOfPoints, double lowerBound, double upperBound)` Creates a Gauss-Legendre integrator of the given order.
    `GaussIntegrator` | `legendreHighPrecision(int numberOfPoints)` Creates a Gauss-Legendre integrator of the given order.
    `GaussIntegrator` | `legendreHighPrecision(int numberOfPoints, double lowerBound, double upperBound)` Creates an integrator of the given order, and whose call to the `integrate` method will perform an integration on the given interval.

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### GaussIntegratorFactory

          public GaussIntegratorFactory()

  - ### Method Detail

    - #### legendre

          public GaussIntegrator legendre(int numberOfPoints)

      Creates a Gauss-Legendre integrator of the given order. The call to the `integrate` method will perform an integration on the natural interval `[-1 , 1]`.
      Parameters:
        `numberOfPoints` - Order of the integration rule.
      Returns:
        a Gauss-Legendre integrator.

    - #### legendre

          public GaussIntegrator legendre(int numberOfPoints,
                                 double lowerBound,
                                 double upperBound)
                                   throws NotStrictlyPositiveException

      Creates a Gauss-Legendre integrator of the given order. The call to the `integrate` method will perform an integration on the given interval.
      Parameters:
        `numberOfPoints` - Order of the integration rule.
        `lowerBound` - Lower bound of the integration interval.
        `upperBound` - Upper bound of the integration interval.
      Returns:
        a Gauss-Legendre integrator.
      Throws:
        `NotStrictlyPositiveException` - if number of points is not positive

    - #### legendreHighPrecision

          public GaussIntegrator legendreHighPrecision(int numberOfPoints)
                                                throws NotStrictlyPositiveException

      Creates a Gauss-Legendre integrator of the given order. The call to the `integrate` method will perform an integration on the natural interval `[-1 , 1]`.
      Parameters:
        `numberOfPoints` - Order of the integration rule.
      Returns:
        a Gauss-Legendre integrator.
      Throws:
        `NotStrictlyPositiveException` - if number of points is not positive

    - #### legendreHighPrecision

          public GaussIntegrator legendreHighPrecision(int numberOfPoints,
                                              double lowerBound,
                                              double upperBound)
                                                throws NotStrictlyPositiveException

      Creates an integrator of the given order, and whose call to the `integrate` method will perform an integration on the given interval.
      Parameters:
        `numberOfPoints` - Order of the integration rule.
        `lowerBound` - Lower bound of the integration interval.
        `upperBound` - Upper bound of the integration interval.
      Returns:
        a Gauss-Legendre integrator.
      Throws:
        `NotStrictlyPositiveException` - if number of points is not positive

    - #### hermite

          public SymmetricGaussIntegrator hermite(int numberOfPoints)

      Creates a Gauss-Hermite integrator of the given order. The call to the `integrate` method will perform a weighted integration on the interval \([-\infty, +\infty]\): the computed value is the improper integral of \(e^{-x^2}f(x)\) where \(f(x)\) is the function passed to the `integrate` method.
      Parameters:
        `numberOfPoints` - Order of the integration rule.
      Returns:
        a Gauss-Hermite integrator.

Copyright © 2003–2016 The Apache Software Foundation. All rights reserved.