Quadrature.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.numerical.EvaluationException;

/**
 * Abstract base class for elementary quadrature algorithms used for function integration.
 */
public abstract class Quadrature {
   /**
    * Current level of refinement.
    */
   protected int n;

   /**
    * Gets current level of refinement.
    *
    * @return current level of refinement.
    */
   public int getN() {
      return n;
   }

   /**
    * Returns the value of the integral at the nth stage of refinement.
    *
    * @return the value of the integral at the nth stage of refinement.
    * @throws EvaluationException Raised if something failed during the evaluation.
    */
   public abstract double next() throws EvaluationException;

   /**
    * Gets type of quadrature.
    *
    * @return type of quadrature.
    */
   public abstract QuadratureType getType();
}