DoubleExponentialRuleQuadratureMatrixIntegrator.java

/*
 * Copyright (C) 2023 Alberto Irurueta Carro (alberto@irurueta.com)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.irurueta.numerical.integration;

import com.irurueta.algebra.WrongSizeException;

/**
 * Computes matrix function integration by using double exponential quadrature.
 * Double exponential quadrature allows improper integrands containing singularities to be
 * integrated.
 *
 * @see DoubleExponentialRuleMatrixQuadrature
 */
public class DoubleExponentialRuleQuadratureMatrixIntegrator
        extends QuadratureMatrixIntegrator<DoubleExponentialRuleMatrixQuadrature> {

    /**
     * Constructor.
     *
     * @param a        Lower limit of integration.
     * @param b        Upper limit of integration.
     * @param hmax     Maximum step size. This quadrature transforms the range of integration to
     *                 [-hmax, hmax].
     * @param listener listener to evaluate a single dimension matrix (multivariate) function at
     *                 required points.
     * @param eps      required accuracy.
     * @throws WrongSizeException if size notified by provided listener is invalid.
     */
    public DoubleExponentialRuleQuadratureMatrixIntegrator(
            final double a, final double b, final double hmax,
            final MatrixSingleDimensionFunctionEvaluatorListener listener, final double eps) throws WrongSizeException {
        super(new DoubleExponentialRuleMatrixQuadrature(listener, a, b, hmax), eps);
    }

    /**
     * Constructor.
     *
     * @param a        Lower limit of integration.
     * @param b        Upper limit of integration.
     * @param listener listener to evaluate a single dimension matrix (multivariate) function at
     *                 required points.
     * @param eps      required accuracy.
     * @throws WrongSizeException if size notified by provided listener is invalid.
     */
    public DoubleExponentialRuleQuadratureMatrixIntegrator(
            final double a, final double b, final MatrixSingleDimensionFunctionEvaluatorListener listener,
            final double eps) throws WrongSizeException {
        super(new DoubleExponentialRuleMatrixQuadrature(listener, a, b), eps);
    }

    /**
     * Constructor with default accuracy.
     *
     * @param a        Lower limit of integration.
     * @param b        Upper limit of integration.
     * @param hmax     Maximum step size. This quadrature transforms the range of integration to
     *                 [-hmax, hmax].
     * @param listener listener to evaluate a single dimension matrix (multivariate) function at
     *                 required points.
     * @throws WrongSizeException if size notified by provided listener is invalid.
     */
    public DoubleExponentialRuleQuadratureMatrixIntegrator(
            final double a, final double b, final double hmax,
            final MatrixSingleDimensionFunctionEvaluatorListener listener) throws WrongSizeException {
        this(a, b, hmax, listener, EPS);
    }

    /**
     * Constructor with default accuracy and default maximum step size.
     *
     * @param a        Lower limit of integration.
     * @param b        Upper limit of integration.
     * @param listener listener to evaluate a single dimension matrix (multivariate) function at
     *                 required points.
     * @throws WrongSizeException if size notified by provided listener is invalid.
     */
    public DoubleExponentialRuleQuadratureMatrixIntegrator(
            final double a, final double b, final MatrixSingleDimensionFunctionEvaluatorListener listener)
            throws WrongSizeException {
        this(a, b, listener, EPS);
    }

    /**
     * Constructor.
     *
     * @param a        Lower limit of integration.
     * @param b        Upper limit of integration.
     * @param hmax     Maximum step size. This quadrature transforms the range of integration to
     *                 [-hmax, hmax].
     * @param listener listener to evaluate a single dimension function at required points for
     *                 double exponential quadrature to take into account any non-mild
     *                 singularities.
     * @param eps      required accuracy.
     * @throws WrongSizeException if size notified by provided listener is invalid.
     */
    public DoubleExponentialRuleQuadratureMatrixIntegrator(
            final double a, final double b, final double hmax,
            final DoubleExponentialMatrixSingleDimensionFunctionEvaluatorListener listener, final double eps)
            throws WrongSizeException {
        super(new DoubleExponentialRuleMatrixQuadrature(listener, a, b, hmax), eps);
    }

    /**
     * Constructor with default maximum step size.
     *
     * @param a        Lower limit of integration.
     * @param b        Upper limit of integration.
     * @param listener listener to evaluate a single dimension function at required points for
     *                 double exponential quadrature to take into account any non-mild
     *                 singularities.
     * @param eps      required accuracy.
     * @throws WrongSizeException if size notified by provided listener is invalid.
     */
    public DoubleExponentialRuleQuadratureMatrixIntegrator(
            final double a, final double b,
            final DoubleExponentialMatrixSingleDimensionFunctionEvaluatorListener listener, final double eps)
            throws WrongSizeException {
        super(new DoubleExponentialRuleMatrixQuadrature(listener, a, b), eps);
    }

    /**
     * Constructor with default accuracy.
     *
     * @param a        Lower limit of integration.
     * @param b        Upper limit of integration.
     * @param hmax     Maximum step size. This quadrature transforms the range of integration to
     *                 [-hmax, hmax].
     * @param listener listener to evaluate a single dimension function at required points for
     *                 double exponential quadrature to take into account any non-mild
     *                 singularities.
     * @throws WrongSizeException if size notified by provided listener is invalid.
     */
    public DoubleExponentialRuleQuadratureMatrixIntegrator(
            final double a, final double b, final double hmax,
            final DoubleExponentialMatrixSingleDimensionFunctionEvaluatorListener listener) throws WrongSizeException {
        this(a, b, hmax, listener, EPS);
    }

    /**
     * Constructor with default accuracy and default maximum step size.
     *
     * @param a        Lower limit of integration.
     * @param b        Upper limit of integration.
     * @param listener listener to evaluate a single dimension function at required points for
     *                 double exponential quadrature to take into account any non-mild
     *                 singularities.
     * @throws WrongSizeException if size notified by provided listener is invalid.
     */
    public DoubleExponentialRuleQuadratureMatrixIntegrator(
            final double a, final double b,
            final DoubleExponentialMatrixSingleDimensionFunctionEvaluatorListener listener) throws WrongSizeException {
        this(a, b, listener, EPS);
    }

    /**
     * Gets type of quadrature.
     *
     * @return type of quadrature.
     */
    @Override
    public QuadratureType getQuadratureType() {
        return QuadratureType.DOUBLE_EXPONENTIAL_RULE;
    }
}