Tolerance.java

  1. /*
  2.  * Licensed to the Apache Software Foundation (ASF) 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 ASF 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.  *      http://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.apache.commons.math4.legacy.optim;

  18. /**
  19.  * Default tolerances values.
  20.  *
  21.  * @since 4.0
  22.  */
  23. public class Tolerance implements OptimizationData {
  24.     /** Relative tolerance. */
  25.     private final double relativeTolerance;
  26.     /** Absolute tolerance. */
  27.     private final double absoluteTolerance;

  28.     /**
  29.      * @param relative Relative tolerance.
  30.      * @param absolute Abolute tolerance.
  31.      */
  32.     public Tolerance(double relative,
  33.                      double absolute) {
  34.         relativeTolerance = relative;
  35.         absoluteTolerance = absolute;
  36.     }

  37.     /**
  38.      * @return the retlative tolerance.
  39.      */
  40.     public double getRelativeTolerance() {
  41.         return relativeTolerance;
  42.     }

  43.     /**
  44.      * @return the absolute tolerance.
  45.      */
  46.     public double getAbsoluteTolerance() {
  47.         return absoluteTolerance;
  48.     }
  49. }