001/* ----------------------------------------------------------------------------
002 * This file was automatically generated by SWIG (https://www.swig.org).
003 * Version 4.1.1
004 *
005 * Do not make changes to this file unless you know what you are doing - modify
006 * the SWIG interface file instead.
007 * ----------------------------------------------------------------------------- */
008
009package org.quantlib;
010
011public class EndCriteria implements org.quantlib.helpers.QuantLibJNIHelpers.AutoCloseable {
012  private transient long swigCPtr;
013  private transient boolean swigCMemOwn;
014
015  protected EndCriteria(long cPtr, boolean cMemoryOwn) {
016    swigCMemOwn = cMemoryOwn;
017    swigCPtr = cPtr;
018  }
019
020  protected static long getCPtr(EndCriteria obj) {
021    return (obj == null) ? 0 : obj.swigCPtr;
022  }
023
024  protected void swigSetCMemOwn(boolean own) {
025    swigCMemOwn = own;
026  }
027
028  @SuppressWarnings("deprecation")
029  protected void finalize() {
030    delete();
031  }
032
033  public synchronized void delete() {
034    if (swigCPtr != 0) {
035      if (swigCMemOwn) {
036        swigCMemOwn = false;
037        QuantLibJNI.delete_EndCriteria(swigCPtr);
038      }
039      swigCPtr = 0;
040    }
041  }
042
043  public EndCriteria(long maxIteration, long maxStationaryStateIterations, double rootEpsilon, double functionEpsilon, double gradientNormEpsilon) {
044    this(QuantLibJNI.new_EndCriteria(maxIteration, maxStationaryStateIterations, rootEpsilon, functionEpsilon, gradientNormEpsilon), true);
045  }
046
047  public boolean getValue(long iteration, SWIGTYPE_p_std__size_t statState, boolean positiveOptimization, double fold, double normgold, double fnew, double normgnewx, SWIGTYPE_p_EndCriteria__Type ecType) {
048    return QuantLibJNI.EndCriteria_getValue(swigCPtr, this, iteration, SWIGTYPE_p_std__size_t.getCPtr(statState), positiveOptimization, fold, normgold, fnew, normgnewx, SWIGTYPE_p_EndCriteria__Type.getCPtr(ecType));
049  }
050
051  public final static class Type {
052    public final static EndCriteria.Type None = new EndCriteria.Type("None");
053    public final static EndCriteria.Type MaxIterations = new EndCriteria.Type("MaxIterations");
054    public final static EndCriteria.Type StationaryPoint = new EndCriteria.Type("StationaryPoint");
055    public final static EndCriteria.Type StationaryFunctionValue = new EndCriteria.Type("StationaryFunctionValue");
056    public final static EndCriteria.Type StationaryFunctionAccuracy = new EndCriteria.Type("StationaryFunctionAccuracy");
057    public final static EndCriteria.Type ZeroGradientNorm = new EndCriteria.Type("ZeroGradientNorm");
058    public final static EndCriteria.Type Unknown = new EndCriteria.Type("Unknown");
059
060    public final int swigValue() {
061      return swigValue;
062    }
063
064    public String toString() {
065      return swigName;
066    }
067
068    public static Type swigToEnum(int swigValue) {
069      if (swigValue < swigValues.length && swigValue >= 0 && swigValues[swigValue].swigValue == swigValue)
070        return swigValues[swigValue];
071      for (int i = 0; i < swigValues.length; i++)
072        if (swigValues[i].swigValue == swigValue)
073          return swigValues[i];
074      throw new IllegalArgumentException("No enum " + Type.class + " with value " + swigValue);
075    }
076
077    private Type(String swigName) {
078      this.swigName = swigName;
079      this.swigValue = swigNext++;
080    }
081
082    private Type(String swigName, int swigValue) {
083      this.swigName = swigName;
084      this.swigValue = swigValue;
085      swigNext = swigValue+1;
086    }
087
088    private Type(String swigName, Type swigEnum) {
089      this.swigName = swigName;
090      this.swigValue = swigEnum.swigValue;
091      swigNext = this.swigValue+1;
092    }
093
094    private static Type[] swigValues = { None, MaxIterations, StationaryPoint, StationaryFunctionValue, StationaryFunctionAccuracy, ZeroGradientNorm, Unknown };
095    private static int swigNext = 0;
096    private final int swigValue;
097    private final String swigName;
098  }
099
100}